Class: DocsParser

Defined in:

src\components\docs.coffee

Overview

Creates a link to the documentation on the corresponding GitHub Pages page.

Variables Summary

name =

"DocsParser"

Instance Method Summary

# (void) run(pkg) Check whether a documentation exists, it is in /docs and the repo uses github.

Constructor Details

# (void) constructor(options)

Creates a new DocsParser

Parameters:

(options) ( Object ) — An optional set of options

Options Hash: (options):

encoding ( String ) — Encoding for reading the file ['utf-8']
docFile ( String ) — Documentation entry point ['index.html']
branch ( String ) — The branch to use for the documentation ['master']

Instance Method Details

# (void) run(pkg)

Check whether a documentation exists, it is in /docs and the repo uses github. If all conditions are true, create a link to the documentation via GitHub Pages. @returns [Promise