Documentation static generator for programmers
touch README.md
echo "First documentation page" > README.md
touch _sidebar.md
echo "- Getting started
- [Quick start](./README.md)" > _sidebar.md
npx docium ./ ./dist/
cd ./dist
ls ./
assets
css
js
media
images
index.html
It generates static site with documentation mardown files + JSDoc API.
docium-github-links[ ] - insert link to github repository.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[ ] - Generate sitemap.xml.MIT
FAQs
Documentation static generator for programmers
The npm package docium receives a total of 0 weekly downloads. As such, docium popularity was classified as not popular.
We found that docium 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.