CDoc is a simple NodeJS script that extracts comments from CoffeeScript and LiveScript files in the source directory tree, and creates an identical directory tree in the target directory that contains markdown comments found in source files.
Other than extracting markdown comments, CDoc doesn't do anything. It does not compile HTML, has no templates or CSS. In other words, CDoc is not a documetnation generator.
Install using npm:
npm install cdoc
All comments must use markdown in order to be extractable. The lines to be
extracted must start with a single #. Any inline comments that start with a
single # will be included, so you should use ## to start comments that you
do not want to be included (actually any non-space character after # will
do).
To include a table of contents in the output, add ::TOC:: string anywhere in
the source. The table of contents will be generated at that point. By default,
the table of contents will omit level 1 headings as well as level 5 and lower.
This is not configurable yet.
To extract documentation located in src directory, and store extracted files
in doc:
cdoc src doc
The doc directory will contain the same directory structure as src and all
.coffee and/or .ls files in the src directory will have a matching .mkd
file in the doc directory.
To ignore directories, pass the -i or --ignore option:
cdoc src doc -i test -i example
Report all bugs to GitHub issue tracker.
FAQs
Simple stupid CoffeeScript documentation extractor
We found that cdoc 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
Malicious npm package impersonates Nodemailer and drains wallets by hijacking crypto transactions across multiple blockchains.
Security News
This episode explores the hard problem of reachability analysis, from static analysis limits to handling dynamic languages and massive dependency trees.
Security News
/Research
Malicious Nx npm versions stole secrets and wallet info using AI CLI tools; Socket’s AI scanner detected the supply chain attack and flagged the malware.