Skip to content

v1.0.0

Choose a tag to compare

@itz-mune itz-mune released this 11 Jun 11:08
· 2 commits to main since this release

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: initial release.