docify Defined in lib/build.js

This module is the main entry point for docify when used programmatically. It exposes a function which will build the docs for a project, and returns a Promise that resolves to the output directory.

Docify uses Broccoli.js as a build tool to compile the docs. This function runs Broccoli with the options you supply.

Create a Broccoli.js Builder and build the project's documentation. Returns a promise which resolves to the output directory that contains the built docs.

Example

import docify from 'docify';

docify({
  src: 'docs',
  dest: 'docs-dist'
}).then((outputDir) => {
  // outputDir = 'docs-dist'
});

Arguments

• options (Object):
• options.src (String):

  the docs folder to build, defaults to "./docs"

• options.dest (String):

  the destination folder to write the docs to

• options.theme (String):

  a directory containing a theme to use instead of the default "minimal" theme.

• options.pkg (String):

  the root folder for the package being documented (defaults to process.cwd())

Returns