Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

typedoc-bitbucket-theme

tgreyuk47MITdeprecated1.0.0TypeScript support: included

Please use typedoc-plugin markdown with the option 'anchorPrefix' set to 'markdown-header'

An extension of the default theme from typedoc-plugin-markdown to fix Bitbucket Cloud's internal anchor linking implementation.

typedoc-theme

readme

typedoc-bitbucket-theme

An Bitbucket Cloud compatible TypeDoc theme.

npm CI

Note: If using Bitbucket Server do not use this theme but set the --namedAnchors option instead.

What is does?

  • Fixes Bitbucket Cloud's internal anchor linking implementation.

Installation

npm install typedoc typedoc-plugin-markdown typedoc-bitbucket-theme --save-dev

Usage

$ npx typedoc --theme --bitbucket [args]

Options

Please refer to typedoc-plugin-markdown.

License

MIT