docs-ts-mkdocs
Advanced tools
An MkDocs generator from docs-ts documentation.
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.
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).
FAQs
A wrapper for docs-ts to support MkDocs
The npm package docs-ts-mkdocs receives a total of 7 weekly downloads. As such, docs-ts-mkdocs popularity was classified as not popular.
We found that docs-ts-mkdocs demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
A malicious npm package disguised as a WhatsApp client is exploiting authentication flows with a remote kill switch to exfiltrate data and destroy files.
Security News
PyPI now supports digital attestations, enhancing security and trust by allowing package maintainers to verify the authenticity of Python packages.
Security News
GitHub removed 27 malicious pull requests attempting to inject harmful code across multiple open source repositories, in another round of low-effort attacks.