locco-markdown

Locco Markdown adapter

Creates Markdown files side by side with the original files. Optionally uses one of them as the general README.

Locco plugin.

Usage

locco --adapter-readme=locco.js --source=src/**/*.js --adapter=markdown

Options:

• optional adapter-readme: file to be used as source for README.md

Methods

comment

Receives a comment string and a file path and emits a post event with the new path and

Arguments

• Object options
  • String comment
  • Object file
    • String path

Events

• post
  • String targetFile
  • String line

License

Copyright 2014 Xavier Via

ISC license.

See LICENSE attached