@bigcommerce/typedoc-plugin-markdown

A plugin for Typedoc that exposes a theme and additional arguments for rendering markdown.

Stats

stars 🌟issues ⚠️updated 🛠created 🐣size 🏋️‍♀️
28311Jul 28, 2021May 25, 2017Minified + gzip package size for @bigcommerce/typedoc-plugin-markdown in KB

Readme

@bigcommerce/typedoc-plugin-markdown

A plugin for TypeDoc that exposes a theme and additional arguments for rendering markdown. This is a forked version of typedoc-plugin-markdown that is modified to suit the needs of BigCommerce.

Installation

npm install --save-dev typedoc @bigcommerce/typedoc-plugin-markdown

Usage

Specify the theme

The plugin provides an additional markdown theme:

shell:

$ node_modules/.bin/typedoc --theme markdown

npm script:

"scripts": {
 "docs": "typedoc --theme markdown"
}

Additional arguments

The plugin exposes the following additional arguments:

  • --mdEngine <github|bitbucket|gitbook>
    The markdown rendering engine:
    "github": Optimised for GitHub/CommonMark (Default).
    "bitbucket": Renders markdown to support Bitbucket anchor linking and more.
    "gitbook": Adds SUMMARY.md file to generate a book's table of contents and sets header levels to display correct sub-navigation menu. (Optimised for newest version of GitBook).

  • --mdHideSources
    Suppress source file linking from output.

  • --mdSourceRepo <path.to.repo>(Will be ignored on GitHub repositories)
    The source repo to use for source file linking.
    For bitbucket use: https://bitbucket.org/owner/repository_name.

Example output

Acknowledgements

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.