docusaurus-plugin-api-extractor-markdown-documenter v0.3.4

docusaurus-plugin-api-extractor-markdown-documenter

This project houses an api-documenter plugin that is responsible for taking markdown produces by api-extractor and make it compatible with docusaurus.

Usage

This is to be used in conjunction with docusaurus-plugin-api-extractor. By running docusaurus api-extractor:init it will produce a api-documenter.json file that will configure this plugin. It should look like the following:

{
  "outputTarget": "markdown",
  "plugins": [
    {
      "packageName": "docusaurus-plugin-api-extractor-markdown-documenter",
      "enabledFeatureNames": ["docusaurus-plugin-api-extractor-markdown-documenter"]
    }
  ]
}

This plugin will now be ran when running docusaurus api-extractor:run