typescene-api-docgen

Typescene API Documentation Generator

This module is used by the other Typescene modules as a development dependency, to produce API documentation in JSON format and copy a reader application into the docs/ folder of a project.

Note: To learn more about Typescene, head over to the main Typescene repository.

You do NOT need to include this module in your own projects, unless you know what you are doing and your code is structured in exactly the same way as the Typescene source code.

---

How it works:

• Command line interface — this module exports the typescene-docgen command, which accepts a list of folders to inspect for declaration files and Markdown files. This command is used by other modules as part of the build process.
• Declaration files — all *.d.ts files are read using the TypeScript compiler, and their declarations are merged together, along with their JSDoc documentation.
• Markdown files — all *.ref.md files are parsed; sections with annotated IDs (or matching titles) are merged with declared classes, interfaces, members, etc. from the declaration files. Other sections are included as just text documents.
• JSON output — the CLI application produces a single JSON file with all declarations and text. This file also includes a Table of Contents structure which should link all items together.
• Reader application — a precompiled reader application (source included in the src/ folder in this repository) is copied along with the JSON file, which includes an index.html file for direct hosting on github.io.

Examples:

• Typescene Async Library documentation
• Other Typescene modules...