Invert markdown annotated source code to code describing markdown documentation
JavaScript CSS
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.
bin
doc
lib
.gitignore
LICENSE
README.md
npm-debug.log
package.json
style.css

README.md

Incodoc

Invert markdown annotated source code to code describing markdown documentation

Huub de Beer

2013-07-20

  • Install
  • Usage
  • Licence

Install

Install incodoc by:

npm install -g incodoc

Usage

Incodoc parses javascript source code into a sequence of subsequent blocks. A block is either markdown documentation or javascript code. A markdown documentation block is recognized by:

  • it starts with a line containing only /**, excluding whitespace,
  • it ends with a line containing only * immediately followed by /, excluding whitespace,
  • every line in between starts with a *, possibly preceded by some whitespace.

Everything outside a markdown documentation block is recognized as a code block.

The most simplest usage is:

incodoc file1 file2 ... fileN

That command inverts all files listed and places the generated documentation in the current working directory.

If you want, you can enable linenumbers in code blocks as well as choose another highlighting style via, for example:

incodoc -l -h monochrome file1

This will show linenumbers as well as choose the monochrome style. Possible styles are:

  • pygments
  • kate
  • monochrome
  • espresso
  • haddock
  • tango
  • zenburn

(as per http://johnmacfarlane.net/pandoc/demos.html)

If another output format is desired, you can select

  • 'plain', '
  • rst',
  • 'odt',
  • 'docbook',
  • 'latex',
  • 'github',
  • 'man'

as well through the -f option.

Finally, you can specify a special CSS stylesheet via the -s option. If no stylesheet is specified, the generated HTML file points to style.css.