		@@ -1,2 +0,2 @@
		import { MarkdownTheme } from 'typedoc-plugin-markdown/dist/theme';
		import { MarkdownTheme } from 'typedoc-plugin-markdown';
		import { Renderer } from 'typedoc';
		@@ -3,0 +3,0 @@ export declare class BitbucketTheme extends MarkdownTheme {

dist/theme.js

		"use strict";
		Object.defineProperty(exports, "__esModule", { value: true });
		exports.BitbucketTheme = void 0;
		const theme_1 = require("typedoc-plugin-markdown/dist/theme");
		class BitbucketTheme extends theme_1.MarkdownTheme {
		const typedoc_plugin_markdown_1 = require("typedoc-plugin-markdown");
		class BitbucketTheme extends typedoc_plugin_markdown_1.MarkdownTheme {
		constructor(renderer) {
		@@ -7,0 +7,0 @@ super(renderer);

package.json

		{
		"name": "typedoc-bitbucket-theme",
		"version": "0.1.0",
		"version": "1.0.0",
		"description": "An extension of the default theme from typedoc-plugin-markdown to fix Bitbucket Cloud's internal anchor linking implementation.",
		"main": "dist/theme.js",
		"main": "dist/index.js",
		"files": [
		@@ -22,3 +22,3 @@ "dist/"
		"build": "rm -rf ./dist && tsc",
		"demo": "rm -rf ./demo && yarn run build && typedoc --options ../typedoc-plugin-markdown/demo.options.json --tsconfig ../typedoc-plugin-markdown/test/stubs/tsconfig.json --theme ./dist --out ./demo"
		"demo": "rm -rf ./demo && yarn run build && typedoc --options ../typedoc-plugin-markdown/demo.options.json --tsconfig ../typedoc-plugin-markdown/test/stubs/tsconfig.json --theme bitbucket --out ./demo"
		},
		@@ -28,7 +28,9 @@ "author": "Thomas Grey",
		"peerDependencies": {
		"typedoc": ">=0.22.0",
		"typedoc-plugin-markdown": ">=3.11.0"
		"typedoc": ">=0.22.9",
		"typedoc-plugin-markdown": ">=3.11.10"
		},
		"keywords": [],
		"gitHead": "bfd0eba32acdc4ae2237c01c202fe1f5f5ca10ff"
		"keywords": [
		"typedoc-theme"
		],
		"gitHead": "7a9b045eaacfdafd14c3427379d410c45f6b990b"
		}

README.md

		# typedoc-bitbucket-theme

		An extension of the default theme from [typedoc-plugin-markdown](https://github.com/tgreyuk/typedoc-plugin-markdown/tree/master/packages/typedoc-plugin-markdown) to fix Bitbucket Cloud's internal anchor linking implementation.
		An Bitbucket Cloud compatible [TypeDoc](https://github.com/TypeStrong/typedoc) theme.

		[![npm](https://img.shields.io/npm/v/typedoc-bitbucket-theme.svg)](https://www.npmjs.com/package/typedoc-bitbucket-theme)
		![CI](https://github.com/tgreyuk/typedoc-plugin-markdown/actions/workflows/ci.yml/badge.svg?branch=master)

		_If using Bitbucket Server do not use this theme but set the `--namedAnchors` option instead._
		> 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
		@@ -15,6 +20,14 @@

		### Usage
		## Usage

		```bash
		$ npx typedoc --plugin typedoc-plugin-markdown --theme ./node_modules/typedoc-bitbucket-theme/dist [args]
		$ npx typedoc --theme --bitbucket [args]
		```

		## Options

		Please refer to [typedoc-plugin-markdown](https://github.com/tgreyuk/typedoc-plugin-markdown/blob/master/packages/typedoc-plugin-markdown/README.md#options).

		## License

		[MIT](https://github.com/tgreyuk/typedoc-plugin-markdown/blob/master/packages/typedoc-github-wiki-theme/LICENSE)

typedoc-bitbucket-theme - npm Package Compare versions

New alerts