tauri-apps/archived-typedoc-plugin-markdown

mirror of https://github.com/tauri-apps/typedoc-plugin-markdown.git synced 2026-01-31 00:45:20 +01:00

Files

History

tgreyuk e86bda396e chore: Switched to changesets and npm workspaces

2022-12-11 21:11:26 +00:00

..

BREAKING CHANGE: Initiate with defineTheme method (theme option should be keyword rather than path)

2022-01-09 12:26:25 +00:00

CHANGELOG.md

chore: Switched to changesets and npm workspaces

2022-12-11 21:11:26 +00:00

jest.config.js

Added typedoc bitbucket theme

2020-09-11 09:46:10 +01:00

LICENSE

Added typedoc bitbucket theme

2020-09-11 09:46:10 +01:00

package.json

Updated Jest

2022-06-28 23:10:52 +01:00

README.md

fix: grammar

2022-05-25 16:09:09 -04:00

tsconfig.json

Split tsconfigs / add strictNullchecks

2020-09-12 00:13:30 +01:00

tsconfig.test.json

Split tsconfigs / add strictNullchecks

2020-09-12 00:13:30 +01:00

README.md

typedoc-bitbucket-theme

An Bitbucket Cloud compatible TypeDoc theme.

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

What Does It Do?

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