Simple stupid CoffeeScript documentation extractor
Want to see pretty graphs? Log in now!
npm install cdoc
|12||downloads in the last month|
|Last Published By|
|Version||0.0.3 last updated 5 months ago|
|Keywords||documentation, coffeescript, comments, markdown|
CDoc - CoffeeScript/LiveScript documentation extractor
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
Comment formatting rules
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
# will be included, so you should use
## to start comments that you
do not want to be included (actually any non-space character after
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
cdoc src doc
doc directory will contain the same directory structure as
src and all
.ls files in the
src directory will have a matching
file in the
To ignore directories, pass the
cdoc src doc -i test -i example
Report all bugs to GitHub issue tracker.