Skip to content

Latest commit

 

History

History
90 lines (55 loc) · 2.23 KB

DOCUMENTATION.md

File metadata and controls

90 lines (55 loc) · 2.23 KB
Raw

Documentation

You can see below the API reference of this module.

Blah(cwd)

Creates a new Blah instance.

Params

  • String cwd: The Blah working directory (default: process.cwd()).

search(file, callback)

Searches a file in the blah directories.

Params

  • String file: The relative path to a file to search in the templates directories (in the following order: local .blah directory, ~/.blah-templates, library templates).
  • Function callback: The callback function.

prepare(callback)

Prepares the Blah data.

Params

  • Function callback: The callback function.

init(callback)

Inits the .blah directory in the current project.

Params

  • Function callback: The callback function.

docs(input, output, writeToFile, callback)

Generates the DOCUMENTATION.md file, parsing the input files.

Params

  • String input: Input file name (default: main file from package.json)
  • String output: Output file name (default: DOCUMENTATION.md)
  • Boolean writeToFile: If false, the docs will be returned via the callback function, without writing the output file.
  • Function callback: The callback function.

readme(callback)

Creates the README.md file.

Params

  • Function callback: The callback function

gitignore(callback)

Creates the .gitignore file.

Params

  • Function callback: The callback function.

license(license, callback)

Creates the LICENSE file.

Params

  • String license: The license name.
  • Function callback: The callback function.

render(path, data, callback)

Renders a template from file.

Params

  • String path: The template path.
  • Object data: Additional data to merge into the template data.
  • Function callback: The callback function.

contributing(callback)

Generates the CONTRIBUTING.md file.

Params

  • Function callback: The callback function.

version(what, callback)

Bumps the provided version.

Params

  • String what: The version which should be bumped. It takes one of the following values: "major", "minor", "patch". The default is "patch".
  • Function callback: The callback function.