Docurator v1.0.0 🎉
First public release. Docurator turns a folder of Markdown into a beautiful documentation website — with one command.
✨ Highlights
- Markdown → website — drop in .md files, get a clean, styled site.
- Two build modes — classic multi-page site or a single-page app (--mode multi|spa).
- Live-reload dev server — docurator serve rebuilds and refreshes the browser on every save, zero runtime dependencies.
- 7 built-in themes — default, dark, catppuccin, dracula, material, neon, pastel, plus custom CSS support.
- Smart ordering & titles — derive page order and titles from frontmatter, filename prefixes, or _meta.json.
- Flexible navigation — left/right sidebar, button- or scroll-based page switching.
- Rich Markdown — tables, code blocks with copy buttons, HTML5 audio/video, anchored headings.
- Safe rebuilds — only Docurator-generated files are cleaned; your images and assets are preserved.
- Colourful CLI — auto-disables for non-TTY, NO_COLOR, or --no-color.
📦 Install
npm install -g docurator
🚀 Quick start
docurator init # scaffold config + sample docs/
docurator create # build the site
docurator serve # preview locally with live reload
📚 Documentation
See the README for the full command reference, configuration options, and authoring guide.
Full Changelog: here
What's Changed?
- Default input is now the current directory (.) instead of docs/. Open a terminal in your Markdown folder and go.
- init no longer scaffolds a docs/ folder or sample page — it just writes docurator.config.json for you to edit (and is now optional).
- create and serve auto-create docurator.config.json when it's missing, so either command works in a fresh folder with zero setup.
- serve now auto-opens your browser at the local URL. Added --no-open to skip.
Fixed
- Tree walkers now skip the output dir, dot-folders, and node_modules — no more spurious duplicate-slug errors when input is ..
- A page named index.md is now served as the real home page instead of being overwritten by a self-redirect.