@inovus-medical/docs

Turn a folder of markdown into a themed, Cloudflare-ready documentation site.

A small, self-contained static-site engine: it renders markdown into a themed dist/ that any static host serves. Designed for one deployment per docs repo, public or private, with push-to-deploy on Cloudflare Workers.

Install

npm install --save-dev @inovus-medical/docs

Use

Put markdown in docs/, add a docs.config.json, then:

npx inovus-docs build    # content -> dist/ (or --out dist-docs)
npx inovus-docs dev      # build + serve + watch (http://localhost:8788)
npx inovus-docs serve    # serve an existing dist/
npx inovus-docs init     # scaffold into the current repo (safe in app repos)

Flags: --root <dir> --in <docs> --out <dist> --port <n> --theme <name>. init also accepts --content <dir> and merges without overwriting app build scripts.

Themes

Named themes each include light and dark variants. Built-ins: totum (default), default.

Selection (first match wins): --theme > DOCS_THEME env var > "theme" in docs.config.json > totum. On Cloudflare, set DOCS_THEME under Worker → Settings → Build → Variables (build-time).

Local preview: npx inovus-docs dev (Totum) or --theme default.

What it does

• Renders markdown with markdown-it + @shikijs/markdown-it (dual light/dark syntax highlighting), Mermaid diagrams (```mermaid fences), heading anchors, tables, and frontmatter.
• Generates sidebar navigation from your folder structure.
• Builds a client-side search index, light/dark theme, on-page table of contents, and prev/next paging.
• Emits clean-URL static HTML plus a 404.html.

Config

See docs.config.json and frontmatter reference.

License

MIT