https://github.com/mattetti/custom-api-documenter

Customized version of https://api-extractor.com/pages/setup/generating_docs/ allowing for more custom HTML/markdown API generation
https://github.com/mattetti/custom-api-documenter

Last synced: 2 months ago
JSON representation

Customized version of https://api-extractor.com/pages/setup/generating_docs/ allowing for more custom HTML/markdown API generation

• Host: GitHub
• URL: https://github.com/mattetti/custom-api-documenter
• Owner: mattetti
• License: other
• Created: 2020-08-18T23:18:22.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2021-05-12T17:20:42.000Z (over 3 years ago)
• Last Synced: 2024-10-14T21:19:31.258Z (3 months ago)
• Language: TypeScript
• Size: 588 KB
• Stars: 1
• Watchers: 1
• Forks: 3
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# @mattetti/custom-api-documenter a fork of @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](https://api-extractor.com/),

and then generates files in [Markdown](https://en.wikipedia.org/wiki/Markdown) format with some HTML.

For usage information, see the

[Generating Docs](https://api-extractor.com/pages/setup/generating_docs/) article from the API Extractor

documentation.

## Customization

The markdown renderer was customized to better render API docs using

[hugo](https://gohugo.io/) and to allow for a different file structure.

Custom json options not available in the original api-documenter markdown:

- uriRoot: so the doc can generate links for api docs not hosted at the root of the domain.

- onlyPackagesStartingWith: a string used to filter packages to document, useful when you want to publish only document some packages.

```

{

  "outputTarget": "markdown",

  "newlineKind": "lf",

  "uriRoot": "/apis",

  "onlyPackagesStartingWith": "@mything"

}

```