gillchristian / docs-ts-mkdocs

docs-ts-mkdocs

An MkDocs generator from docs-ts documentation.

Rationale & How It Works

docs-ts output is meant to be deployed with GitHub Pages (using Jekyll under the hood).

docs-ts-mkdocs must be run after docs-ts: it adds a nav: section to mkdocs.yml based on the generated docs/ directory.

All the directories and markdown files in docs/ are added to the main navigation. And the docs/modules is treversed adding index.md files on every directory with a table of contents of the directory files.

Install and use

npm i --dev docs-ts docs-ts-mkdocs

npm run docs-ts
npm run docs-ts-mkdocs

See docs-ts on how to configure.

NOTES: for now the outDir is expected to be docs/ (the default one).