Welcome to mdsvr

Transform any folder of Markdown/Markdown files into a beautiful documentation website — zero config required.


  
    
    
    
  
  npx mdsvr ./docs

  npx mdsvr ./docs

ℹ️ Info: This documentation itself is served by mdsvr! Explore the files in this directory to see how everything works.

What is mdsvr?

mdsvr is a static file server that automatically renders Markdown and MDX files as beautiful HTML. It’s similar to Vercel’s serve but understands .md and .mdx files.

Quick Start

Install

No installation needed! Just use npx:


  
    
    
    
  
  npx mdsvr ./docs

  npx mdsvr ./docs

Create your docs

Create a folder with some .md files:


  
    
    
    
  
  mkdir docs
echo "# Hello World" > docs/readme.md

  mkdir docs
echo "# Hello World" > docs/readme.md

Start the server


  
    
    
    
  
  npx mdsvr ./docs --open

  npx mdsvr ./docs --open

Key Features

Feature	Description
📝 Markdown & MDX	Render .md and .mdx files with built-in interactive components
🎨 Themes	Dark/light mode with customizable accent colors
🔍 Search	Built-in full-text search with keyboard shortcut (⌘K)
📑 Navigation	Auto-generated sidebar and table of contents
🔎 SEO	Sitemap, RSS feed, Open Graph, and Twitter Cards
⚙️ Settings	Configure everything via settings.json

This docs structure for reference


  
    
    
    
  
  docs/
├── _mdsvr/
│   └── settings.json            # Site configuration (optional)
├── README.md                    # Homepage (this file)
├── 01-getting-started/          # Getting started guides
│   └── README.md              # Quick start & installation
├── 02-settings/                 # Settings & configuration
│   └── README.md              # Configuration, writing & deployment
├── 03-features/                 # Feature documentation
│   ├── README.md             # Features overview
│   ├── markdown.md           # Markdown support
│   ├── mdx.mdx               # MDX components demo
│   ├── theming.md            # Theme customization
│   ├── search.md             # Search functionality
│   ├── navigation.md         # Navigation features
│   ├── seo.md                # SEO features
│   └── mermaid.md            # Mermaid diagrams
└── 04-reference/                # API/Reference
    └── README.md             # CLI reference

  docs/
├── _mdsvr/
│   └── settings.json            # Site configuration (optional)
├── README.md                    # Homepage (this file)
├── 01-getting-started/          # Getting started guides
│   └── README.md              # Quick start & installation
├── 02-settings/                 # Settings & configuration
│   └── README.md              # Configuration, writing & deployment
├── 03-features/                 # Feature documentation
│   ├── README.md             # Features overview
│   ├── markdown.md           # Markdown support
│   ├── mdx.mdx               # MDX components demo
│   ├── theming.md            # Theme customization
│   ├── search.md             # Search functionality
│   ├── navigation.md         # Navigation features
│   ├── seo.md                # SEO features
│   └── mermaid.md            # Mermaid diagrams
└── 04-reference/                # API/Reference
    └── README.md             # CLI reference

Next Steps

Quick Start — Get running in 30 seconds
Installation — Install options
MDX Components — Make your docs interactive
Configuration — Customize your site
Writing Content — Best practices
Deployment — Go live
Features — See all features
CLI Reference — Command reference

💡 Tip: Press ⌘+K (or Ctrl+K) to open the search modal and find anything in this documentation!