Options
All
  • Public
  • Public/Protected
  • All
Menu

typedoc

Example

Example Documentation

Installation

Example install

$ npm install examples --save-dev

Example executable: examples.

Usage

Shell

Example usage.

$ examples --out path/to/documentation/ path/to/example/project/

Arguments

  • --example <project>
    Example explanation.

Example with Cyrillic

Пример API

Combined Latin and Cyrillic text

Только кириллица

Only Cyrillic text

Repeated Heading

This is used to check the generated id. First instance.

Repeated Heading

This is used to check the generated id. Second instance.

Generated using TypeDoc