This npm module helps generate a single html page from a set of markdown files, images and plantuml documents.
Features are best explored by looking into the documentation.
You have to install pandoc: http://pandoc.org/installing.html
Install Graphviz for UML diagrams via plantuml
For PDF generation install wkhtmltopdf.
to start the generation:
require('count-docu').generate({})
The options available are as follows:
| property | default | description |
|---|---|---|
| targetPath | {cwd}/dist | path to folder where the generated html is put |
| source | {cwd}/src | path to folder containing the markdown files |
| template | - | path to main handlebars template |
| targetHtml | {cwd}/dist/index.html | html file |
| title | Documentation | title of documentation |
| description | .. | description displayed below title |
| false | render html for conversion to pdf | |
| pdfDownload | false | add a download link to 'index.pdf' |
| description | .. | description displayed below title |
| maxCommits | - | number of git commits to be displayed in history |
| headerColor | #fff | color of title |
| headerBgColor | #563d7c | color of header |
| headerDescriptionColor | #cdbfe3 | color of description |
To render a pdf version use wkhtmltopdf (>0.12.4 with patched qt) which renders proper links and table of content
wkhtmltopdf --page-size A4 --viewport-size 1024x768 --disable-smart-shrinking --zoom 5.5 --outline dist/pdf.html dist/index.pdf
This software includes the awesome plantuml library (MIT license) from plantuml.com
Modified bits and pieces from node-plantuml) are included in this software.
FAQs
Generated documentation
The npm package count-docu receives a total of 0 weekly downloads. As such, count-docu popularity was classified as not popular.
We found that count-docu 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.
Product
Socket’s new Tier 1 Reachability filters out up to 80% of irrelevant CVEs, so security teams can focus on the vulnerabilities that matter.
Research
/Security News
Ongoing npm supply chain attack spreads to DuckDB: multiple packages compromised with the same wallet-drainer malware.
Security News
The MCP Steering Committee has launched the official MCP Registry in preview, a central hub for discovering and publishing MCP servers.