v2.2 · MIT License · Node 18+

The fastest way from
Markdown to beautiful docs

Zero config. One command. MDX, dark mode, full-text search, SEO — everything included.

terminal
$ |
npm install -g mdsvr
10s to running docs
0 config files needed
150ms startup time
56× faster than Docusaurus
Features

Everything included, nothing to configure

All the features of a professional docs platform, available in a single npx command.

⚡

Zero Config

Point to any Markdown folder. No setup files, no build step, no scaffolding. mdsvr figures everything out.

npx mdsvr ./docs # Done.
📝

Markdown & MDX

Render .md and .mdx with React components — callouts, steps, tabs, cards, accordions.

🌓

Dark / Light Mode

Auto-detects OS preference. Fully customizable accent color. Theme toggle included.

🔍

Full-Text Search

Client-side search with ⌘K shortcut. Pre-built index. No Algolia account needed.

🗂️

Auto Navigation

Sidebar and TOC auto-generated from your file structure. Active page highlighted. Collapsible sections.

🔎

SEO Ready

Open Graph, Twitter Cards, canonical URLs, sitemap.xml, RSS feed — all generated automatically.

📊

Mermaid Diagrams

Render flowcharts, sequence diagrams, ERDs from code blocks. Fullscreen, pan, zoom included.

📦

Static Export

Export to clean HTML for Firebase, Netlify, or GitHub Pages. Clean URLs, no .html extensions.

🐳

Docker Ready

Official Docker image on Docker Hub. Mount your docs folder and go.

docker pull ghcr.io/satoshiman/mdsvr:latest
🔒

Security Built-in

Path traversal protection, hidden file blocking, sensitive extension filtering. Read-only by design.

MDX Components

Interactive docs out of the box

Drop these components directly into your Markdown files — no imports, no setup.

Make sure you have Node.js 18+ installed.
<Callout type="warning">
1Install the package
2Create docs folder
3Run the server
<Steps>
npm
yarn
pnpm
npm install -g mdsvr
<Tabs>
⚡Quick Start
⚙️Config
<CardGroup>
stable TypeScript v2.2
<Badge>
How does zero config work? +
<Accordion>
Comparison

Why mdsvr wins on simplicity

Every alternative requires setup. mdsvr doesn't.

Feature mdsvr Docusaurus Nextra MkDocs Hugo
Setup ⚡ Zero config Config required Config required YAML config hugo.toml
Language TypeScript / Node Node + React Next.js Python Go
MDX Support ✓ Full ✓ Full ✓ Full ✗ No ✗ No
Dark Mode ✓ Built-in ✓ Built-in ✓ Built-in ✓ Built-in ✓ Built-in
Search ✓ Client-side Algolia API ✓ Client-side ✓ Built-in ✗ No
Mermaid ✓ Yes ✓ Yes ✓ Yes Plugin only ✓ Yes
Static Export ✓ Yes ✓ Yes ✓ Yes ✓ Yes ✓ Yes
Build Step ✗ Not needed Required Required Required Required
Docker ✓ Official image DIY DIY DIY DIY
Startup Time 150ms 8.5s build 6.2s build ~3s build ~1s build

vs Docusaurus

npx create-docusaurus@latest my-docs classic
Then config, then build, then...
npx mdsvr ./docs

vs MkDocs

Requires Python, pip, virtual env — before you write a single line of docs.
Node.js only. Already installed if you're a JS developer.
Quick Start

From zero to docs in 10 seconds

01

Run without installing

$ npx mdsvr ./docs
02

Or install globally

$ npm install -g mdsvr
$ mdsvr ./docs
03

Optional: add settings

$ npx mdsvr ./docs --init
# Creates _mdsvr/settings.json — customize title, theme, SEO...
04

Export for static hosting

$ npx mdsvr ./docs --export
# Outputs to _html/public — deploy anywhere
05

Or use Docker

$ docker run -p 1800:1800 \
    -v /path/to/docs:/app/docs \
    ghcr.io/satoshiman/mdsvr:latest
📞
Why port 1800? Like a 1-800 toll-free hotline, port 1800 is your local documentation hotline — memorable, conflict-free, and always there when you need answers.
Why mdsvr

Lightweight by design

Other tools are built to be full frameworks. mdsvr is built to get out of your way.

  • ✓
    Fastest startup — 150ms vs 8s build time
  • ✓
    Zero learning curve — if you know Markdown, you know mdsvr
  • ✓
    No build pipeline — serve files directly, export when ready
  • ✓
    Full-featured anyway — search, SEO, MDX, themes, diagrams
Read the Docs View on GitHub npm package
Startup Time Comparison
mdsvr
150ms
Hugo
~1s
MkDocs
~3s
Nextra
6.2s
Docusaurus
8.5s
mdsvr is 56× faster than Docusaurus

Ready to simplify your docs?

No signup. No credit card. No configuration.
Just Markdown and one command.

npx mdsvr ./docs
View on GitHub npm page