Usage

The plugin can be configured by setting options in the package.json file.

{
  "name": "my-documentation",
  "scripts": {
    "start": "docy"
  },
  "docy": {
    "title": "My Documentation"
  }
}

The following options are available:

Options

title default package.name

Set the title of the documentation.

result default index.html

Name of the resulting documentation file.

dist default ./dist

Folder where the generated documentation should be placed.

The default template can be overridden.