Documentation

1. Documentation App

Compodoc is used to generate the documentation. The documentation itself is written in Markdown, like this file.

On top of that, markedpp is used as a preprocessor for the markdown files.

This allows it to automatically generate table of contents, etc...

The processing runs automatically during commit.

1.1. Build Documentation

The compodoc based documentation can be built with the following command:

npm run docs:build

1.2. Develop Documentation

It is also possible to serve the documentation in watch mode, for a more comfortable documentation development process:

npm run docs:develop

2. Headlines and Table of Contents

To generate Headlines and Table of Contents use this command:

npm run docs:generate-toc

2.1. Include Current File

Add this to a file, to automatically generate headline numbers and a table of contents.

<div class="table-of-contents">

<!-- !numberedheadings (minlevel=2) -->

<!-- !toc (level=4 minlevel=2) -->

<!-- toc! -->

</div>

2.2. Including Other Files

This can be used to include files:

<!-- include (../../path/to/a/file.ts lang=typescript) -->

3. Documenting Generators CLI Options

Our version of compodoc supports a special JSDoc comment @cliUsage for interface properties. This comment will appear as a special table row CLI Usage in the generated documentation for this interface property:

Code example:

interface SomeInterface {
  /**
   * ...
   * @cliUsage --name="My generated Journey"
   * ...
   */
  name: string;
}