@danchenkov/api-documenter

    0.1.0 • Public • Published

    @microsoft/api-documenter

    This tool can be used to generate an online API reference manual for your TypeScript library. It reads the *.api.json data files produced by API Extractor, and then generates web pages using the Markdown file format.

    The api-documenter tool is part of Microsoft's production documentation pipeline. It is provided as a code sample to illustrate how to load and process the API JSON file format. If your requirements are simple, you can use this tool directly. For more advanced scenarios, developers are encouraged to fork the project and modify the source code. The implementation is intentionally kept simple and easy to understand. This is possible because most of processing is already performed upstream by API Extractor.

    For more information, see the Generating Docs article from the API Extractor documentation.

    Keywords

    none

    Install

    npm i @danchenkov/api-documenter

    DownloadsWeekly Downloads

    3

    Version

    0.1.0

    License

    MIT

    Unpacked Size

    408 kB

    Total Files

    70

    Last publish

    Collaborators

    • vdanchenkov