Generate documentation in README from source files.
$ npm install -g docume
(The usage documentation below is generated via DocuMe itself. See the source of bin/docume file.)
Put some placeholders in your README file first:
# My README
Some line here...
<!--docume:path/to/source.js-->
<!--/docume:path/to/source.js-->
Author Name
It is expected that your source file would have Markdown formatted documentation as single-line comments:
/* path/to/source.js */
// this is a line that will be copied to README
var str = 'Hello World';
Now run the command:
$ docume README.md
MIT © Fahad Ibnay Heylaal
FAQs
Generate documentation in README from source files
The npm package docume receives a total of 1 weekly downloads. As such, docume popularity was classified as not popular.
We found that docume 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.
Research
Security News
Socket researchers uncover a malicious npm package posing as a tool for detecting vulnerabilities in Etherium smart contracts.
Security News
Research
A supply chain attack on Rspack's npm packages injected cryptomining malware, potentially impacting thousands of developers.
Research
Security News
Socket researchers discovered a malware campaign on npm delivering the Skuld infostealer via typosquatted packages, exposing sensitive data.