docium
v1.0.5
Published
Documentation static generator for programmers
Downloads
21
Maintainers
Readme
Docium
Documentation static generator for programmers
Get started
touch README.md
echo "First documentation page" > README.md
touch _sidebar.md
echo "- Getting started
- [Quick start](./README.md)" > _sidebar.mdnpx docium ./ ./dist/
cd ./dist
ls ./assets
css
js
media
images
index.htmlIt generates static site with documentation mardown files + JSDoc API.
Plugins
docium-github-links[ ] - insert link togithubrepository.docium-allow-react-in-ex[ ] - allow use React in your examples.docium-disqus[ ] - Add disqus comments at the end of the pages.docium-google-analytics[ ] - Add Google Analytics counter in the page.docium-sitemap[ ] - Generatesitemap.xml.
License
MIT
