https://github.com/foxbunny/cdoc

Simple stupid CoffeeScript documentation extractor
https://github.com/foxbunny/cdoc

Last synced: 28 days ago
JSON representation

Simple stupid CoffeeScript documentation extractor

• Host: GitHub
• URL: https://github.com/foxbunny/cdoc
• Owner: foxbunny
• License: mit
• Created: 2013-10-10T10:53:53.000Z (about 11 years ago)
• Default Branch: master
• Last Pushed: 2013-11-16T12:13:28.000Z (about 11 years ago)
• Last Synced: 2023-03-10T22:13:37.743Z (almost 2 years ago)
• Language: LiveScript
• Size: 141 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.mkd
  • Changelog: CHANGES.mkd
  • License: LICENSE

Awesome Lists containing this project

README

        
# 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.

## Installation

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

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.

## Basic usage

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.

## Ignoring directories

To ignore directories, pass the `-i` or `--ignore` option:

    cdoc src doc -i test -i example

## Reporting bugs

Report all bugs to [GitHub issue

tracker](https://github.com/foxbunny/cdoc/issues).