Introduction
A zero-install Markdown preview server.
sladocs is a server that previews a directory of Markdown with a single command. It gives you Fumadocs' polished UI — sidebar, table of contents, full-text search, and dark mode — with no installation and no configuration.
project
├── docs
│ ├── index.md
│ ├── spec.md
│ └── design.md
├── README.mdnpx sladocsWhen to use sladocs
If you keep your documentation as Markdown in the same repository as your code, sladocs is a simple way to read it. It mirrors your directory structure in the navigation and searches across every page, so multi-page documents — design notes, runbooks, specifications — stay easy to navigate however many pages they grow to.
Add a meta.json to order and group your pages the way a reader would expect, rather than by file name.
What you get
- GFM rendering — callouts, code blocks, inline HTML, and more.
- Mermaid diagrams, KaTeX math, and Shiki syntax highlighting.
- Images, HTML prototypes, PDFs, and other static assets served as-is.
meta.jsonnavigation, resolved links between pages, and full-text search.- Hot reload on save.
- A multi-project layout for several directories at once.
- Static builds of the docs site.
How it differs from fumadocs-preview
Fumadocs also has an official CLI, fumadocs-preview, for quickly displaying a Markdown directory. When the two overlap, keep these differences in mind:
- Zero-install even when configured. fumadocs-preview assumes a local install as a dev dependency in order to customize it, but sladocs stays
npx-only even after you add configuration. - Links stay plain Markdown. Ordinary relative-path links between pages resolve as written — no rewriting and no special build-time syntax required.
- Static assets served as-is. Not only images, but relative links to HTML prototypes, PDFs, and the like are served directly.