diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index cc8e4737a..c95e98681 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,58 +1,15 @@ # Contributing Guide Thank you for showing interest in contributing to this project. This guide provides some basic guidelines for doing so. +Before you start, you might find it helpful to read the [TypeDoc development guide](https://typedoc.org/guides/development/) to understand the architecture of TypeDoc itself. -## Overview +## Developer Documentation -This project attempts to align with TypeDoc core as much as possible. Before you start, you might find it helpful to read the TypeDoc development guide to understand the architecture of TypeDoc itself. +Please see the [developer documentation](./developer-docs#read-me) for autogenerated docs generated by this plugin, including associated supporting documents. -## Machine Setup +## Submitting a Pull Request -This is a simple monorepo managed by [npm workspaces](https://docs.npmjs.com/cli/v7/using-npm/workspaces). - -**1. Fork and clone the repository** - -Start by forking the repository to your own GitHub account. Then, clone the repository to your local machine. Please replace `` with your actual GitHub username. - -```bash -git clone git@github.com:/typedoc-plugin-markdown.git -``` - -**2. Install dependencies** - -Navigate to the repository root and install the necessary dependencies: - -```bash -cd typedoc-plugin-markdown - -npm install -``` - -**3. Build the packages and run tests** - -Finally, you can build all the packages and run the tests to ensure everything is set up correctly. - -Build all packages in the workspace: - -```bash -npm run build -``` - -Test all packages in the workspace: - -```bash -npm run test -``` - -If the project builds and the tests run successfully you are ready to start contributing to the project. - -## Developing - -Once setup you can start to develop. Please select the package you would like to contribute to to view the auto-generated developer docs. - -- [typedoc-plugin-markdown](./packages/typedoc-plugin-markdown/developer-docs#readme) - -## Submitting a PR +Once you are ready to submit your changes please create a PR into the `main` branch. ## Contributors diff --git a/TEST.md b/TEST.md deleted file mode 100644 index 105bccf32..000000000 --- a/TEST.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: Quick Start ---- - -# QUICK START diff --git a/developer-docs/README.md b/developer-docs/README.md new file mode 100644 index 000000000..4725f2cd1 --- /dev/null +++ b/developer-docs/README.md @@ -0,0 +1,11 @@ +# Developer Documentation + +Please select the package you would like to view documentation for: + + +## Packages + +| Name | Version | Description | +| ------ | ------ | ------ | +| [typedoc-plugin-markdown](typedoc-plugin-markdown/README.md) | 4.0.3 | A plugin for TypeDoc that enables TypeScript API documentation to be generated in Markdown. | +| [typedoc-plugin-frontmatter](typedoc-plugin-frontmatter/README.md) | 1.0.0 | A plugin for TypeDoc ( + typedoc-plugin-markdown ) that prepends configurable frontmatter to page content. | diff --git a/developer-docs/typedoc-plugin-frontmatter/README.md b/developer-docs/typedoc-plugin-frontmatter/README.md new file mode 100644 index 000000000..b8b371aec --- /dev/null +++ b/developer-docs/typedoc-plugin-frontmatter/README.md @@ -0,0 +1,25 @@ +[Packages Index](../README.md) / typedoc-plugin-frontmatter + +# typedoc-plugin-frontmatter + +Docs for `lib` module + +## Functions + +### load() + +> **load**(`app`): `void` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `app` | [`Application`](https://typedoc.org/api/classes/Application.html) | + +#### Returns + +`void` + +#### Defined in + +[index.ts:18](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-frontmatter/src/index.ts#L18) diff --git a/developer-docs/typedoc-plugin-markdown/README.md b/developer-docs/typedoc-plugin-markdown/README.md new file mode 100644 index 000000000..fe526e7c0 --- /dev/null +++ b/developer-docs/typedoc-plugin-markdown/README.md @@ -0,0 +1,13 @@ +[Packages Index](../README.md) / typedoc-plugin-markdown + +# typedoc-plugin-markdown + +## Modules + +| Module | Description | +| ------ | ------ | +| [app](app/README.md) | Contains all the events and overrides of the typedoc Application. | +| [options](options/README.md) | Configures plugin options. | +| [internationalization](internationalization/README.md) | Exposes additional i18n keys and translations used by the theme. | +| [theme](theme/README.md) | This is the built-in Markdown theme. | +| [libs](libs/README.md) | General pure library functions to be consumed across the plugin. | diff --git a/developer-docs/typedoc-plugin-markdown/app/README.md b/developer-docs/typedoc-plugin-markdown/app/README.md new file mode 100644 index 000000000..a7277d492 --- /dev/null +++ b/developer-docs/typedoc-plugin-markdown/app/README.md @@ -0,0 +1,16 @@ +[Packages Index](../../README.md) / [typedoc-plugin-markdown](../README.md) / app + +# app + +Contains all the events and overrides of the typedoc Application. + +## Index + +### Namespaces + +| Namespace | Description | +| ------ | ------ | +| [initialize](namespaces/initialize/README.md) | Initialization and bootstrapping of the plugin. | +| [events](namespaces/events/README.md) | Contains all the events and overrides of the typedoc Application. | +| [renderer](namespaces/renderer/README.md) | Contains override methods to decouple HTML logic from the TypeDoc's Renderer} | +| [types](namespaces/types/README.md) | Types used for the app. | diff --git a/developer-docs/typedoc-plugin-markdown/app/namespaces/events/README.md b/developer-docs/typedoc-plugin-markdown/app/namespaces/events/README.md new file mode 100644 index 000000000..a08289fca --- /dev/null +++ b/developer-docs/typedoc-plugin-markdown/app/namespaces/events/README.md @@ -0,0 +1,14 @@ +[Packages Index](../../../../README.md) / [typedoc-plugin-markdown](../../../README.md) / [app](../../README.md) / events + +# events + +Contains all the events and overrides of the typedoc Application. + +## Index + +### Classes + +| Class | Description | +| ------ | ------ | +| [MarkdownPageEvent](classes/MarkdownPageEvent.md) | An event emitted by before and after the markup of a page is rendered. | +| [MarkdownRendererEvent](classes/MarkdownRendererEvent.md) | An event emitted at the beginning and end of the rendering process. | diff --git a/packages/typedoc-plugin-markdown/developer-docs/app/namespaces/events/classes/MarkdownPageEvent.md b/developer-docs/typedoc-plugin-markdown/app/namespaces/events/classes/MarkdownPageEvent.md similarity index 53% rename from packages/typedoc-plugin-markdown/developer-docs/app/namespaces/events/classes/MarkdownPageEvent.md rename to developer-docs/typedoc-plugin-markdown/app/namespaces/events/classes/MarkdownPageEvent.md index 79b0d5995..53680e743 100644 --- a/packages/typedoc-plugin-markdown/developer-docs/app/namespaces/events/classes/MarkdownPageEvent.md +++ b/developer-docs/typedoc-plugin-markdown/app/namespaces/events/classes/MarkdownPageEvent.md @@ -1,17 +1,9 @@ -[typedoc-plugin-markdown v4.0.3](../../../../README.md) / [app](../../../README.md) / [events](../README.md) / MarkdownPageEvent +[Packages Index](../../../../../README.md) / [typedoc-plugin-markdown](../../../../README.md) / [app](../../../README.md) / [events](../README.md) / MarkdownPageEvent -# Class: MarkdownPageEvent\ +# Class: MarkdownPageEvent\ An event emitted by before and after the markup of a page is rendered. -## Table of Contents - -* [Example](#example) -* [Extends](#extends) -* [Type Parameters](#type-parameters) -* [Events](#events) -* [Properties](#properties) - ## Example ```ts @@ -24,78 +16,44 @@ export function load(app: MarkdownApplication) { ## Extends -* [`Event`](https://typedoc.org/api/classes/Event.html) +- [`Event`](https://typedoc.org/api/classes/Event.html) ## Type Parameters -| Type Parameter | Default type | -| -------------- | ---------------------------------------------------------------------- | -| `Model` | [`Reflection`](https://typedoc.org/api/classes/Models.Reflection.html) | - -## Events - -### BEGIN - -```ts -static readonly BEGIN: "beginPage" = 'beginPage'; -``` - -Triggered before a document will be rendered. - -#### Defined in - -[packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts:63](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts#L63) - -*** - -### END - -```ts -static readonly END: "endPage" = 'endPage'; -``` - -Triggered after a document has been rendered, just before it is written to disc. - -#### Defined in - -[packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts:69](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts#L69) +| Type Parameter | Default type | +| ------ | ------ | +| `Model` | [`Reflection`](https://typedoc.org/api/classes/Models.Reflection.html) | ## Properties ### project -```ts -project: ProjectReflection; -``` +> **project**: [`ProjectReflection`](https://typedoc.org/api/classes/Models.ProjectReflection.html) The [`ProjectReflection`](https://typedoc.org/api/classes/Models.ProjectReflection.html) instance the renderer is currently processing. #### Defined in -[packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts:23](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts#L23) +[packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts:23](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts#L23) *** ### model -```ts -readonly model: Model; -``` +> `readonly` **model**: `Model` The model that that is being rendered on this page. Either a [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html) or [`ProjectReflection`](https://typedoc.org/api/classes/Models.ProjectReflection.html). #### Defined in -[packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts:29](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts#L29) +[packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts:29](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts#L29) *** ### contents? -```ts -optional contents: string; -``` +> `optional` **contents**: `string` The final markdown `string` content of the page. @@ -103,46 +61,156 @@ Should be rendered by layout templates and can be modified by plugins. #### Defined in -[packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts:36](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts#L36) +[packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts:36](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts#L36) *** ### url -```ts -url: string; -``` +> **url**: `string` The url `string` of the page. #### Defined in -[packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts:41](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts#L41) +[packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts:41](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts#L41) *** ### filename -```ts -filename: string; -``` +> **filename**: `string` The complete `string` filename where the file will be written.. #### Defined in -[packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts:46](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts#L46) +[packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts:46](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts#L46) *** ### frontmatter? -```ts -optional frontmatter: Record; -``` +> `optional` **frontmatter**: `Record`\<`string`, `any`\> The frontmatter of this page represented as a key value object. This property can be utilised by other plugins. #### Defined in -[packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts:51](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts#L51) +[packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts:51](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts#L51) + +## Accessors + +### name + +> `get` **name**(): `string` + +Return the event name. + +#### Returns + +`string` + +#### Defined in + +node\_modules/typedoc/dist/lib/utils/events.d.ts:38 + +*** + +### isPropagationStopped + +> `get` **isPropagationStopped**(): `boolean` + +Has [Event.stopPropagation](MarkdownPageEvent.md#stoppropagation) been called? + +#### Returns + +`boolean` + +#### Defined in + +node\_modules/typedoc/dist/lib/utils/events.d.ts:42 + +## Methods + +### stopPropagation() + +> **stopPropagation**(): `void` + +Stop the propagation of this event. Remaining event handlers will not be executed. + +#### Returns + +`void` + +#### Inherited from + +`Event.stopPropagation` + +#### Defined in + +node\_modules/typedoc/dist/lib/utils/events.d.ts:30 + +*** + +### preventDefault() + +> **preventDefault**(): `void` + +Prevent the default action associated with this event from being executed. + +#### Returns + +`void` + +#### Inherited from + +`Event.preventDefault` + +#### Defined in + +node\_modules/typedoc/dist/lib/utils/events.d.ts:34 + +*** + +### isDefaultPrevented() + +> **isDefaultPrevented**(): `boolean` + +Has [Event.preventDefault](MarkdownPageEvent.md#preventdefault) been called? + +#### Returns + +`boolean` + +#### Inherited from + +`Event.isDefaultPrevented` + +#### Defined in + +node\_modules/typedoc/dist/lib/utils/events.d.ts:46 + +## Events + +### BEGIN + +> `static` `readonly` **BEGIN**: `"beginPage"` = `'beginPage'` + +Triggered before a document will be rendered. + +#### Defined in + +[packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts:63](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts#L63) + +*** + +### END + +> `static` `readonly` **END**: `"endPage"` = `'endPage'` + +Triggered after a document has been rendered, just before it is written to disc. + +#### Defined in + +[packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts:69](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts#L69) diff --git a/developer-docs/typedoc-plugin-markdown/app/namespaces/events/classes/MarkdownRendererEvent.md b/developer-docs/typedoc-plugin-markdown/app/namespaces/events/classes/MarkdownRendererEvent.md new file mode 100644 index 000000000..3ee061c3f --- /dev/null +++ b/developer-docs/typedoc-plugin-markdown/app/namespaces/events/classes/MarkdownRendererEvent.md @@ -0,0 +1,181 @@ +[Packages Index](../../../../../README.md) / [typedoc-plugin-markdown](../../../../README.md) / [app](../../../README.md) / [events](../README.md) / MarkdownRendererEvent + +# Class: MarkdownRendererEvent + +An event emitted at the beginning and end of the rendering process. + +## Example + +```ts +app.renderer.on(MarkdownRendererEvent.BEGIN, (event) => { + console.log(`Render Starting for ${event.project.name}!`); +}); +``` + +## Extends + +- [`Event`](https://typedoc.org/api/classes/Event.html) + +## Properties + +### project + +> `readonly` **project**: [`ProjectReflection`](https://typedoc.org/api/classes/Models.ProjectReflection.html) + +The project the renderer is currently processing. + +#### Defined in + +[packages/typedoc-plugin-markdown/src/app/events/markdown-renderer-event.ts:22](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/app/events/markdown-renderer-event.ts#L22) + +*** + +### outputDirectory + +> `readonly` **outputDirectory**: `string` + +The path of the directory the documentation should be written to. + +#### Defined in + +[packages/typedoc-plugin-markdown/src/app/events/markdown-renderer-event.ts:27](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/app/events/markdown-renderer-event.ts#L27) + +*** + +### urls? + +> `optional` **urls**: [`UrlMapping`](../../../../theme/namespaces/types/interfaces/UrlMapping.md)\<[`Reflection`](https://typedoc.org/api/classes/Models.Reflection.html)\>[] + +A list of all pages that should be generated. + +#### Defined in + +[packages/typedoc-plugin-markdown/src/app/events/markdown-renderer-event.ts:32](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/app/events/markdown-renderer-event.ts#L32) + +*** + +### navigation? + +> `optional` **navigation**: [`NavigationItem`](../../../../theme/namespaces/types/interfaces/NavigationItem.md)[] + +The navigation structure of the project that can be utilised by plugins. + +#### Defined in + +[packages/typedoc-plugin-markdown/src/app/events/markdown-renderer-event.ts:37](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/app/events/markdown-renderer-event.ts#L37) + +## Accessors + +### name + +> `get` **name**(): `string` + +Return the event name. + +#### Returns + +`string` + +#### Defined in + +node\_modules/typedoc/dist/lib/utils/events.d.ts:38 + +*** + +### isPropagationStopped + +> `get` **isPropagationStopped**(): `boolean` + +Has [Event.stopPropagation](MarkdownPageEvent.md#stoppropagation) been called? + +#### Returns + +`boolean` + +#### Defined in + +node\_modules/typedoc/dist/lib/utils/events.d.ts:42 + +## Methods + +### stopPropagation() + +> **stopPropagation**(): `void` + +Stop the propagation of this event. Remaining event handlers will not be executed. + +#### Returns + +`void` + +#### Inherited from + +`Event.stopPropagation` + +#### Defined in + +node\_modules/typedoc/dist/lib/utils/events.d.ts:30 + +*** + +### preventDefault() + +> **preventDefault**(): `void` + +Prevent the default action associated with this event from being executed. + +#### Returns + +`void` + +#### Inherited from + +`Event.preventDefault` + +#### Defined in + +node\_modules/typedoc/dist/lib/utils/events.d.ts:34 + +*** + +### isDefaultPrevented() + +> **isDefaultPrevented**(): `boolean` + +Has [Event.preventDefault](MarkdownPageEvent.md#preventdefault) been called? + +#### Returns + +`boolean` + +#### Inherited from + +`Event.isDefaultPrevented` + +#### Defined in + +node\_modules/typedoc/dist/lib/utils/events.d.ts:46 + +## Events + +### BEGIN + +> `static` `readonly` **BEGIN**: `"beginRender"` = `'beginRender'` + +Triggered before the renderer starts rendering a project. + +#### Defined in + +[packages/typedoc-plugin-markdown/src/app/events/markdown-renderer-event.ts:43](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/app/events/markdown-renderer-event.ts#L43) + +*** + +### END + +> `static` `readonly` **END**: `"endRender"` = `'endRender'` + +Triggered after the renderer has written all documents. + +#### Defined in + +[packages/typedoc-plugin-markdown/src/app/events/markdown-renderer-event.ts:49](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/app/events/markdown-renderer-event.ts#L49) diff --git a/developer-docs/typedoc-plugin-markdown/app/namespaces/initialize/README.md b/developer-docs/typedoc-plugin-markdown/app/namespaces/initialize/README.md new file mode 100644 index 000000000..d95dcbb4d --- /dev/null +++ b/developer-docs/typedoc-plugin-markdown/app/namespaces/initialize/README.md @@ -0,0 +1,50 @@ +[Packages Index](../../../../README.md) / [typedoc-plugin-markdown](../../../README.md) / [app](../../README.md) / initialize + +# initialize + +Initialization and bootstrapping of the plugin. + +## Functions + +### load() + +> **load**(`app`): `void` + +This method is exposed to the `"plugin"` configuration option and contains all initialization functionality. + +#### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `app` | [`Application`](https://typedoc.org/api/classes/Application.html) | When loaded TypeDoc provides an instance of the Application referred to as the `"pluginHost"`. | + +#### Returns + +`void` + +#### Remarks + +The following initialization steps are taken in this method: + +**1. Declare options:** + +- Iterate over declaration definitions and to the container. + +**2. Replace default theme:** + +- Replace the default HTML theme the with the [MarkdownTheme](../../../theme/classes/MarkdownTheme.md) + +**3. Override TypeDoc methods:** + +- Intercept and modify some TypeDoc core methods that are coupled to the HTML theme. +**4. Configure localization:** + +- Load the additional translations used by the theme for the selected language. + +#### See + +https://typedoc.org/guides/development/#plugins. + +#### Defined in + +[packages/typedoc-plugin-markdown/src/app/\_initialize.ts:49](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/app/_initialize.ts#L49) diff --git a/developer-docs/typedoc-plugin-markdown/app/namespaces/renderer/README.md b/developer-docs/typedoc-plugin-markdown/app/namespaces/renderer/README.md new file mode 100644 index 000000000..57e7fb4a6 --- /dev/null +++ b/developer-docs/typedoc-plugin-markdown/app/namespaces/renderer/README.md @@ -0,0 +1,83 @@ +[Packages Index](../../../../README.md) / [typedoc-plugin-markdown](../../../README.md) / [app](../../README.md) / renderer + +# renderer + +Contains override methods to decouple HTML logic from the TypeDoc's Renderer} + +## Functions + +### generateDocs() + +> **generateDocs**(`project`, `out`): `Promise`\<`void`\> + +Replacement of TypeDoc's [Application.generateDocs](../types/interfaces/MarkdownApplication.md#generatedocs) method to decouple HTML logic. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `project` | [`ProjectReflection`](https://typedoc.org/api/classes/Models.ProjectReflection.html) | +| `out` | `string` | + +#### Returns + +`Promise`\<`void`\> + +#### Defined in + +[packages/typedoc-plugin-markdown/src/app/renderer.ts:26](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/app/renderer.ts#L26) + +*** + +### render() + +> **render**(`project`, `outputDirectory`): `Promise`\<`void`\> + +Replacement of TypeDoc's [Renderer.render](../types/interfaces/MarkdownRenderer.md#render) method to decouple HTML logic. + +This is essentially a copy of the base method with a few tweaks. + +- Removes unnecessary async calls to load highlighters only required for html theme. +- Removes hooks logic that are jsx specific. +- Adds any logic specific to markdown rendering. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `project` | [`ProjectReflection`](https://typedoc.org/api/classes/Models.ProjectReflection.html) | +| `outputDirectory` | `string` | + +#### Returns + +`Promise`\<`void`\> + +#### Defined in + +[packages/typedoc-plugin-markdown/src/app/renderer.ts:48](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/app/renderer.ts#L48) + +*** + +### resolvePackages() + +> **resolvePackages**(`app`, `context`, `packageDir`): `void` + +Currently options set for packages are only stored on the converter and are destroyed before being passed to the Renderer. + +By intercepting the package options set in the converter and storing them on the renderer we can use them later in the theme. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `app` | [`Application`](https://typedoc.org/api/classes/Application.html) | +| `context` | `Context` | +| `packageDir` | `string` | + +#### Returns + +`void` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/app/renderer.ts:145](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/app/renderer.ts#L145) diff --git a/developer-docs/typedoc-plugin-markdown/app/namespaces/types/README.md b/developer-docs/typedoc-plugin-markdown/app/namespaces/types/README.md new file mode 100644 index 000000000..ca077c8ad --- /dev/null +++ b/developer-docs/typedoc-plugin-markdown/app/namespaces/types/README.md @@ -0,0 +1,15 @@ +[Packages Index](../../../../README.md) / [typedoc-plugin-markdown](../../../README.md) / [app](../../README.md) / types + +# types + +Types used for the app. + +## Index + +### Interfaces + +| Interface | Description | +| ------ | ------ | +| [MarkdownApplication](interfaces/MarkdownApplication.md) | This interface is essentially an extended typing of TypeDoc's [`Application`](https://typedoc.org/api/classes/Application.html) instance. | +| [MarkdownRendererHooks](interfaces/MarkdownRendererHooks.md) | Describes the hooks available to inject output in the markdown theme. | +| [MarkdownRenderer](interfaces/MarkdownRenderer.md) | An extended typing of TypeDoc's [`Renderer`](https://typedoc.org/api/classes/Renderer.html) class that includes updated typings for hooks and async jobs. | diff --git a/developer-docs/typedoc-plugin-markdown/app/namespaces/types/interfaces/MarkdownApplication.md b/developer-docs/typedoc-plugin-markdown/app/namespaces/types/interfaces/MarkdownApplication.md new file mode 100644 index 000000000..ebd298aac --- /dev/null +++ b/developer-docs/typedoc-plugin-markdown/app/namespaces/types/interfaces/MarkdownApplication.md @@ -0,0 +1,986 @@ +[Packages Index](../../../../../README.md) / [typedoc-plugin-markdown](../../../../README.md) / [app](../../../README.md) / [types](../README.md) / MarkdownApplication + +# Interface: MarkdownApplication + +This interface is essentially an extended typing of TypeDoc's [`Application`](https://typedoc.org/api/classes/Application.html) instance. + +## Example + +```ts +import { MarkdownApplication } from 'typedoc-plugin-markdown'; + +export function load(app: MarkdownApplication) { + ... +} +``` + +## Extends + +- [`Application`](https://typedoc.org/api/classes/Application.html) + +## Properties + +### converter + +> **converter**: `Converter` + +The converter used to create the declaration reflections. + +#### Inherited from + +`Application.converter` + +#### Defined in + +node\_modules/typedoc/dist/lib/application.d.ts:30 + +*** + +### serializer + +> **serializer**: `Serializer` + +The serializer used to generate JSON output. + +#### Inherited from + +`Application.serializer` + +#### Defined in + +node\_modules/typedoc/dist/lib/application.d.ts:38 + +*** + +### deserializer + +> **deserializer**: `Deserializer` + +The deserializer used to restore previously serialized JSON output. + +#### Inherited from + +`Application.deserializer` + +#### Defined in + +node\_modules/typedoc/dist/lib/application.d.ts:42 + +*** + +### logger + +> **logger**: `Logger` + +The logger that should be used to output messages. + +#### Inherited from + +`Application.logger` + +#### Defined in + +node\_modules/typedoc/dist/lib/application.d.ts:46 + +*** + +### internationalization + +> **internationalization**: `Internationalization` + +Internationalization module which supports translating according to +the `lang` option. + +#### Inherited from + +`Application.internationalization` + +#### Defined in + +node\_modules/typedoc/dist/lib/application.d.ts:51 + +*** + +### i18n + +> **i18n**: `TranslationProxy` + +Proxy based shortcuts for internationalization keys. + +#### Inherited from + +`Application.i18n` + +#### Defined in + +node\_modules/typedoc/dist/lib/application.d.ts:55 + +*** + +### options + +> **options**: [`Options`](https://typedoc.org/api/classes/Configuration.Options.html) + +#### Inherited from + +`Application.options` + +#### Defined in + +node\_modules/typedoc/dist/lib/application.d.ts:56 + +*** + +### files + +> **files**: `FileRegistry` + +#### Inherited from + +`Application.files` + +#### Defined in + +node\_modules/typedoc/dist/lib/application.d.ts:57 + +*** + +### componentName + +> **componentName**: `string` + +The name of this component as set by the `@Component` decorator. + +#### Inherited from + +`Application.componentName` + +#### Defined in + +node\_modules/typedoc/dist/lib/utils/component.d.ts:48 + +*** + +### renderer + +> **renderer**: [`MarkdownRenderer`](MarkdownRenderer.md) + +Re-types the `renderer` instance to [`MarkdownRenderer`](MarkdownRenderer.md). + +#### Overrides + +`Application.renderer` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/app/types/markdown-application.ts:22](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/app/types/markdown-application.ts#L22) + +## Accessors + +### lang + +*** + +### skipErrorChecking + +*** + +### entryPointStrategy + +*** + +### entryPoints + +*** + +### application + +> `get` **application**(): [`Application`](https://typedoc.org/api/classes/Application.html) + +Return the application / root component instance. + +#### Returns + +[`Application`](https://typedoc.org/api/classes/Application.html) + +#### Defined in + +node\_modules/typedoc/dist/lib/utils/component.d.ts:61 + +*** + +### owner + +> `get` **owner**(): `O` + +Return the owner of this component. + +#### Returns + +`O` + +#### Defined in + +node\_modules/typedoc/dist/lib/utils/component.d.ts:65 + +*** + +### \_listenId + +> `get` `private` **\_listenId**(): `any` + +A unique id that identifies this instance. + +#### Returns + +`any` + +#### Defined in + +node\_modules/typedoc/dist/lib/utils/events.d.ts:70 + +## Methods + +### getTypeScriptPath() + +> **getTypeScriptPath**(): `string` + +Return the path to the TypeScript compiler. + +#### Returns + +`string` + +#### Inherited from + +`Application.getTypeScriptPath` + +#### Defined in + +node\_modules/typedoc/dist/lib/application.d.ts:111 + +*** + +### getTypeScriptVersion() + +> **getTypeScriptVersion**(): `string` + +#### Returns + +`string` + +#### Inherited from + +`Application.getTypeScriptVersion` + +#### Defined in + +node\_modules/typedoc/dist/lib/application.d.ts:112 + +*** + +### getEntryPoints() + +> **getEntryPoints**(): `undefined` \| `DocumentationEntryPoint`[] + +Gets the entry points to be documented according to the current `entryPoints` and `entryPointStrategy` options. +May return undefined if entry points fail to be expanded. + +#### Returns + +`undefined` \| `DocumentationEntryPoint`[] + +#### Inherited from + +`Application.getEntryPoints` + +#### Defined in + +node\_modules/typedoc/dist/lib/application.d.ts:117 + +*** + +### convert() + +> **convert**(): `Promise`\<`undefined` \| [`ProjectReflection`](https://typedoc.org/api/classes/Models.ProjectReflection.html)\> + +Run the converter for the given set of files and return the generated reflections. + +#### Returns + +`Promise`\<`undefined` \| [`ProjectReflection`](https://typedoc.org/api/classes/Models.ProjectReflection.html)\> + +An instance of ProjectReflection on success, undefined otherwise. + +#### Inherited from + +`Application.convert` + +#### Defined in + +node\_modules/typedoc/dist/lib/application.d.ts:123 + +*** + +### convertAndWatch() + +> **convertAndWatch**(`success`): `void` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `success` | (`project`) => `Promise`\<`void`\> | + +#### Returns + +`void` + +#### Inherited from + +`Application.convertAndWatch` + +#### Defined in + +node\_modules/typedoc/dist/lib/application.d.ts:124 + +*** + +### validate() + +> **validate**(`project`): `void` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `project` | [`ProjectReflection`](https://typedoc.org/api/classes/Models.ProjectReflection.html) | + +#### Returns + +`void` + +#### Inherited from + +`Application.validate` + +#### Defined in + +node\_modules/typedoc/dist/lib/application.d.ts:125 + +*** + +### generateDocs() + +> **generateDocs**(`project`, `out`): `Promise`\<`void`\> + +Render HTML for the given project + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `project` | [`ProjectReflection`](https://typedoc.org/api/classes/Models.ProjectReflection.html) | +| `out` | `string` | + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +`Application.generateDocs` + +#### Defined in + +node\_modules/typedoc/dist/lib/application.d.ts:129 + +*** + +### generateJson() + +> **generateJson**(`project`, `out`): `Promise`\<`void`\> + +Write the reflections to a json file. + +#### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `project` | [`ProjectReflection`](https://typedoc.org/api/classes/Models.ProjectReflection.html) | - | +| `out` | `string` | The path and file name of the target file. | + +#### Returns + +`Promise`\<`void`\> + +Whether the JSON file could be written successfully. + +#### Inherited from + +`Application.generateJson` + +#### Defined in + +node\_modules/typedoc/dist/lib/application.d.ts:136 + +*** + +### toString() + +> **toString**(): `string` + +Print the version number. + +#### Returns + +`string` + +#### Inherited from + +`Application.toString` + +#### Defined in + +node\_modules/typedoc/dist/lib/application.d.ts:140 + +*** + +### initialize() + +> `protected` **initialize**(): `void` + +Initialize this component. + +#### Returns + +`void` + +#### Inherited from + +`Application.initialize` + +#### Defined in + +node\_modules/typedoc/dist/lib/utils/component.d.ts:56 + +*** + +### bubble() + +> `protected` **bubble**(`name`, ...`args`): `this` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `name` | `string` \| `EventMap` \| [`Event`](https://typedoc.org/api/classes/Event.html) | +| ...`args` | `any`[] | + +#### Returns + +`this` + +#### Inherited from + +`Application.bubble` + +#### Defined in + +node\_modules/typedoc/dist/lib/utils/component.d.ts:57 + +*** + +### getComponent() + +> **getComponent**(`name`): `undefined` \| `AbstractComponent`\<[`Application`](https://typedoc.org/api/classes/Application.html)\> + +Retrieve a plugin instance. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `name` | `string` | + +#### Returns + +`undefined` \| `AbstractComponent`\<[`Application`](https://typedoc.org/api/classes/Application.html)\> + +The instance of the plugin or undefined if no plugin with the given class is attached. + +#### Inherited from + +`Application.getComponent` + +#### Defined in + +node\_modules/typedoc/dist/lib/utils/component.d.ts:88 + +*** + +### getComponents() + +> **getComponents**(): `AbstractComponent`\<[`Application`](https://typedoc.org/api/classes/Application.html)\>[] + +#### Returns + +`AbstractComponent`\<[`Application`](https://typedoc.org/api/classes/Application.html)\>[] + +#### Inherited from + +`Application.getComponents` + +#### Defined in + +node\_modules/typedoc/dist/lib/utils/component.d.ts:89 + +*** + +### hasComponent() + +> **hasComponent**(`name`): `boolean` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `name` | `string` | + +#### Returns + +`boolean` + +#### Inherited from + +`Application.hasComponent` + +#### Defined in + +node\_modules/typedoc/dist/lib/utils/component.d.ts:90 + +*** + +### addComponent() + +> **addComponent**\<`T`\>(`name`, `componentClass`): `T` + +#### Type Parameters + +| Type Parameter | +| ------ | +| `T` *extends* `AbstractComponent`\<[`Application`](https://typedoc.org/api/classes/Application.html)\> | + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `name` | `string` | +| `componentClass` | `T` \| `ComponentClass`\<`T`, [`Application`](https://typedoc.org/api/classes/Application.html)\> | + +#### Returns + +`T` + +#### Inherited from + +`Application.addComponent` + +#### Defined in + +node\_modules/typedoc/dist/lib/utils/component.d.ts:91 + +*** + +### removeComponent() + +> **removeComponent**(`name`): `undefined` \| `AbstractComponent`\<[`Application`](https://typedoc.org/api/classes/Application.html)\> + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `name` | `string` | + +#### Returns + +`undefined` \| `AbstractComponent`\<[`Application`](https://typedoc.org/api/classes/Application.html)\> + +#### Inherited from + +`Application.removeComponent` + +#### Defined in + +node\_modules/typedoc/dist/lib/utils/component.d.ts:92 + +*** + +### removeAllComponents() + +> **removeAllComponents**(): `void` + +#### Returns + +`void` + +#### Inherited from + +`Application.removeAllComponents` + +#### Defined in + +node\_modules/typedoc/dist/lib/utils/component.d.ts:93 + +*** + +### on() + +#### on(eventMap, context) + +> **on**(`eventMap`, `context`?): `this` + +Bind an event to a `callback` function. Passing `"all"` will bind +the callback to all events fired. + +##### Parameters + +| Parameter | Type | +| ------ | ------ | +| `eventMap` | `EventMap` | +| `context`? | `any` | + +##### Returns + +`this` + +##### Inherited from + +`Application.on` + +##### Defined in + +node\_modules/typedoc/dist/lib/utils/events.d.ts:76 + +#### on(eventMap, callback, context, priority) + +> **on**(`eventMap`, `callback`?, `context`?, `priority`?): `this` + +##### Parameters + +| Parameter | Type | +| ------ | ------ | +| `eventMap` | `EventMap` | +| `callback`? | `EventCallback` | +| `context`? | `any` | +| `priority`? | `number` | + +##### Returns + +`this` + +##### Inherited from + +`Application.on` + +##### Defined in + +node\_modules/typedoc/dist/lib/utils/events.d.ts:77 + +#### on(name, callback, context, priority) + +> **on**(`name`, `callback`, `context`?, `priority`?): `this` + +##### Parameters + +| Parameter | Type | +| ------ | ------ | +| `name` | `string` | +| `callback` | `EventCallback` | +| `context`? | `any` | +| `priority`? | `number` | + +##### Returns + +`this` + +##### Inherited from + +`Application.on` + +##### Defined in + +node\_modules/typedoc/dist/lib/utils/events.d.ts:78 + +*** + +### once() + +#### once(eventMap, context) + +> **once**(`eventMap`, `context`?): `this` + +Bind an event to only be triggered a single time. After the first time +the callback is invoked, its listener will be removed. If multiple events +are passed in using the space-separated syntax, the handler will fire +once for each event, not once for a combination of all events. + +##### Parameters + +| Parameter | Type | +| ------ | ------ | +| `eventMap` | `EventMap` | +| `context`? | `any` | + +##### Returns + +`this` + +##### Inherited from + +`Application.once` + +##### Defined in + +node\_modules/typedoc/dist/lib/utils/events.d.ts:89 + +#### once(name, callback, context, priority) + +> **once**(`name`, `callback`, `context`?, `priority`?): `this` + +##### Parameters + +| Parameter | Type | +| ------ | ------ | +| `name` | `string` | +| `callback` | `EventCallback` | +| `context`? | `any` | +| `priority`? | `any` | + +##### Returns + +`this` + +##### Inherited from + +`Application.once` + +##### Defined in + +node\_modules/typedoc/dist/lib/utils/events.d.ts:90 + +*** + +### off() + +#### off(undefined) + +> **off**(): `this` + +Remove one or many callbacks. If `context` is null, removes all +callbacks with that function. If `callback` is null, removes all +callbacks for the event. If `name` is null, removes all bound +callbacks for all events. + +##### Returns + +`this` + +##### Inherited from + +`Application.off` + +##### Defined in + +node\_modules/typedoc/dist/lib/utils/events.d.ts:97 + +#### off(eventMap, context) + +> **off**(`eventMap`, `context`?): `this` + +##### Parameters + +| Parameter | Type | +| ------ | ------ | +| `eventMap` | `undefined` \| `EventMap` | +| `context`? | `any` | + +##### Returns + +`this` + +##### Inherited from + +`Application.off` + +##### Defined in + +node\_modules/typedoc/dist/lib/utils/events.d.ts:98 + +#### off(name, callback, context) + +> **off**(`name`, `callback`?, `context`?): `this` + +##### Parameters + +| Parameter | Type | +| ------ | ------ | +| `name` | `undefined` \| `string` | +| `callback`? | `EventCallback` | +| `context`? | `any` | + +##### Returns + +`this` + +##### Inherited from + +`Application.off` + +##### Defined in + +node\_modules/typedoc/dist/lib/utils/events.d.ts:99 + +*** + +### listenTo() + +> **listenTo**(`obj`, `name`, `callback`?, `priority`?): `this` + +Inversion-of-control versions of `on`. Tell *this* object to listen to +an event in another object... keeping track of what it's listening to +for easier unbinding later. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `obj` | `EventDispatcher` | +| `name` | `string` \| `EventMap` | +| `callback`? | `EventCallback` | +| `priority`? | `number` | + +#### Returns + +`this` + +#### Inherited from + +`Application.listenTo` + +#### Defined in + +node\_modules/typedoc/dist/lib/utils/events.d.ts:105 + +*** + +### listenToOnce() + +#### listenToOnce(obj, eventMap) + +> **listenToOnce**(`obj`, `eventMap`): `this` + +Inversion-of-control versions of `once`. + +##### Parameters + +| Parameter | Type | +| ------ | ------ | +| `obj` | `EventDispatcher` | +| `eventMap` | `EventMap` | + +##### Returns + +`this` + +##### Inherited from + +`Application.listenToOnce` + +##### Defined in + +node\_modules/typedoc/dist/lib/utils/events.d.ts:109 + +#### listenToOnce(obj, name, callback, priority) + +> **listenToOnce**(`obj`, `name`, `callback`, `priority`?): `this` + +##### Parameters + +| Parameter | Type | +| ------ | ------ | +| `obj` | `EventDispatcher` | +| `name` | `string` | +| `callback` | `EventCallback` | +| `priority`? | `number` | + +##### Returns + +`this` + +##### Inherited from + +`Application.listenToOnce` + +##### Defined in + +node\_modules/typedoc/dist/lib/utils/events.d.ts:110 + +*** + +### stopListening() + +> **stopListening**(`obj`?, `name`?, `callback`?): `this` + +Tell this object to stop listening to either specific events ... or +to every object it's currently listening to. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `obj`? | `EventDispatcher` | +| `name`? | `string` \| `EventMap` | +| `callback`? | `EventCallback` | + +#### Returns + +`this` + +#### Inherited from + +`Application.stopListening` + +#### Defined in + +node\_modules/typedoc/dist/lib/utils/events.d.ts:115 + +*** + +### trigger() + +> **trigger**(`name`, ...`args`): `this` + +Trigger one or many events, firing all bound callbacks. Callbacks are +passed the same arguments as `trigger` is, apart from the event name +(unless you're listening on `"all"`, which will cause your callback to +receive the true name of the event as the first argument). + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `name` | `string` \| `EventMap` \| [`Event`](https://typedoc.org/api/classes/Event.html) | +| ...`args` | `any`[] | + +#### Returns + +`this` + +#### Inherited from + +`Application.trigger` + +#### Defined in + +node\_modules/typedoc/dist/lib/utils/events.d.ts:122 diff --git a/developer-docs/typedoc-plugin-markdown/app/namespaces/types/interfaces/MarkdownRenderer.md b/developer-docs/typedoc-plugin-markdown/app/namespaces/types/interfaces/MarkdownRenderer.md new file mode 100644 index 000000000..9f317b017 --- /dev/null +++ b/developer-docs/typedoc-plugin-markdown/app/namespaces/types/interfaces/MarkdownRenderer.md @@ -0,0 +1,833 @@ +[Packages Index](../../../../../README.md) / [typedoc-plugin-markdown](../../../../README.md) / [app](../../../README.md) / [types](../README.md) / MarkdownRenderer + +# Interface: MarkdownRenderer + +An extended typing of TypeDoc's [`Renderer`](https://typedoc.org/api/classes/Renderer.html) class that includes updated typings for hooks and async jobs. + +## Example + +```ts +import { MarkdownApplication } from 'typedoc-plugin-markdown'; + +export function load(app: MarkdownApplication) { + +app.renderer.markdownHooks.on( + 'page.begin', () => '> This is some markdown at the top of the page', +); + +app.renderer.preRenderAsyncJobs.push(async (output: MarkdownRendererEvent) => { + await doSomethingAsync(output); +}); + +app.renderer.postRenderAsyncJobs.push(async (output: MarkdownRendererEvent)) => { + await doSomethingAsync(output); +}); + +} +``` + +## Extends + +- [`Renderer`](https://typedoc.org/api/classes/Renderer.html) + +## Properties + +### theme? + +> `optional` **theme**: [`Theme`](https://typedoc.org/api/classes/Theme.html) + +The theme that is used to render the documentation. + +#### Inherited from + +`Renderer.theme` + +#### Defined in + +node\_modules/typedoc/dist/lib/output/renderer.d.ts:149 + +*** + +### hooks + +> **hooks**: [`EventHooks`](https://typedoc.org/api/classes/EventHooks.html)\<`RendererHooks`, `JsxElement`\> + +Hooks which will be called when rendering pages. +Note: +- Hooks added during output will be discarded at the end of rendering. +- Hooks added during a page render will be discarded at the end of that page's render. + +See RendererHooks for a description of each available hook, and when it will be called. + +#### Inherited from + +`Renderer.hooks` + +#### Defined in + +node\_modules/typedoc/dist/lib/output/renderer.d.ts:158 + +*** + +### renderStartTime + +> **renderStartTime**: `number` + +#### Inherited from + +`Renderer.renderStartTime` + +#### Defined in + +node\_modules/typedoc/dist/lib/output/renderer.d.ts:170 + +*** + +### componentName + +> **componentName**: `string` + +The name of this component as set by the `@Component` decorator. + +#### Inherited from + +`Renderer.componentName` + +#### Defined in + +node\_modules/typedoc/dist/lib/utils/component.d.ts:48 + +*** + +### markdownHooks + +> **markdownHooks**: [`EventHooks`](https://typedoc.org/api/classes/EventHooks.html)\<[`MarkdownRendererHooks`](MarkdownRendererHooks.md), `string`\> + +Replaces the event hooks typings the [`MarkdownRendererHooks`](MarkdownRendererHooks.md) used by the plugin. + +#### Defined in + +[packages/typedoc-plugin-markdown/src/app/types/markdown-renderer.ts:36](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/app/types/markdown-renderer.ts#L36) + +*** + +### packagesMeta + +`Internal` + +> **packagesMeta**: `Record`\<`string`, \{`description`: `string`;`options`: [`Options`](https://typedoc.org/api/classes/Configuration.Options.html); \}\> + +#### Defined in + +[packages/typedoc-plugin-markdown/src/app/types/markdown-renderer.ts:38](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/app/types/markdown-renderer.ts#L38) + +*** + +### defineTheme() + +`Internal` + +> **defineTheme**: (`name`, `theme`) => `void` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `name` | `string` | +| `theme` | (`renderer`) => [`MarkdownTheme`](../../../../theme/classes/MarkdownTheme.md) | + +#### Returns + +`void` + +#### Overrides + +`Renderer.defineTheme` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/app/types/markdown-renderer.ts:40](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/app/types/markdown-renderer.ts#L40) + +*** + +### preRenderAsyncJobs + +> **preRenderAsyncJobs**: (`output`) => `Promise`\<`void`\>[] + +Re-types the returned argument argument to [`MarkdownRendererEvent`](../../events/classes/MarkdownRendererEvent.md). + +#### Overrides + +`Renderer.preRenderAsyncJobs` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/app/types/markdown-renderer.ts:47](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/app/types/markdown-renderer.ts#L47) + +*** + +### postRenderAsyncJobs + +> **postRenderAsyncJobs**: (`output`) => `Promise`\<`void`\>[] + +Re-types the returned argument argument to [`MarkdownRendererEvent`](../../events/classes/MarkdownRendererEvent.md). + +#### Overrides + +`Renderer.postRenderAsyncJobs` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/app/types/markdown-renderer.ts:51](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/app/types/markdown-renderer.ts#L51) + +## Accessors + +### themeName + +*** + +### cleanOutputDir + +*** + +### cname + +*** + +### githubPages + +*** + +### cacheBust + +*** + +### lightTheme + +*** + +### darkTheme + +*** + +### highlightLanguages + +*** + +### pretty + +*** + +### application + +> `get` **application**(): [`Application`](https://typedoc.org/api/classes/Application.html) + +Return the application / root component instance. + +#### Returns + +[`Application`](https://typedoc.org/api/classes/Application.html) + +#### Defined in + +node\_modules/typedoc/dist/lib/utils/component.d.ts:61 + +*** + +### owner + +> `get` **owner**(): `O` + +Return the owner of this component. + +#### Returns + +`O` + +#### Defined in + +node\_modules/typedoc/dist/lib/utils/component.d.ts:65 + +*** + +### \_listenId + +> `get` `private` **\_listenId**(): `any` + +A unique id that identifies this instance. + +#### Returns + +`any` + +#### Defined in + +node\_modules/typedoc/dist/lib/utils/events.d.ts:70 + +## Methods + +### render() + +> **render**(`project`, `outputDirectory`): `Promise`\<`void`\> + +Render the given project reflection to the specified output directory. + +#### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `project` | [`ProjectReflection`](https://typedoc.org/api/classes/Models.ProjectReflection.html) | The project that should be rendered. | +| `outputDirectory` | `string` | The path of the directory the documentation should be rendered to. | + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +`Renderer.render` + +#### Defined in + +node\_modules/typedoc/dist/lib/output/renderer.d.ts:185 + +*** + +### initialize() + +> `protected` **initialize**(): `void` + +Initialize this component. + +#### Returns + +`void` + +#### Inherited from + +`Renderer.initialize` + +#### Defined in + +node\_modules/typedoc/dist/lib/utils/component.d.ts:56 + +*** + +### bubble() + +> `protected` **bubble**(`name`, ...`args`): `this` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `name` | `string` \| `EventMap` \| [`Event`](https://typedoc.org/api/classes/Event.html) | +| ...`args` | `any`[] | + +#### Returns + +`this` + +#### Inherited from + +`Renderer.bubble` + +#### Defined in + +node\_modules/typedoc/dist/lib/utils/component.d.ts:57 + +*** + +### getComponent() + +> **getComponent**(`name`): `undefined` \| `RendererComponent` + +Retrieve a plugin instance. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `name` | `string` | + +#### Returns + +`undefined` \| `RendererComponent` + +The instance of the plugin or undefined if no plugin with the given class is attached. + +#### Inherited from + +`Renderer.getComponent` + +#### Defined in + +node\_modules/typedoc/dist/lib/utils/component.d.ts:88 + +*** + +### getComponents() + +> **getComponents**(): `RendererComponent`[] + +#### Returns + +`RendererComponent`[] + +#### Inherited from + +`Renderer.getComponents` + +#### Defined in + +node\_modules/typedoc/dist/lib/utils/component.d.ts:89 + +*** + +### hasComponent() + +> **hasComponent**(`name`): `boolean` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `name` | `string` | + +#### Returns + +`boolean` + +#### Inherited from + +`Renderer.hasComponent` + +#### Defined in + +node\_modules/typedoc/dist/lib/utils/component.d.ts:90 + +*** + +### addComponent() + +> **addComponent**\<`T`\>(`name`, `componentClass`): `T` + +#### Type Parameters + +| Type Parameter | +| ------ | +| `T` *extends* `RendererComponent` | + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `name` | `string` | +| `componentClass` | `T` \| `ComponentClass`\<`T`, [`Application`](https://typedoc.org/api/classes/Application.html)\> | + +#### Returns + +`T` + +#### Inherited from + +`Renderer.addComponent` + +#### Defined in + +node\_modules/typedoc/dist/lib/utils/component.d.ts:91 + +*** + +### removeComponent() + +> **removeComponent**(`name`): `undefined` \| `RendererComponent` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `name` | `string` | + +#### Returns + +`undefined` \| `RendererComponent` + +#### Inherited from + +`Renderer.removeComponent` + +#### Defined in + +node\_modules/typedoc/dist/lib/utils/component.d.ts:92 + +*** + +### removeAllComponents() + +> **removeAllComponents**(): `void` + +#### Returns + +`void` + +#### Inherited from + +`Renderer.removeAllComponents` + +#### Defined in + +node\_modules/typedoc/dist/lib/utils/component.d.ts:93 + +*** + +### on() + +#### on(eventMap, context) + +> **on**(`eventMap`, `context`?): `this` + +Bind an event to a `callback` function. Passing `"all"` will bind +the callback to all events fired. + +##### Parameters + +| Parameter | Type | +| ------ | ------ | +| `eventMap` | `EventMap` | +| `context`? | `any` | + +##### Returns + +`this` + +##### Inherited from + +`Renderer.on` + +##### Defined in + +node\_modules/typedoc/dist/lib/utils/events.d.ts:76 + +#### on(eventMap, callback, context, priority) + +> **on**(`eventMap`, `callback`?, `context`?, `priority`?): `this` + +##### Parameters + +| Parameter | Type | +| ------ | ------ | +| `eventMap` | `EventMap` | +| `callback`? | `EventCallback` | +| `context`? | `any` | +| `priority`? | `number` | + +##### Returns + +`this` + +##### Inherited from + +`Renderer.on` + +##### Defined in + +node\_modules/typedoc/dist/lib/utils/events.d.ts:77 + +#### on(name, callback, context, priority) + +> **on**(`name`, `callback`, `context`?, `priority`?): `this` + +##### Parameters + +| Parameter | Type | +| ------ | ------ | +| `name` | `string` | +| `callback` | `EventCallback` | +| `context`? | `any` | +| `priority`? | `number` | + +##### Returns + +`this` + +##### Inherited from + +`Renderer.on` + +##### Defined in + +node\_modules/typedoc/dist/lib/utils/events.d.ts:78 + +*** + +### once() + +#### once(eventMap, context) + +> **once**(`eventMap`, `context`?): `this` + +Bind an event to only be triggered a single time. After the first time +the callback is invoked, its listener will be removed. If multiple events +are passed in using the space-separated syntax, the handler will fire +once for each event, not once for a combination of all events. + +##### Parameters + +| Parameter | Type | +| ------ | ------ | +| `eventMap` | `EventMap` | +| `context`? | `any` | + +##### Returns + +`this` + +##### Inherited from + +`Renderer.once` + +##### Defined in + +node\_modules/typedoc/dist/lib/utils/events.d.ts:89 + +#### once(name, callback, context, priority) + +> **once**(`name`, `callback`, `context`?, `priority`?): `this` + +##### Parameters + +| Parameter | Type | +| ------ | ------ | +| `name` | `string` | +| `callback` | `EventCallback` | +| `context`? | `any` | +| `priority`? | `any` | + +##### Returns + +`this` + +##### Inherited from + +`Renderer.once` + +##### Defined in + +node\_modules/typedoc/dist/lib/utils/events.d.ts:90 + +*** + +### off() + +#### off(undefined) + +> **off**(): `this` + +Remove one or many callbacks. If `context` is null, removes all +callbacks with that function. If `callback` is null, removes all +callbacks for the event. If `name` is null, removes all bound +callbacks for all events. + +##### Returns + +`this` + +##### Inherited from + +`Renderer.off` + +##### Defined in + +node\_modules/typedoc/dist/lib/utils/events.d.ts:97 + +#### off(eventMap, context) + +> **off**(`eventMap`, `context`?): `this` + +##### Parameters + +| Parameter | Type | +| ------ | ------ | +| `eventMap` | `undefined` \| `EventMap` | +| `context`? | `any` | + +##### Returns + +`this` + +##### Inherited from + +`Renderer.off` + +##### Defined in + +node\_modules/typedoc/dist/lib/utils/events.d.ts:98 + +#### off(name, callback, context) + +> **off**(`name`, `callback`?, `context`?): `this` + +##### Parameters + +| Parameter | Type | +| ------ | ------ | +| `name` | `undefined` \| `string` | +| `callback`? | `EventCallback` | +| `context`? | `any` | + +##### Returns + +`this` + +##### Inherited from + +`Renderer.off` + +##### Defined in + +node\_modules/typedoc/dist/lib/utils/events.d.ts:99 + +*** + +### listenTo() + +> **listenTo**(`obj`, `name`, `callback`?, `priority`?): `this` + +Inversion-of-control versions of `on`. Tell *this* object to listen to +an event in another object... keeping track of what it's listening to +for easier unbinding later. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `obj` | `EventDispatcher` | +| `name` | `string` \| `EventMap` | +| `callback`? | `EventCallback` | +| `priority`? | `number` | + +#### Returns + +`this` + +#### Inherited from + +`Renderer.listenTo` + +#### Defined in + +node\_modules/typedoc/dist/lib/utils/events.d.ts:105 + +*** + +### listenToOnce() + +#### listenToOnce(obj, eventMap) + +> **listenToOnce**(`obj`, `eventMap`): `this` + +Inversion-of-control versions of `once`. + +##### Parameters + +| Parameter | Type | +| ------ | ------ | +| `obj` | `EventDispatcher` | +| `eventMap` | `EventMap` | + +##### Returns + +`this` + +##### Inherited from + +`Renderer.listenToOnce` + +##### Defined in + +node\_modules/typedoc/dist/lib/utils/events.d.ts:109 + +#### listenToOnce(obj, name, callback, priority) + +> **listenToOnce**(`obj`, `name`, `callback`, `priority`?): `this` + +##### Parameters + +| Parameter | Type | +| ------ | ------ | +| `obj` | `EventDispatcher` | +| `name` | `string` | +| `callback` | `EventCallback` | +| `priority`? | `number` | + +##### Returns + +`this` + +##### Inherited from + +`Renderer.listenToOnce` + +##### Defined in + +node\_modules/typedoc/dist/lib/utils/events.d.ts:110 + +*** + +### stopListening() + +> **stopListening**(`obj`?, `name`?, `callback`?): `this` + +Tell this object to stop listening to either specific events ... or +to every object it's currently listening to. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `obj`? | `EventDispatcher` | +| `name`? | `string` \| `EventMap` | +| `callback`? | `EventCallback` | + +#### Returns + +`this` + +#### Inherited from + +`Renderer.stopListening` + +#### Defined in + +node\_modules/typedoc/dist/lib/utils/events.d.ts:115 + +*** + +### trigger() + +> **trigger**(`name`, ...`args`): `this` + +Trigger one or many events, firing all bound callbacks. Callbacks are +passed the same arguments as `trigger` is, apart from the event name +(unless you're listening on `"all"`, which will cause your callback to +receive the true name of the event as the first argument). + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `name` | `string` \| `EventMap` \| [`Event`](https://typedoc.org/api/classes/Event.html) | +| ...`args` | `any`[] | + +#### Returns + +`this` + +#### Inherited from + +`Renderer.trigger` + +#### Defined in + +node\_modules/typedoc/dist/lib/utils/events.d.ts:122 diff --git a/developer-docs/typedoc-plugin-markdown/app/namespaces/types/interfaces/MarkdownRendererHooks.md b/developer-docs/typedoc-plugin-markdown/app/namespaces/types/interfaces/MarkdownRendererHooks.md new file mode 100644 index 000000000..e5c3d58af --- /dev/null +++ b/developer-docs/typedoc-plugin-markdown/app/namespaces/types/interfaces/MarkdownRendererHooks.md @@ -0,0 +1,110 @@ +[Packages Index](../../../../../README.md) / [typedoc-plugin-markdown](../../../../README.md) / [app](../../../README.md) / [types](../README.md) / MarkdownRendererHooks + +# Interface: MarkdownRendererHooks + +Describes the hooks available to inject output in the markdown theme. + +## Example + +```ts + app.renderer.markdownHooks.on( + 'page.end', + () => `**Generated using \`page.end\` hook**`, +); +``` + +## Hooks + +### page.begin + +> **page.begin**: [[`MarkdownThemeContext`](../../../../theme/classes/MarkdownThemeContext.md)] + +Applied at the start of the markdown output. + +#### Defined in + +[packages/typedoc-plugin-markdown/src/app/types/markdown-renderer-hooks.ts:22](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/app/types/markdown-renderer-hooks.ts#L22) + +*** + +### page.end + +> **page.end**: [[`MarkdownThemeContext`](../../../../theme/classes/MarkdownThemeContext.md)] + +Applied at the end of the markdown output. + +#### Defined in + +[packages/typedoc-plugin-markdown/src/app/types/markdown-renderer-hooks.ts:29](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/app/types/markdown-renderer-hooks.ts#L29) + +*** + +### content.begin + +> **content.begin**: [[`MarkdownThemeContext`](../../../../theme/classes/MarkdownThemeContext.md)] + +Applied before the main markdown content is rendered. + +#### Defined in + +[packages/typedoc-plugin-markdown/src/app/types/markdown-renderer-hooks.ts:36](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/app/types/markdown-renderer-hooks.ts#L36) + +*** + +### index.page.begin + +> **index.page.begin**: [[`MarkdownThemeContext`](../../../../theme/classes/MarkdownThemeContext.md)] + +Applied at the start of the markdown output on the index page. + +#### Defined in + +[packages/typedoc-plugin-markdown/src/app/types/markdown-renderer-hooks.ts:43](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/app/types/markdown-renderer-hooks.ts#L43) + +*** + +### index.content.begin + +> **index.content.begin**: [[`MarkdownThemeContext`](../../../../theme/classes/MarkdownThemeContext.md)] + +Applied before the main markdown content is rendered on the index page. + +#### Defined in + +[packages/typedoc-plugin-markdown/src/app/types/markdown-renderer-hooks.ts:50](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/app/types/markdown-renderer-hooks.ts#L50) + +*** + +### packages.page.begin + +> **packages.page.begin**: [[`MarkdownThemeContext`](../../../../theme/classes/MarkdownThemeContext.md)] + +Applied at the start of the markdown output on the packages root page. + +#### Defined in + +[packages/typedoc-plugin-markdown/src/app/types/markdown-renderer-hooks.ts:57](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/app/types/markdown-renderer-hooks.ts#L57) + +*** + +### packages.content.begin + +> **packages.content.begin**: [[`MarkdownThemeContext`](../../../../theme/classes/MarkdownThemeContext.md)] + +Applied before the main markdown content is rendered on the packages root page. + +#### Defined in + +[packages/typedoc-plugin-markdown/src/app/types/markdown-renderer-hooks.ts:64](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/app/types/markdown-renderer-hooks.ts#L64) + +*** + +### index.page.end + +> **index.page.end**: [[`MarkdownThemeContext`](../../../../theme/classes/MarkdownThemeContext.md)] + +Applied at the end of the markdown output on the index page. + +#### Defined in + +[packages/typedoc-plugin-markdown/src/app/types/markdown-renderer-hooks.ts:71](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/app/types/markdown-renderer-hooks.ts#L71) diff --git a/developer-docs/typedoc-plugin-markdown/internationalization/README.md b/developer-docs/typedoc-plugin-markdown/internationalization/README.md new file mode 100644 index 000000000..e7e3c59cc --- /dev/null +++ b/developer-docs/typedoc-plugin-markdown/internationalization/README.md @@ -0,0 +1,15 @@ +[Packages Index](../../README.md) / [typedoc-plugin-markdown](../README.md) / internationalization + +# internationalization + +Exposes additional i18n keys and translations used by the theme. + +## Index + +### Namespaces + +| Namespace | Description | +| ------ | ------ | +| [locales](namespaces/locales/README.md) | List of plugin specific translations per locale. | +| [translatable](namespaces/translatable/README.md) | Translations methods. | +| [types](namespaces/types/README.md) | Internationalization types. | diff --git a/developer-docs/typedoc-plugin-markdown/internationalization/namespaces/locales/README.md b/developer-docs/typedoc-plugin-markdown/internationalization/namespaces/locales/README.md new file mode 100644 index 000000000..5d49f9f86 --- /dev/null +++ b/developer-docs/typedoc-plugin-markdown/internationalization/namespaces/locales/README.md @@ -0,0 +1,25 @@ +[Packages Index](../../../../README.md) / [typedoc-plugin-markdown](../../../README.md) / [internationalization](../../README.md) / locales + +# locales + +List of plugin specific translations per locale. + +## Variables + +### en + +> `const` **en**: [`TranslatableStrings`](../types/interfaces/TranslatableStrings.md) + +#### Defined in + +[packages/typedoc-plugin-markdown/src/internationalization/locales/en.ts:3](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/internationalization/locales/en.ts#L3) + +*** + +### ko + +> `const` **ko**: `Partial`\<[`TranslatableStrings`](../types/interfaces/TranslatableStrings.md)\> + +#### Defined in + +[packages/typedoc-plugin-markdown/src/internationalization/locales/ko.ts:3](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/internationalization/locales/ko.ts#L3) diff --git a/developer-docs/typedoc-plugin-markdown/internationalization/namespaces/translatable/README.md b/developer-docs/typedoc-plugin-markdown/internationalization/namespaces/translatable/README.md new file mode 100644 index 000000000..24fcafa23 --- /dev/null +++ b/developer-docs/typedoc-plugin-markdown/internationalization/namespaces/translatable/README.md @@ -0,0 +1,29 @@ +[Packages Index](../../../../README.md) / [typedoc-plugin-markdown](../../../README.md) / [internationalization](../../README.md) / translatable + +# translatable + +Translations methods. + +## Functions + +### getTranslatable() + +> **getTranslatable**(`app`): `any` + +Returns subset of translatable strings for the plugin. + +These will then be merged with the main set of TypeDoc string. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `app` | [`Application`](https://typedoc.org/api/classes/Application.html) | + +#### Returns + +`any` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/internationalization/translatable.ts:14](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/internationalization/translatable.ts#L14) diff --git a/developer-docs/typedoc-plugin-markdown/internationalization/namespaces/types/README.md b/developer-docs/typedoc-plugin-markdown/internationalization/namespaces/types/README.md new file mode 100644 index 000000000..f1d4aa086 --- /dev/null +++ b/developer-docs/typedoc-plugin-markdown/internationalization/namespaces/types/README.md @@ -0,0 +1,13 @@ +[Packages Index](../../../../README.md) / [typedoc-plugin-markdown](../../../README.md) / [internationalization](../../README.md) / types + +# types + +Internationalization types. + +## Index + +### Interfaces + +| Interface | Description | +| ------ | ------ | +| [TranslatableStrings](interfaces/TranslatableStrings.md) | The model of translatable strings specific to the Markdown theme. | diff --git a/packages/typedoc-plugin-markdown/developer-docs/internationalization/namespaces/types/interfaces/TranslatableStrings.md b/developer-docs/typedoc-plugin-markdown/internationalization/namespaces/types/interfaces/TranslatableStrings.md similarity index 67% rename from packages/typedoc-plugin-markdown/developer-docs/internationalization/namespaces/types/interfaces/TranslatableStrings.md rename to developer-docs/typedoc-plugin-markdown/internationalization/namespaces/types/interfaces/TranslatableStrings.md index 1d11ccd2d..ebf7a2825 100644 --- a/packages/typedoc-plugin-markdown/developer-docs/internationalization/namespaces/types/interfaces/TranslatableStrings.md +++ b/developer-docs/typedoc-plugin-markdown/internationalization/namespaces/types/interfaces/TranslatableStrings.md @@ -1,177 +1,145 @@ -[typedoc-plugin-markdown v4.0.3](../../../../README.md) / [internationalization](../../../README.md) / [types](../README.md) / TranslatableStrings +[Packages Index](../../../../../README.md) / [typedoc-plugin-markdown](../../../../README.md) / [internationalization](../../../README.md) / [types](../README.md) / TranslatableStrings # Interface: TranslatableStrings The model of translatable strings specific to the Markdown theme. -## Table of Contents - -* [Properties](#properties) - ## Properties ### theme\_default\_value -```ts -theme_default_value: string; -``` +> **theme\_default\_value**: `string` #### Defined in -[packages/typedoc-plugin-markdown/src/internationalization/types.ts:11](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/internationalization/types.ts#L11) +[packages/typedoc-plugin-markdown/src/internationalization/types.ts:11](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/internationalization/types.ts#L11) *** ### theme\_default\_type -```ts -theme_default_type: string; -``` +> **theme\_default\_type**: `string` #### Defined in -[packages/typedoc-plugin-markdown/src/internationalization/types.ts:12](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/internationalization/types.ts#L12) +[packages/typedoc-plugin-markdown/src/internationalization/types.ts:12](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/internationalization/types.ts#L12) *** ### theme\_description -```ts -theme_description: string; -``` +> **theme\_description**: `string` #### Defined in -[packages/typedoc-plugin-markdown/src/internationalization/types.ts:13](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/internationalization/types.ts#L13) +[packages/typedoc-plugin-markdown/src/internationalization/types.ts:13](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/internationalization/types.ts#L13) *** ### theme\_event -```ts -theme_event: string; -``` +> **theme\_event**: `string` #### Defined in -[packages/typedoc-plugin-markdown/src/internationalization/types.ts:14](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/internationalization/types.ts#L14) +[packages/typedoc-plugin-markdown/src/internationalization/types.ts:14](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/internationalization/types.ts#L14) *** ### theme\_extends -```ts -theme_extends: string; -``` +> **theme\_extends**: `string` #### Defined in -[packages/typedoc-plugin-markdown/src/internationalization/types.ts:15](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/internationalization/types.ts#L15) +[packages/typedoc-plugin-markdown/src/internationalization/types.ts:15](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/internationalization/types.ts#L15) *** ### theme\_extended\_by -```ts -theme_extended_by: string; -``` +> **theme\_extended\_by**: `string` #### Defined in -[packages/typedoc-plugin-markdown/src/internationalization/types.ts:16](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/internationalization/types.ts#L16) +[packages/typedoc-plugin-markdown/src/internationalization/types.ts:16](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/internationalization/types.ts#L16) *** ### theme\_member -```ts -theme_member: string; -``` +> **theme\_member**: `string` #### Defined in -[packages/typedoc-plugin-markdown/src/internationalization/types.ts:17](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/internationalization/types.ts#L17) +[packages/typedoc-plugin-markdown/src/internationalization/types.ts:17](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/internationalization/types.ts#L17) *** ### theme\_member\_plural -```ts -theme_member_plural: string; -``` +> **theme\_member\_plural**: `string` #### Defined in -[packages/typedoc-plugin-markdown/src/internationalization/types.ts:18](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/internationalization/types.ts#L18) +[packages/typedoc-plugin-markdown/src/internationalization/types.ts:18](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/internationalization/types.ts#L18) *** ### theme\_modifier -```ts -theme_modifier: string; -``` +> **theme\_modifier**: `string` #### Defined in -[packages/typedoc-plugin-markdown/src/internationalization/types.ts:19](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/internationalization/types.ts#L19) +[packages/typedoc-plugin-markdown/src/internationalization/types.ts:19](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/internationalization/types.ts#L19) *** ### theme\_name -```ts -theme_name: string; -``` +> **theme\_name**: `string` #### Defined in -[packages/typedoc-plugin-markdown/src/internationalization/types.ts:20](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/internationalization/types.ts#L20) +[packages/typedoc-plugin-markdown/src/internationalization/types.ts:20](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/internationalization/types.ts#L20) *** ### theme\_packages -```ts -theme_packages: string; -``` +> **theme\_packages**: `string` #### Defined in -[packages/typedoc-plugin-markdown/src/internationalization/types.ts:21](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/internationalization/types.ts#L21) +[packages/typedoc-plugin-markdown/src/internationalization/types.ts:21](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/internationalization/types.ts#L21) *** ### theme\_type -```ts -theme_type: string; -``` +> **theme\_type**: `string` #### Defined in -[packages/typedoc-plugin-markdown/src/internationalization/types.ts:22](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/internationalization/types.ts#L22) +[packages/typedoc-plugin-markdown/src/internationalization/types.ts:22](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/internationalization/types.ts#L22) *** ### theme\_value -```ts -theme_value: string; -``` +> **theme\_value**: `string` #### Defined in -[packages/typedoc-plugin-markdown/src/internationalization/types.ts:23](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/internationalization/types.ts#L23) +[packages/typedoc-plugin-markdown/src/internationalization/types.ts:23](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/internationalization/types.ts#L23) *** ### theme\_version -```ts -theme_version: string; -``` +> **theme\_version**: `string` #### Defined in -[packages/typedoc-plugin-markdown/src/internationalization/types.ts:24](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/internationalization/types.ts#L24) +[packages/typedoc-plugin-markdown/src/internationalization/types.ts:24](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/internationalization/types.ts#L24) diff --git a/developer-docs/typedoc-plugin-markdown/libs/README.md b/developer-docs/typedoc-plugin-markdown/libs/README.md new file mode 100644 index 000000000..c862498cd --- /dev/null +++ b/developer-docs/typedoc-plugin-markdown/libs/README.md @@ -0,0 +1,14 @@ +[Packages Index](../../README.md) / [typedoc-plugin-markdown](../README.md) / libs + +# libs + +General pure library functions to be consumed across the plugin. + +## Index + +### Namespaces + +| Namespace | Description | +| ------ | ------ | +| [markdown](namespaces/markdown/README.md) | Helpers to render markdown elements. | +| [utils](namespaces/utils/README.md) | General utility pure functions. | diff --git a/developer-docs/typedoc-plugin-markdown/libs/namespaces/markdown/README.md b/developer-docs/typedoc-plugin-markdown/libs/namespaces/markdown/README.md new file mode 100644 index 000000000..3a57fbab9 --- /dev/null +++ b/developer-docs/typedoc-plugin-markdown/libs/namespaces/markdown/README.md @@ -0,0 +1,274 @@ +[Packages Index](../../../../README.md) / [typedoc-plugin-markdown](../../../README.md) / [libs](../../README.md) / markdown + +# markdown + +Helpers to render markdown elements. + +## Functions + +### backTicks() + +> **backTicks**(`text`): `string` + +Wraps a string in backticks. +If the input string itself contains a backtick, pipe, or backslash (which can result in unwanted side effects) the string is escaped instead. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `text` | `string` | + +#### Returns + +`string` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/libs/markdown/back-ticks.ts:7](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/libs/markdown/back-ticks.ts#L7) + +*** + +### blockQuoteBlock() + +> **blockQuoteBlock**(`content`): `string` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `content` | `string` | + +#### Returns + +`string` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/libs/markdown/block-quote-block.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/libs/markdown/block-quote-block.ts#L1) + +*** + +### bold() + +> **bold**(`text`): `string` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `text` | `string` | + +#### Returns + +`string` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/libs/markdown/bold.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/libs/markdown/bold.ts#L1) + +*** + +### codeBlock() + +> **codeBlock**(`content`): `string` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `content` | `string` | + +#### Returns + +`string` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/libs/markdown/code-block.ts:3](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/libs/markdown/code-block.ts#L3) + +*** + +### heading() + +> **heading**(`level`, `text`): `string` + +Returns a heading in markdown format + +#### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `level` | `number` | The level of the heading | +| `text` | `string` | The text of the heading | + +#### Returns + +`string` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/libs/markdown/heading.ts:6](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/libs/markdown/heading.ts#L6) + +*** + +### horizontalRule() + +> **horizontalRule**(): `string` + +#### Returns + +`string` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/libs/markdown/horizontal-rule.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/libs/markdown/horizontal-rule.ts#L1) + +*** + +### htmlTable() + +> **htmlTable**(`headers`, `rows`, `leftAlignHeadings`): `string` + +#### Parameters + +| Parameter | Type | Default value | +| ------ | ------ | ------ | +| `headers` | `string`[] | `undefined` | +| `rows` | `string`[][] | `undefined` | +| `leftAlignHeadings` | `boolean` | `false` | + +#### Returns + +`string` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/libs/markdown/html-table.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/libs/markdown/html-table.ts#L1) + +*** + +### indentBlock() + +> **indentBlock**(`content`): `string` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `content` | `string` | + +#### Returns + +`string` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/libs/markdown/indent-block.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/libs/markdown/indent-block.ts#L1) + +*** + +### italic() + +> **italic**(`text`): `string` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `text` | `string` | + +#### Returns + +`string` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/libs/markdown/italic.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/libs/markdown/italic.ts#L1) + +*** + +### link() + +> **link**(`label`, `url`): `string` + +The link element + +#### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `label` | `string` | The text to display for the link | +| `url` | `null` \| `string` | The url to link to | + +#### Returns + +`string` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/libs/markdown/link.ts:6](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/libs/markdown/link.ts#L6) + +*** + +### strikeThrough() + +> **strikeThrough**(`content`): `string` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `content` | `string` | + +#### Returns + +`string` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/libs/markdown/strike-through.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/libs/markdown/strike-through.ts#L1) + +*** + +### table() + +> **table**(`headers`, `rows`, `headerLeftAlign`): `string` + +Comments for table + +#### Parameters + +| Parameter | Type | Default value | +| ------ | ------ | ------ | +| `headers` | `string`[] | `undefined` | +| `rows` | `string`[][] | `undefined` | +| `headerLeftAlign` | `boolean` | `false` | + +#### Returns + +`string` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/libs/markdown/table.ts:7](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/libs/markdown/table.ts#L7) + +*** + +### unorderedList() + +> **unorderedList**(`items`): `string` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `items` | `string`[] | + +#### Returns + +`string` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/libs/markdown/unordered-list.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/libs/markdown/unordered-list.ts#L1) diff --git a/developer-docs/typedoc-plugin-markdown/libs/namespaces/utils/README.md b/developer-docs/typedoc-plugin-markdown/libs/namespaces/utils/README.md new file mode 100644 index 000000000..5a5156a02 --- /dev/null +++ b/developer-docs/typedoc-plugin-markdown/libs/namespaces/utils/README.md @@ -0,0 +1,272 @@ +[Packages Index](../../../../README.md) / [typedoc-plugin-markdown](../../../README.md) / [libs](../../README.md) / utils + +# utils + +General utility pure functions. + +## Functions + +### camelToTitleCase() + +> **camelToTitleCase**(`text`): `string` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `text` | `string` | + +#### Returns + +`string` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/libs/utils/camel-to-title-case.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/libs/utils/camel-to-title-case.ts#L1) + +*** + +### escapeChars() + +> **escapeChars**(`str`): `string` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `str` | `string` | + +#### Returns + +`string` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/libs/utils/escape-chars.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/libs/utils/escape-chars.ts#L1) + +*** + +### formatMarkdown() + +> **formatMarkdown**(`str`): `string` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `str` | `string` | + +#### Returns + +`string` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/libs/utils/format-markdown.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/libs/utils/format-markdown.ts#L1) + +*** + +### formatTableCell() + +> **formatTableCell**(`str`): `string` + +- Replace new lines with spaces +- Replaces code blocks with single backticks +- Replaces multiple spaces with single spaces + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `str` | `string` | + +#### Returns + +`string` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/libs/utils/format-table-cell.ts:6](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/libs/utils/format-table-cell.ts#L6) + +*** + +### getFileNameWithExtension() + +> **getFileNameWithExtension**(`fileName`, `fileExtension`): `string` + +Returns a filename with extension while normalizing both the input name and input extension. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `fileName` | `string` | +| `fileExtension` | `string` | + +#### Returns + +`string` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/libs/utils/get-file-name-with-extension.ts:6](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/libs/utils/get-file-name-with-extension.ts#L6) + +*** + +### isQuoted() + +> **isQuoted**(`str`): `boolean` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `str` | `string` | + +#### Returns + +`boolean` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/libs/utils/is-quoted.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/libs/utils/is-quoted.ts#L1) + +*** + +### normalizeLineBreaks() + +> **normalizeLineBreaks**(`str`): `string` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `str` | `string` | + +#### Returns + +`string` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/libs/utils/normalize-line-breaks.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/libs/utils/normalize-line-breaks.ts#L1) + +*** + +### removeFirstScopedDirectory() + +> **removeFirstScopedDirectory**(`urlString`): `string` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `urlString` | `string` | + +#### Returns + +`string` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/libs/utils/remove-first-scoped-directory.ts:3](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/libs/utils/remove-first-scoped-directory.ts#L3) + +*** + +### removeLineBreaks() + +> **removeLineBreaks**(`str`): `string` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `str` | `string` | + +#### Returns + +`string` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/libs/utils/remove-line-breaks.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/libs/utils/remove-line-breaks.ts#L1) + +*** + +### sanitizeComments() + +> **sanitizeComments**(`str`): `string` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `str` | `string` | + +#### Returns + +`string` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/libs/utils/sanitize-comments.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/libs/utils/sanitize-comments.ts#L1) + +*** + +### slugify() + +> **slugify**(`url`): `string` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `url` | `string` | + +#### Returns + +`string` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/libs/utils/slugify.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/libs/utils/slugify.ts#L1) + +*** + +### toPascalCase() + +> **toPascalCase**(`text`): `string` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `text` | `string` | + +#### Returns + +`string` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/libs/utils/to-pascal-case.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/libs/utils/to-pascal-case.ts#L1) + +*** + +### unEscapeChars() + +> **unEscapeChars**(`str`): `string` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `str` | `string` | + +#### Returns + +`string` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/libs/utils/un-escape-chars.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/libs/utils/un-escape-chars.ts#L1) diff --git a/developer-docs/typedoc-plugin-markdown/options/README.md b/developer-docs/typedoc-plugin-markdown/options/README.md new file mode 100644 index 000000000..fd793fc5b --- /dev/null +++ b/developer-docs/typedoc-plugin-markdown/options/README.md @@ -0,0 +1,16 @@ +[Packages Index](../../README.md) / [typedoc-plugin-markdown](../README.md) / options + +# options + +Configures plugin options. + +## Index + +### Namespaces + +| Namespace | Description | +| ------ | ------ | +| [constants](namespaces/constants/README.md) | Contains constant default values used in options. | +| [declarations](namespaces/declarations/README.md) | Typedoc options declarations. Each exported variable will be added to the TypeDoc options and also the public documentation. | +| [maps](namespaces/maps/README.md) | Maps a given value to the option type. | +| [types](namespaces/types/README.md) | Describes the options declared by the plugin. | diff --git a/developer-docs/typedoc-plugin-markdown/options/namespaces/constants/README.md b/developer-docs/typedoc-plugin-markdown/options/namespaces/constants/README.md new file mode 100644 index 000000000..0e694efb5 --- /dev/null +++ b/developer-docs/typedoc-plugin-markdown/options/namespaces/constants/README.md @@ -0,0 +1,40 @@ +[Packages Index](../../../../README.md) / [typedoc-plugin-markdown](../../../README.md) / [options](../../README.md) / constants + +# constants + +Contains constant default values used in options. + +## Variables + +### ALLOWED\_OWN\_FILE\_MEMBERS + +> `const` **ALLOWED\_OWN\_FILE\_MEMBERS**: `string`[] + +Default values for `membersWithOwnFile` option. + +#### Defined in + +[packages/typedoc-plugin-markdown/src/options/constants.ts:12](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/options/constants.ts#L12) + +*** + +### TEXT\_CONTENT\_MAPPINGS + +> `const` **TEXT\_CONTENT\_MAPPINGS**: \{`header.title`: `string`;`header.docs`: `string`;`breadcrumbs.home`: `string`;`title.indexPage`: `string`;`title.memberPage`: `string`;`footer.text`: `string`; \} + +Default values for `textContentMappings` option. + +#### Type declaration + +| Member | Type | Default value | +| ------ | ------ | ------ | +| `header.title` | `string` | '\{projectName\} \{version\}' | +| `header.docs` | `string` | 'Docs' | +| `breadcrumbs.home` | `string` | '\{projectName\} \{version\}' | +| `title.indexPage` | `string` | '\{projectName\} \{version\}' | +| `title.memberPage` | `string` | '\{kind\}: \{name\}' | +| `footer.text` | `string` | '' | + +#### Defined in + +[packages/typedoc-plugin-markdown/src/options/constants.ts:24](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/options/constants.ts#L24) diff --git a/packages/typedoc-plugin-markdown/developer-docs/options/namespaces/declarations/README.md b/developer-docs/typedoc-plugin-markdown/options/namespaces/declarations/README.md similarity index 50% rename from packages/typedoc-plugin-markdown/developer-docs/options/namespaces/declarations/README.md rename to developer-docs/typedoc-plugin-markdown/options/namespaces/declarations/README.md index 863de8606..e303e7684 100644 --- a/packages/typedoc-plugin-markdown/developer-docs/options/namespaces/declarations/README.md +++ b/developer-docs/typedoc-plugin-markdown/options/namespaces/declarations/README.md @@ -1,75 +1,45 @@ -[typedoc-plugin-markdown v4.0.3](../../../README.md) / [options](../../README.md) / declarations +[Packages Index](../../../../README.md) / [typedoc-plugin-markdown](../../../README.md) / [options](../../README.md) / declarations -# Namespace: declarations +# declarations Typedoc options declarations. Each exported variable will be added to the TypeDoc options and also the public documentation. -## Table of Contents - -* [Display Options](#display-options) -* [File Options](#file-options) -* [Utility Options](#utility-options) - ## Display Options ### hidePageHeader -```ts -const hidePageHeader: Partial = { - help: 'Do not print page header.', - type: ParameterType.Boolean, - defaultValue: false, -}; -``` +> `const` **hidePageHeader**: `Partial`\<[`DeclarationOption`](https://typedoc.org/api/classes/Models.DeclarationOption.html)\> #### Defined in -[packages/typedoc-plugin-markdown/src/options/declarations.ts:181](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/declarations.ts#L181) +[packages/typedoc-plugin-markdown/src/options/declarations.ts:181](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/options/declarations.ts#L181) *** ### hidePageTitle -```ts -const hidePageTitle: Partial = { - help: 'Do not print page title.', - type: ParameterType.Boolean, - defaultValue: false, -}; -``` +> `const` **hidePageTitle**: `Partial`\<[`DeclarationOption`](https://typedoc.org/api/classes/Models.DeclarationOption.html)\> #### Defined in -[packages/typedoc-plugin-markdown/src/options/declarations.ts:190](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/declarations.ts#L190) +[packages/typedoc-plugin-markdown/src/options/declarations.ts:190](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/options/declarations.ts#L190) *** ### hideBreadcrumbs -```ts -const hideBreadcrumbs: Partial = { - help: 'Do not print breadcrumbs.', - type: ParameterType.Boolean, - defaultValue: false, -}; -``` +> `const` **hideBreadcrumbs**: `Partial`\<[`DeclarationOption`](https://typedoc.org/api/classes/Models.DeclarationOption.html)\> #### Defined in -[packages/typedoc-plugin-markdown/src/options/declarations.ts:199](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/declarations.ts#L199) +[packages/typedoc-plugin-markdown/src/options/declarations.ts:199](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/options/declarations.ts#L199) *** ### hideGroupHeadings -```ts -const hideGroupHeadings: Partial = { - help: 'Excludes grouping by kind so all members are rendered and sorted at the same level.', - type: ParameterType.Boolean, - defaultValue: false, -}; -``` +> `const` **hideGroupHeadings**: `Partial`\<[`DeclarationOption`](https://typedoc.org/api/classes/Models.DeclarationOption.html)\> #### Remarks @@ -79,19 +49,13 @@ This creates a flat structure where all members are displayed at the same headin #### Defined in -[packages/typedoc-plugin-markdown/src/options/declarations.ts:214](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/declarations.ts#L214) +[packages/typedoc-plugin-markdown/src/options/declarations.ts:214](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/options/declarations.ts#L214) *** ### useCodeBlocks -```ts -const useCodeBlocks: Partial = { - help: 'Wraps signatures and declarations in code blocks.', - type: ParameterType.Boolean, - defaultValue: false, -}; -``` +> `const` **useCodeBlocks**: `Partial`\<[`DeclarationOption`](https://typedoc.org/api/classes/Models.DeclarationOption.html)\> #### Remarks @@ -103,19 +67,13 @@ As a work around the [`@link`](https://typedoc.org/tags/link/) tag can be be use #### Defined in -[packages/typedoc-plugin-markdown/src/options/declarations.ts:242](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/declarations.ts#L242) +[packages/typedoc-plugin-markdown/src/options/declarations.ts:242](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/options/declarations.ts#L242) *** ### expandObjects -```ts -const expandObjects: Partial = { - help: 'Expand objects inside declarations.', - type: ParameterType.Boolean, - defaultValue: false, -}; -``` +> `const` **expandObjects**: `Partial`\<[`DeclarationOption`](https://typedoc.org/api/classes/Models.DeclarationOption.html)\> #### Remarks @@ -125,19 +83,13 @@ This option should be set when a full object representation is preferred. #### Defined in -[packages/typedoc-plugin-markdown/src/options/declarations.ts:257](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/declarations.ts#L257) +[packages/typedoc-plugin-markdown/src/options/declarations.ts:257](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/options/declarations.ts#L257) *** ### expandParameters -```ts -const expandParameters: Partial = { - help: 'Expand parameters in signature parentheses to display type information.', - type: ParameterType.Boolean, - defaultValue: false, -}; -``` +> `const` **expandParameters**: `Partial`\<[`DeclarationOption`](https://typedoc.org/api/classes/Models.DeclarationOption.html)\> #### Remarks @@ -147,120 +99,85 @@ This option should be set when a full type representation is preferred. #### Defined in -[packages/typedoc-plugin-markdown/src/options/declarations.ts:272](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/declarations.ts#L272) +[packages/typedoc-plugin-markdown/src/options/declarations.ts:272](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/options/declarations.ts#L272) *** ### parametersFormat -```ts -const parametersFormat: Partial = { - help: 'Specify the render style of parameter and type parameter groups.', - type: ParameterType.Map, - map: ReflectionFormat, - defaultValue: ReflectionFormat.List, -}; -``` +> `const` **parametersFormat**: `Partial`\<[`DeclarationOption`](https://typedoc.org/api/classes/Models.DeclarationOption.html)\> #### Remarks This option specifies the output format for parameters and type parameters of functions and class methods: -* **"list"**: parameters are output as bullet points in a linear list, suitable for more detailed comments. -* **"table"**: parameters are output within a markdown table, condensed into a single paragraph. -* **"htmlTable"**: parameters are output in an HTML table, enabling block elements to render in tabular format +- **"list"**: parameters are output as bullet points in a linear list, suitable for more detailed comments. +- **"table"**: parameters are output within a markdown table, condensed into a single paragraph. +- **"htmlTable"**: parameters are output in an HTML table, enabling block elements to render in tabular format #### Defined in -[packages/typedoc-plugin-markdown/src/options/declarations.ts:289](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/declarations.ts#L289) +[packages/typedoc-plugin-markdown/src/options/declarations.ts:289](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/options/declarations.ts#L289) *** ### propertiesFormat -```ts -const propertiesFormat: Partial = { - help: 'Specify the render style of property groups for interfaces and classes.', - type: ParameterType.Map, - map: ReflectionFormat, - defaultValue: ReflectionFormat.List, -}; -``` +> `const` **propertiesFormat**: `Partial`\<[`DeclarationOption`](https://typedoc.org/api/classes/Models.DeclarationOption.html)\> #### Remarks This option specifies the output format for class and interface properties: -* **"list"**: properties are output in linear blocks with headings, suitable for more detailed comments. -* **"table"**: properties are output within a markdown table, condensed into a single paragraph. -* **"htmlTable"**: properties are output in an HTML table, enabling block elements to render in tabular format. +- **"list"**: properties are output in linear blocks with headings, suitable for more detailed comments. +- **"table"**: properties are output within a markdown table, condensed into a single paragraph. +- **"htmlTable"**: properties are output in an HTML table, enabling block elements to render in tabular format. #### Defined in -[packages/typedoc-plugin-markdown/src/options/declarations.ts:307](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/declarations.ts#L307) +[packages/typedoc-plugin-markdown/src/options/declarations.ts:307](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/options/declarations.ts#L307) *** ### enumMembersFormat -```ts -const enumMembersFormat: Partial = { - help: 'Specify the render style of enumeration members.', - type: ParameterType.Map, - map: ReflectionFormat, - defaultValue: ReflectionFormat.List, -}; -``` +> `const` **enumMembersFormat**: `Partial`\<[`DeclarationOption`](https://typedoc.org/api/classes/Models.DeclarationOption.html)\> #### Remarks This option specifies the output format for enumeration members: -* **"list"**: members are output in linear blocks with headings, suitable for more detailed comments. -* **"table"**: members are output within a markdown table, condensed into a single paragraph. -* **"htmlTable"**: members are output in an HTML table, enabling block elements to render in tabular format. +- **"list"**: members are output in linear blocks with headings, suitable for more detailed comments. +- **"table"**: members are output within a markdown table, condensed into a single paragraph. +- **"htmlTable"**: members are output in an HTML table, enabling block elements to render in tabular format. #### Defined in -[packages/typedoc-plugin-markdown/src/options/declarations.ts:325](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/declarations.ts#L325) +[packages/typedoc-plugin-markdown/src/options/declarations.ts:325](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/options/declarations.ts#L325) *** ### typeDeclarationFormat -```ts -const typeDeclarationFormat: Partial = { - help: 'Specify the render style for type declaration members.', - type: ParameterType.Map, - map: ReflectionFormat, - defaultValue: ReflectionFormat.List, -}; -``` +> `const` **typeDeclarationFormat**: `Partial`\<[`DeclarationOption`](https://typedoc.org/api/classes/Models.DeclarationOption.html)\> #### Remarks This option specifies the output format for type declaration: -* **"list"**: declarations are output in linear blocks with headings, suitable for more detailed comments. -* **"table"**: declarations are output within a markdown table, condensed into a single paragraph. -* **"htmlTable"**: declarations are output in an HTML table, enabling block elements to render in tabular format. +- **"list"**: declarations are output in linear blocks with headings, suitable for more detailed comments. +- **"table"**: declarations are output within a markdown table, condensed into a single paragraph. +- **"htmlTable"**: declarations are output in an HTML table, enabling block elements to render in tabular format. #### Defined in -[packages/typedoc-plugin-markdown/src/options/declarations.ts:343](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/declarations.ts#L343) +[packages/typedoc-plugin-markdown/src/options/declarations.ts:343](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/options/declarations.ts#L343) *** ### indexFormat -```ts -const indexFormat: Partial = { - help: 'Specify the render format for index items.', - type: ParameterType.Map, - map: IndexFormat, - defaultValue: IndexFormat.List, -}; -``` +> `const` **indexFormat**: `Partial`\<[`DeclarationOption`](https://typedoc.org/api/classes/Models.DeclarationOption.html)\> #### Remarks @@ -268,33 +185,19 @@ This option renders index items either as a simple unordered list or in a table. When table style is selected the following will be the behaviour: -* For a **members index**, a description column will be added to the table with the first paragraph of the comment summary. -* For a **packages index**, (when `--entryPointStrategy` equals `packages`), the package.json description will be displayed with an additional "Version" column (when `--includeVersion` equals true). -* For a **documents index** a description column will be added to the table printing the `description` frontmatter if present. +- For a **members index**, a description column will be added to the table with the first paragraph of the comment summary. +- For a **packages index**, (when `--entryPointStrategy` equals `packages`), the package.json description will be displayed with an additional "Version" column (when `--includeVersion` equals true). +- For a **documents index** a description column will be added to the table printing the `description` frontmatter if present. #### Defined in -[packages/typedoc-plugin-markdown/src/options/declarations.ts:363](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/declarations.ts#L363) +[packages/typedoc-plugin-markdown/src/options/declarations.ts:363](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/options/declarations.ts#L363) *** ### tableColumnSettings -```ts -const tableColumnSettings: Partial = { - help: 'Control header alignment and column visibility in tables.', - type: ParameterType.Flags, - defaults: { - hideDefaults: false, - hideInherited: false, - hideModifiers: false, - hideOverrides: false, - hideSources: false, - hideValues: false, - leftAlignHeaders: false, - }, -}; -``` +> `const` **tableColumnSettings**: `Partial`\<[`DeclarationOption`](https://typedoc.org/api/classes/Models.DeclarationOption.html)\> #### Remarks @@ -305,20 +208,13 @@ In addition you can control the alignment of the header text. #### Defined in -[packages/typedoc-plugin-markdown/src/options/declarations.ts:380](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/declarations.ts#L380) +[packages/typedoc-plugin-markdown/src/options/declarations.ts:380](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/options/declarations.ts#L380) ## File Options ### outputFileStrategy -```ts -const outputFileStrategy: Partial = { - help: 'Determines how output files are generated.', - type: ParameterType.Map, - map: OutputFileStrategy, - defaultValue: OutputFileStrategy.Members, -}; -``` +> `const` **outputFileStrategy**: `Partial`\<[`DeclarationOption`](https://typedoc.org/api/classes/Models.DeclarationOption.html)\> #### Remarks @@ -330,32 +226,18 @@ It is also possible to further refine what members are exported to individual fi The following keys are available: -* **"members":** generates an individual file for each exported module member. This is the standard behavior of the HTML theme and the default setting of the plugin. -* **"modules"**: generates a single file for every Module or Namespace where all members are hoisted to a single module file. This creates a flat navigation structure and reduces the amount of files generated. +- **"members":** generates an individual file for each exported module member. This is the standard behavior of the HTML theme and the default setting of the plugin. +- **"modules"**: generates a single file for every Module or Namespace where all members are hoisted to a single module file. This creates a flat navigation structure and reduces the amount of files generated. #### Defined in -[packages/typedoc-plugin-markdown/src/options/declarations.ts:27](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/declarations.ts#L27) +[packages/typedoc-plugin-markdown/src/options/declarations.ts:27](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/options/declarations.ts#L27) *** ### membersWithOwnFile -```ts -const membersWithOwnFile: Partial = { - help: 'Determines which members are exported to their own file when outputFileStrategy equals members.', - type: ParameterType.Array, - validate(values) { - const validValues = ALLOWED_OWN_FILE_MEMBERS; - for (const kind of values) { - if (!validValues.includes(kind)) { - throw new Error('${kind}' is an invalid value for 'membersWithOwnFile'. Must be one of: ${validValues.join(', ')}); - } - } - }, - defaultValue: ALLOWED_OWN_FILE_MEMBERS, -}; -``` +> `const` **membersWithOwnFile**: `Partial`\<[`DeclarationOption`](https://typedoc.org/api/classes/Models.DeclarationOption.html)\> #### Remarks @@ -371,19 +253,13 @@ Ignored when [`outputFileStrategy`](#outputfilestrategy) is equal to `"modules"` #### Defined in -[packages/typedoc-plugin-markdown/src/options/declarations.ts:45](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/declarations.ts#L45) +[packages/typedoc-plugin-markdown/src/options/declarations.ts:45](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/options/declarations.ts#L45) *** ### flattenOutputFiles -```ts -const flattenOutputFiles: Partial = { - help: 'Flatten output files to a single directory.', - type: ParameterType.Boolean, - defaultValue: false, -}; -``` +> `const` **flattenOutputFiles**: `Partial`\<[`DeclarationOption`](https://typedoc.org/api/classes/Models.DeclarationOption.html)\> #### Remarks @@ -391,24 +267,13 @@ By default output files are generated in a directory structure that mirrors the #### Defined in -[packages/typedoc-plugin-markdown/src/options/declarations.ts:70](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/declarations.ts#L70) +[packages/typedoc-plugin-markdown/src/options/declarations.ts:70](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/options/declarations.ts#L70) *** ### fileExtension -```ts -const fileExtension: Partial = { - help: 'Specify the file extension for generated output files.', - type: ParameterType.String, - defaultValue: '.md', - validate(value) { - if (!value.startsWith('.')) { - throw new Error('[typedoc-plugin-markdown] "fileExtension" must start with a period.'); - } - }, -}; -``` +> `const` **fileExtension**: `Partial`\<[`DeclarationOption`](https://typedoc.org/api/classes/Models.DeclarationOption.html)\> #### Remarks @@ -422,19 +287,13 @@ Typically markdown files are recognised by the `.md` or `.markdown` file extensi #### Defined in -[packages/typedoc-plugin-markdown/src/options/declarations.ts:85](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/declarations.ts#L85) +[packages/typedoc-plugin-markdown/src/options/declarations.ts:85](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/options/declarations.ts#L85) *** ### entryFileName -```ts -const entryFileName: Partial = { - help: 'The file name of the entry page.', - type: ParameterType.String, - defaultValue: 'README', -}; -``` +> `const` **entryFileName**: `Partial`\<[`DeclarationOption`](https://typedoc.org/api/classes/Models.DeclarationOption.html)\> #### Remarks @@ -456,18 +315,13 @@ The content of this file will be resolved in the following order: #### Defined in -[packages/typedoc-plugin-markdown/src/options/declarations.ts:116](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/declarations.ts#L116) +[packages/typedoc-plugin-markdown/src/options/declarations.ts:116](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/options/declarations.ts#L116) *** ### entryModule -```ts -const entryModule: Partial = { - help: 'The name of a module that should act as the root page for the documentation.', - type: ParameterType.String, -}; -``` +> `const` **entryModule**: `Partial`\<[`DeclarationOption`](https://typedoc.org/api/classes/Models.DeclarationOption.html)\> #### Remarks @@ -485,19 +339,13 @@ Please note a separate modules index page will not be generated, therefore would #### Defined in -[packages/typedoc-plugin-markdown/src/options/declarations.ts:135](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/declarations.ts#L135) +[packages/typedoc-plugin-markdown/src/options/declarations.ts:135](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/options/declarations.ts#L135) *** ### excludeScopesInPaths -```ts -const excludeScopesInPaths: Partial = { - help: 'Exclude writing @ scope directories in paths.', - type: ParameterType.Boolean, - defaultValue: false, -}; -``` +> `const` **excludeScopesInPaths**: `Partial`\<[`DeclarationOption`](https://typedoc.org/api/classes/Models.DeclarationOption.html)\> #### Remarks @@ -511,19 +359,13 @@ Ignored if `flattenOutputFiles` is set to `true`. #### Defined in -[packages/typedoc-plugin-markdown/src/options/declarations.ts:153](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/declarations.ts#L153) +[packages/typedoc-plugin-markdown/src/options/declarations.ts:153](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/options/declarations.ts#L153) *** ### mergeReadme -```ts -const mergeReadme: Partial = { - help: 'Merges the resolved readme into the project index page.', - type: ParameterType.Boolean, - defaultValue: false, -}; -``` +> `const` **mergeReadme**: `Partial`\<[`DeclarationOption`](https://typedoc.org/api/classes/Models.DeclarationOption.html)\> #### Remarks @@ -537,19 +379,13 @@ This option has no effect when [`readme`](https://typedoc.org/options/input/#rea #### Defined in -[packages/typedoc-plugin-markdown/src/options/declarations.ts:172](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/declarations.ts#L172) +[packages/typedoc-plugin-markdown/src/options/declarations.ts:172](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/options/declarations.ts#L172) ## Utility Options ### publicPath -```ts -const publicPath: Partial = { - help: 'Specify the base path for all urls.', - type: ParameterType.String, - defaultValue: undefined, -}; -``` +> `const` **publicPath**: `Partial`\<[`DeclarationOption`](https://typedoc.org/api/classes/Models.DeclarationOption.html)\> #### Remarks @@ -563,19 +399,13 @@ If undefined all urls will be relative. #### Defined in -[packages/typedoc-plugin-markdown/src/options/declarations.ts:403](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/declarations.ts#L403) +[packages/typedoc-plugin-markdown/src/options/declarations.ts:403](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/options/declarations.ts#L403) *** ### sanitizeComments -```ts -const sanitizeComments: Partial = { - help: 'Sanitize HTML and JSX inside JsDoc comments.', - type: ParameterType.Boolean, - defaultValue: false, -}; -``` +> `const` **sanitizeComments**: `Partial`\<[`DeclarationOption`](https://typedoc.org/api/classes/Models.DeclarationOption.html)\> #### Remarks @@ -587,25 +417,19 @@ This option will escape angle brackets `<` `>` and curly braces `{` `}` written This option would typically be used when source code comes from an external library exposing the following potential issues: -* Comments contain raw tags that should be interpreted as code examples. -* Comments contain invalid syntax that (in the case of MDX) will cause breaking parsing errors. -* Although most parsers use XSS filters, this option provides an additional layer of XSS security. +- Comments contain raw tags that should be interpreted as code examples. +- Comments contain invalid syntax that (in the case of MDX) will cause breaking parsing errors. +- Although most parsers use XSS filters, this option provides an additional layer of XSS security. #### Defined in -[packages/typedoc-plugin-markdown/src/options/declarations.ts:426](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/declarations.ts#L426) +[packages/typedoc-plugin-markdown/src/options/declarations.ts:426](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/options/declarations.ts#L426) *** ### anchorPrefix -```ts -const anchorPrefix: Partial = { - help: 'Custom anchor prefix when anchoring to in-page symbols.', - type: ParameterType.String, - defaultValue: undefined, -}; -``` +> `const` **anchorPrefix**: `Partial`\<[`DeclarationOption`](https://typedoc.org/api/classes/Models.DeclarationOption.html)\> #### Remarks @@ -619,42 +443,30 @@ This option should be used when parsers require a custom anchor prefix. #### Defined in -[packages/typedoc-plugin-markdown/src/options/declarations.ts:441](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/declarations.ts#L441) +[packages/typedoc-plugin-markdown/src/options/declarations.ts:441](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/options/declarations.ts#L441) *** ### useHTMLAnchors -```ts -const useHTMLAnchors: Partial = { - help: 'Add HTML named anchors to headings and table rows.', - type: ParameterType.Boolean, - defaultValue: false, -}; -``` +> `const` **useHTMLAnchors**: `Partial`\<[`DeclarationOption`](https://typedoc.org/api/classes/Models.DeclarationOption.html)\> #### Remarks This option should be used if there are issues with anchoring to symbols within a page. -* For markdown parsers that do not automatically assign header ids. -* When cross referencing symbols that are referenced in a table row. +- For markdown parsers that do not automatically assign header ids. +- When cross referencing symbols that are referenced in a table row. #### Defined in -[packages/typedoc-plugin-markdown/src/options/declarations.ts:457](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/declarations.ts#L457) +[packages/typedoc-plugin-markdown/src/options/declarations.ts:457](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/options/declarations.ts#L457) *** ### preserveAnchorCasing -```ts -const preserveAnchorCasing: Partial = { - help: 'Preserve anchor casing when generating link to symbols.', - type: ParameterType.Boolean, - defaultValue: false, -}; -``` +> `const` **preserveAnchorCasing**: `Partial`\<[`DeclarationOption`](https://typedoc.org/api/classes/Models.DeclarationOption.html)\> #### Remarks @@ -664,23 +476,13 @@ This option can be used for engines that require the preservation of anchor link #### Defined in -[packages/typedoc-plugin-markdown/src/options/declarations.ts:472](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/declarations.ts#L472) +[packages/typedoc-plugin-markdown/src/options/declarations.ts:472](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/options/declarations.ts#L472) *** ### navigationModel -```ts -const navigationModel: Partial = { - help: 'Configures how the navigation model will be generated.', - type: ParameterType.Flags, - defaults: { - excludeGroups: false, - excludeCategories: false, - excludeFolders: false, - }, -}; -``` +> `const` **navigationModel**: `Partial`\<[`DeclarationOption`](https://typedoc.org/api/classes/Models.DeclarationOption.html)\> #### Remarks @@ -691,9 +493,9 @@ The navigation model can be accessed by utilizing the `postRenderAsyncJobs` on t The navigation is returned as `JSON` and can be mapped to a custom structure and written to a file. -* `navigationModel.excludeGroups`: do not organise navigation by groups. -* `navigationModel.excludeCategories`: do not organise navigation by categories. -* `navigationModel.excludeFolders`: excludes unnecessary nesting with complex hierarchies. +- `navigationModel.excludeGroups`: do not organise navigation by groups. +- `navigationModel.excludeCategories`: do not organise navigation by categories. +- `navigationModel.excludeFolders`: excludes unnecessary nesting with complex hierarchies. ```ts filename="custom-plugin.ts" @@ -712,29 +514,13 @@ export function load(app: MarkdownApplication) { #### Defined in -[packages/typedoc-plugin-markdown/src/options/declarations.ts:510](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/declarations.ts#L510) +[packages/typedoc-plugin-markdown/src/options/declarations.ts:510](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/options/declarations.ts#L510) *** ### textContentMappings -```ts -const textContentMappings: Partial = { - help: 'Change specific text placeholders in the template.', - type: ParameterType.Object, - defaultValue: TEXT_CONTENT_MAPPINGS, - validate(value) { - if (!value || typeof value !== 'object') { - throw new Error('[typedoc-plugin-markdown] textContentMappings must be an object.'); - } - for (const val of Object.values(value)) { - if (typeof val !== 'string') { - throw new Error([typedoc-plugin-markdown] All values of textContentMappings must be strings.); - } - } - }, -}; -``` +> `const` **textContentMappings**: `Partial`\<[`DeclarationOption`](https://typedoc.org/api/classes/Models.DeclarationOption.html)\> #### Remarks @@ -743,12 +529,12 @@ page titles and page footer. Default values within curly braces {} indicates a placeholder of dynamic text. -* The `{projectName}` placeholder writes project's name . -* The `{kind}` writes the reflection kind of the page. -* The `{version}` placeholder writes package version (if includeVersion is `true`). +- The `{projectName}` placeholder writes project's name . +- The `{kind}` writes the reflection kind of the page. +- The `{version}` placeholder writes package version (if includeVersion is `true`). If you are looking for general localization support please see [localization](). #### Defined in -[packages/typedoc-plugin-markdown/src/options/declarations.ts:535](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/declarations.ts#L535) +[packages/typedoc-plugin-markdown/src/options/declarations.ts:535](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/options/declarations.ts#L535) diff --git a/developer-docs/typedoc-plugin-markdown/options/namespaces/maps/README.md b/developer-docs/typedoc-plugin-markdown/options/namespaces/maps/README.md new file mode 100644 index 000000000..7c6b33177 --- /dev/null +++ b/developer-docs/typedoc-plugin-markdown/options/namespaces/maps/README.md @@ -0,0 +1,15 @@ +[Packages Index](../../../../README.md) / [typedoc-plugin-markdown](../../../README.md) / [options](../../README.md) / maps + +# maps + +Maps a given value to the option type. + +## Index + +### Enumerations + +| Enumeration | Description | +| ------ | ------ | +| [OutputFileStrategy](enumerations/OutputFileStrategy.md) | The allowed values of the `--outputFileStrategy` option. | +| [ReflectionFormat](enumerations/ReflectionFormat.md) | The allowed values for formatting reflections. | +| [IndexFormat](enumerations/IndexFormat.md) | The allowed values for formatting indexes. | diff --git a/developer-docs/typedoc-plugin-markdown/options/namespaces/maps/enumerations/IndexFormat.md b/developer-docs/typedoc-plugin-markdown/options/namespaces/maps/enumerations/IndexFormat.md new file mode 100644 index 000000000..a09634f22 --- /dev/null +++ b/developer-docs/typedoc-plugin-markdown/options/namespaces/maps/enumerations/IndexFormat.md @@ -0,0 +1,12 @@ +[Packages Index](../../../../../README.md) / [typedoc-plugin-markdown](../../../../README.md) / [options](../../../README.md) / [maps](../README.md) / IndexFormat + +# Enumeration: IndexFormat + +The allowed values for formatting indexes. + +## Enumeration Members + +| Enumeration Member | Value | +| ------ | ------ | +| `List` | `"list"` | +| `Table` | `"table"` | diff --git a/developer-docs/typedoc-plugin-markdown/options/namespaces/maps/enumerations/OutputFileStrategy.md b/developer-docs/typedoc-plugin-markdown/options/namespaces/maps/enumerations/OutputFileStrategy.md new file mode 100644 index 000000000..80aac9a0b --- /dev/null +++ b/developer-docs/typedoc-plugin-markdown/options/namespaces/maps/enumerations/OutputFileStrategy.md @@ -0,0 +1,12 @@ +[Packages Index](../../../../../README.md) / [typedoc-plugin-markdown](../../../../README.md) / [options](../../../README.md) / [maps](../README.md) / OutputFileStrategy + +# Enumeration: OutputFileStrategy + +The allowed values of the `--outputFileStrategy` option. + +## Enumeration Members + +| Enumeration Member | Value | +| ------ | ------ | +| `Members` | `"members"` | +| `Modules` | `"modules"` | diff --git a/developer-docs/typedoc-plugin-markdown/options/namespaces/maps/enumerations/ReflectionFormat.md b/developer-docs/typedoc-plugin-markdown/options/namespaces/maps/enumerations/ReflectionFormat.md new file mode 100644 index 000000000..221bb3cfc --- /dev/null +++ b/developer-docs/typedoc-plugin-markdown/options/namespaces/maps/enumerations/ReflectionFormat.md @@ -0,0 +1,13 @@ +[Packages Index](../../../../../README.md) / [typedoc-plugin-markdown](../../../../README.md) / [options](../../../README.md) / [maps](../README.md) / ReflectionFormat + +# Enumeration: ReflectionFormat + +The allowed values for formatting reflections. + +## Enumeration Members + +| Enumeration Member | Value | +| ------ | ------ | +| `List` | `"list"` | +| `Table` | `"table"` | +| `HtmlTable` | `"htmlTable"` | diff --git a/developer-docs/typedoc-plugin-markdown/options/namespaces/types/README.md b/developer-docs/typedoc-plugin-markdown/options/namespaces/types/README.md new file mode 100644 index 000000000..93647f443 --- /dev/null +++ b/developer-docs/typedoc-plugin-markdown/options/namespaces/types/README.md @@ -0,0 +1,13 @@ +[Packages Index](../../../../README.md) / [typedoc-plugin-markdown](../../../README.md) / [options](../../README.md) / types + +# types + +Describes the options declared by the plugin. + +## Index + +### Interfaces + +| Interface | Description | +| ------ | ------ | +| [PluginOptions](interfaces/PluginOptions.md) | - | diff --git a/developer-docs/typedoc-plugin-markdown/options/namespaces/types/interfaces/PluginOptions.md b/developer-docs/typedoc-plugin-markdown/options/namespaces/types/interfaces/PluginOptions.md new file mode 100644 index 000000000..4fe77f073 --- /dev/null +++ b/developer-docs/typedoc-plugin-markdown/options/namespaces/types/interfaces/PluginOptions.md @@ -0,0 +1,378 @@ +[Packages Index](../../../../../README.md) / [typedoc-plugin-markdown](../../../../README.md) / [options](../../../README.md) / [types](../README.md) / PluginOptions + +# Interface: PluginOptions + +## Properties + +### anchorPrefix + +> **anchorPrefix**: `string` + +Custom anchor prefix when anchoring to in-page symbols. + +#### Defined in + +[packages/typedoc-plugin-markdown/src/options/types.ts:14](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/options/types.ts#L14) + +*** + +### entryFileName + +> **entryFileName**: `string` + +The file name of the entry page. + +#### Defined in + +[packages/typedoc-plugin-markdown/src/options/types.ts:19](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/options/types.ts#L19) + +*** + +### entryModule + +> **entryModule**: `string` + +The name of a module that should act as the root page for the documentation. + +#### Defined in + +[packages/typedoc-plugin-markdown/src/options/types.ts:24](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/options/types.ts#L24) + +*** + +### enumMembersFormat + +> **enumMembersFormat**: `"table"` \| `"list"` \| `"htmlTable"` + +Specify the render style of enumeration members. + +#### Defined in + +[packages/typedoc-plugin-markdown/src/options/types.ts:29](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/options/types.ts#L29) + +*** + +### ~~excludeGroups~~ + +> **excludeGroups**: `boolean` + +#### Deprecated + +This option has been renamed hideGroupHeadings to better reflect its purpose. + +#### Defined in + +[packages/typedoc-plugin-markdown/src/options/types.ts:34](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/options/types.ts#L34) + +*** + +### excludeScopesInPaths + +> **excludeScopesInPaths**: `boolean` + +Exclude writing @ scope directories in paths. + +#### Defined in + +[packages/typedoc-plugin-markdown/src/options/types.ts:39](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/options/types.ts#L39) + +*** + +### expandObjects + +> **expandObjects**: `boolean` + +Expand objects inside declarations. + +#### Defined in + +[packages/typedoc-plugin-markdown/src/options/types.ts:44](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/options/types.ts#L44) + +*** + +### expandParameters + +> **expandParameters**: `boolean` + +Expand parameters in signature parentheses to display type information. + +#### Defined in + +[packages/typedoc-plugin-markdown/src/options/types.ts:49](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/options/types.ts#L49) + +*** + +### fileExtension + +> **fileExtension**: `string` + +Specify the file extension for generated output files. + +#### Defined in + +[packages/typedoc-plugin-markdown/src/options/types.ts:54](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/options/types.ts#L54) + +*** + +### flattenOutputFiles + +> **flattenOutputFiles**: `boolean` + +Flatten output files to a single directory. + +#### Defined in + +[packages/typedoc-plugin-markdown/src/options/types.ts:59](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/options/types.ts#L59) + +*** + +### hideBreadcrumbs + +> **hideBreadcrumbs**: `boolean` + +Do not print breadcrumbs. + +#### Defined in + +[packages/typedoc-plugin-markdown/src/options/types.ts:64](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/options/types.ts#L64) + +*** + +### hideGroupHeadings + +> **hideGroupHeadings**: `boolean` + +Excludes grouping by kind so all members are rendered and sorted at the same level. + +#### Defined in + +[packages/typedoc-plugin-markdown/src/options/types.ts:69](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/options/types.ts#L69) + +*** + +### hidePageHeader + +> **hidePageHeader**: `boolean` + +Do not print page header. + +#### Defined in + +[packages/typedoc-plugin-markdown/src/options/types.ts:74](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/options/types.ts#L74) + +*** + +### hidePageTitle + +> **hidePageTitle**: `boolean` + +Do not print page title. + +#### Defined in + +[packages/typedoc-plugin-markdown/src/options/types.ts:79](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/options/types.ts#L79) + +*** + +### indexFormat + +> **indexFormat**: `"table"` \| `"list"` + +Specify the render format for index items. + +#### Defined in + +[packages/typedoc-plugin-markdown/src/options/types.ts:84](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/options/types.ts#L84) + +*** + +### membersWithOwnFile + +> **membersWithOwnFile**: (`"Enum"` \| `"Variable"` \| `"Function"` \| `"Class"` \| `"Interface"` \| `"TypeAlias"`)[] + +Determines which members are exported to their own file when `outputFileStrategy` equals `members`. + +#### Defined in + +[packages/typedoc-plugin-markdown/src/options/types.ts:89](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/options/types.ts#L89) + +*** + +### mergeReadme + +> **mergeReadme**: `boolean` + +Merges the resolved readme into the project index page. + +#### Defined in + +[packages/typedoc-plugin-markdown/src/options/types.ts:101](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/options/types.ts#L101) + +*** + +### navigationModel + +> **navigationModel**: \{`excludeGroups`: `boolean`;`excludeCategories`: `boolean`;`excludeFolders`: `boolean`; \} + +Configures how the navigation model will be generated. + +| Member | Type | +| ------ | ------ | +| `excludeGroups` | `boolean` | +| `excludeCategories` | `boolean` | +| `excludeFolders` | `boolean` | + +#### Defined in + +[packages/typedoc-plugin-markdown/src/options/types.ts:106](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/options/types.ts#L106) + +*** + +### outputFileStrategy + +> **outputFileStrategy**: `"members"` \| `"modules"` + +Determines how output files are generated. + +#### Defined in + +[packages/typedoc-plugin-markdown/src/options/types.ts:115](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/options/types.ts#L115) + +*** + +### parametersFormat + +> **parametersFormat**: `"table"` \| `"list"` \| `"htmlTable"` + +Specify the render style of parameter and type parameter groups. + +#### Defined in + +[packages/typedoc-plugin-markdown/src/options/types.ts:120](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/options/types.ts#L120) + +*** + +### preserveAnchorCasing + +> **preserveAnchorCasing**: `boolean` + +Preserve anchor casing when generating link to symbols. + +#### Defined in + +[packages/typedoc-plugin-markdown/src/options/types.ts:125](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/options/types.ts#L125) + +*** + +### propertiesFormat + +> **propertiesFormat**: `"table"` \| `"list"` \| `"htmlTable"` + +Specify the render style of property groups for interfaces and classes. + +#### Defined in + +[packages/typedoc-plugin-markdown/src/options/types.ts:130](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/options/types.ts#L130) + +*** + +### publicPath + +> **publicPath**: `string` + +Specify the base path for all urls. + +#### Defined in + +[packages/typedoc-plugin-markdown/src/options/types.ts:135](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/options/types.ts#L135) + +*** + +### sanitizeComments + +> **sanitizeComments**: `boolean` + +Sanitize HTML and JSX inside JsDoc comments. + +#### Defined in + +[packages/typedoc-plugin-markdown/src/options/types.ts:140](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/options/types.ts#L140) + +*** + +### tableColumnSettings + +> **tableColumnSettings**: \{`hideDefaults`: `boolean`;`hideInherited`: `boolean`;`hideModifiers`: `boolean`;`hideOverrides`: `boolean`;`hideSources`: `boolean`;`hideValues`: `boolean`;`leftAlignHeaders`: `boolean`; \} + +Control header alignment and column visibility in tables. + +| Member | Type | +| ------ | ------ | +| `hideDefaults` | `boolean` | +| `hideInherited` | `boolean` | +| `hideModifiers` | `boolean` | +| `hideOverrides` | `boolean` | +| `hideSources` | `boolean` | +| `hideValues` | `boolean` | +| `leftAlignHeaders` | `boolean` | + +#### Defined in + +[packages/typedoc-plugin-markdown/src/options/types.ts:145](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/options/types.ts#L145) + +*** + +### textContentMappings + +> **textContentMappings**: \{`header.title`: `string`;`header.docs`: `string`;`breadcrumbs.home`: `string`;`title.indexPage`: `string`;`title.memberPage`: `string`;`footer.text`: `string`; \} + +Change specific text placeholders in the template. + +| Member | Type | +| ------ | ------ | +| `header.title` | `string` | +| `header.docs` | `string` | +| `breadcrumbs.home` | `string` | +| `title.indexPage` | `string` | +| `title.memberPage` | `string` | +| `footer.text` | `string` | + +#### Defined in + +[packages/typedoc-plugin-markdown/src/options/types.ts:158](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/options/types.ts#L158) + +*** + +### typeDeclarationFormat + +> **typeDeclarationFormat**: `"table"` \| `"list"` \| `"htmlTable"` + +Specify the render style for type declaration members. + +#### Defined in + +[packages/typedoc-plugin-markdown/src/options/types.ts:170](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/options/types.ts#L170) + +*** + +### useCodeBlocks + +> **useCodeBlocks**: `boolean` + +Wraps signatures and declarations in code blocks. + +#### Defined in + +[packages/typedoc-plugin-markdown/src/options/types.ts:175](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/options/types.ts#L175) + +*** + +### useHTMLAnchors + +> **useHTMLAnchors**: `boolean` + +Add HTML named anchors to headings and table rows. + +#### Defined in + +[packages/typedoc-plugin-markdown/src/options/types.ts:180](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/options/types.ts#L180) diff --git a/developer-docs/typedoc-plugin-markdown/theme/README.md b/developer-docs/typedoc-plugin-markdown/theme/README.md new file mode 100644 index 000000000..d4f3172a2 --- /dev/null +++ b/developer-docs/typedoc-plugin-markdown/theme/README.md @@ -0,0 +1,22 @@ +[Packages Index](../../README.md) / [typedoc-plugin-markdown](../README.md) / theme + +# theme + +This is the built-in Markdown theme. + +## Index + +### Namespaces + +| Namespace | Description | +| ------ | ------ | +| [context](namespaces/context/README.md) | Support and resources for the theme MarkdownThemeContext class. | +| [core](namespaces/core/README.md) | Support for the MarkdownTheme core class building URLs and navigation. | +| [types](namespaces/types/README.md) | - | + +### Classes + +| Class | Description | +| ------ | ------ | +| [MarkdownThemeContext](classes/MarkdownThemeContext.md) | The theme context class that is provided as context on the rendering of every page. | +| [MarkdownTheme](classes/MarkdownTheme.md) | The main theme class for the plugin. | diff --git a/developer-docs/typedoc-plugin-markdown/theme/classes/MarkdownTheme.md b/developer-docs/typedoc-plugin-markdown/theme/classes/MarkdownTheme.md new file mode 100644 index 000000000..7fd019852 --- /dev/null +++ b/developer-docs/typedoc-plugin-markdown/theme/classes/MarkdownTheme.md @@ -0,0 +1,733 @@ +[Packages Index](../../../README.md) / [typedoc-plugin-markdown](../../README.md) / [theme](../README.md) / MarkdownTheme + +# Class: MarkdownTheme + +The main theme class for the plugin. + +## Remarks + +The class controls how TypeDoc models are mapped to files and templates and extends TypeDoc's base Theme class. + +You would typically only be interested in overriding the the theme's render context instance. + +The API follows the implementation of [TypeDoc's custom theming](https://github.com/TypeStrong/typedoc/blob/master/internal-docs/custom-themes.md) with some minor adjustments. + +## Example + +```ts +export function load(app) { + app.renderer.defineTheme('customTheme', MyMarkdownTheme); +} + +class MyMarkdownTheme extends MarkdownTheme { + ... +} +``` + +## Extends + +- [`Theme`](https://typedoc.org/api/classes/Theme.html) + +## Constructors + +### new MarkdownTheme() + +> **new MarkdownTheme**(`owner`): [`MarkdownTheme`](MarkdownTheme.md) + +Create new Component instance. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `owner` | [`Renderer`](https://typedoc.org/api/classes/Renderer.html) | + +#### Returns + +[`MarkdownTheme`](MarkdownTheme.md) + +#### Inherited from + +`Theme.constructor` + +#### Defined in + +node\_modules/typedoc/dist/lib/utils/component.d.ts:52 + +## Properties + +### componentName + +> **componentName**: `string` + +The name of this component as set by the `@Component` decorator. + +#### Inherited from + +`Theme.componentName` + +#### Defined in + +node\_modules/typedoc/dist/lib/utils/component.d.ts:48 + +## Accessors + +### application + +> `get` **application**(): [`Application`](https://typedoc.org/api/classes/Application.html) + +Return the application / root component instance. + +#### Returns + +[`Application`](https://typedoc.org/api/classes/Application.html) + +#### Defined in + +node\_modules/typedoc/dist/lib/utils/component.d.ts:61 + +*** + +### owner + +> `get` **owner**(): `O` + +Return the owner of this component. + +#### Returns + +`O` + +#### Defined in + +node\_modules/typedoc/dist/lib/utils/component.d.ts:65 + +*** + +### \_listenId + +> `get` `private` **\_listenId**(): `any` + +A unique id that identifies this instance. + +#### Returns + +`any` + +#### Defined in + +node\_modules/typedoc/dist/lib/utils/events.d.ts:70 + +## Methods + +### initialize() + +> `protected` **initialize**(): `void` + +Initialize this component. + +#### Returns + +`void` + +#### Inherited from + +`Theme.initialize` + +#### Defined in + +node\_modules/typedoc/dist/lib/utils/component.d.ts:56 + +*** + +### bubble() + +> `protected` **bubble**(`name`, ...`args`): `this` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `name` | `string` \| `EventMap` \| [`Event`](https://typedoc.org/api/classes/Event.html) | +| ...`args` | `any`[] | + +#### Returns + +`this` + +#### Inherited from + +`Theme.bubble` + +#### Defined in + +node\_modules/typedoc/dist/lib/utils/component.d.ts:57 + +*** + +### on() + +#### on(eventMap, context) + +> **on**(`eventMap`, `context`?): `this` + +Bind an event to a `callback` function. Passing `"all"` will bind +the callback to all events fired. + +##### Parameters + +| Parameter | Type | +| ------ | ------ | +| `eventMap` | `EventMap` | +| `context`? | `any` | + +##### Returns + +`this` + +##### Inherited from + +`Theme.on` + +##### Defined in + +node\_modules/typedoc/dist/lib/utils/events.d.ts:76 + +#### on(eventMap, callback, context, priority) + +> **on**(`eventMap`, `callback`?, `context`?, `priority`?): `this` + +##### Parameters + +| Parameter | Type | +| ------ | ------ | +| `eventMap` | `EventMap` | +| `callback`? | `EventCallback` | +| `context`? | `any` | +| `priority`? | `number` | + +##### Returns + +`this` + +##### Inherited from + +`Theme.on` + +##### Defined in + +node\_modules/typedoc/dist/lib/utils/events.d.ts:77 + +#### on(name, callback, context, priority) + +> **on**(`name`, `callback`, `context`?, `priority`?): `this` + +##### Parameters + +| Parameter | Type | +| ------ | ------ | +| `name` | `string` | +| `callback` | `EventCallback` | +| `context`? | `any` | +| `priority`? | `number` | + +##### Returns + +`this` + +##### Inherited from + +`Theme.on` + +##### Defined in + +node\_modules/typedoc/dist/lib/utils/events.d.ts:78 + +*** + +### once() + +#### once(eventMap, context) + +> **once**(`eventMap`, `context`?): `this` + +Bind an event to only be triggered a single time. After the first time +the callback is invoked, its listener will be removed. If multiple events +are passed in using the space-separated syntax, the handler will fire +once for each event, not once for a combination of all events. + +##### Parameters + +| Parameter | Type | +| ------ | ------ | +| `eventMap` | `EventMap` | +| `context`? | `any` | + +##### Returns + +`this` + +##### Inherited from + +`Theme.once` + +##### Defined in + +node\_modules/typedoc/dist/lib/utils/events.d.ts:89 + +#### once(name, callback, context, priority) + +> **once**(`name`, `callback`, `context`?, `priority`?): `this` + +##### Parameters + +| Parameter | Type | +| ------ | ------ | +| `name` | `string` | +| `callback` | `EventCallback` | +| `context`? | `any` | +| `priority`? | `any` | + +##### Returns + +`this` + +##### Inherited from + +`Theme.once` + +##### Defined in + +node\_modules/typedoc/dist/lib/utils/events.d.ts:90 + +*** + +### off() + +#### off(undefined) + +> **off**(): `this` + +Remove one or many callbacks. If `context` is null, removes all +callbacks with that function. If `callback` is null, removes all +callbacks for the event. If `name` is null, removes all bound +callbacks for all events. + +##### Returns + +`this` + +##### Inherited from + +`Theme.off` + +##### Defined in + +node\_modules/typedoc/dist/lib/utils/events.d.ts:97 + +#### off(eventMap, context) + +> **off**(`eventMap`, `context`?): `this` + +##### Parameters + +| Parameter | Type | +| ------ | ------ | +| `eventMap` | `undefined` \| `EventMap` | +| `context`? | `any` | + +##### Returns + +`this` + +##### Inherited from + +`Theme.off` + +##### Defined in + +node\_modules/typedoc/dist/lib/utils/events.d.ts:98 + +#### off(name, callback, context) + +> **off**(`name`, `callback`?, `context`?): `this` + +##### Parameters + +| Parameter | Type | +| ------ | ------ | +| `name` | `undefined` \| `string` | +| `callback`? | `EventCallback` | +| `context`? | `any` | + +##### Returns + +`this` + +##### Inherited from + +`Theme.off` + +##### Defined in + +node\_modules/typedoc/dist/lib/utils/events.d.ts:99 + +*** + +### listenTo() + +> **listenTo**(`obj`, `name`, `callback`?, `priority`?): `this` + +Inversion-of-control versions of `on`. Tell *this* object to listen to +an event in another object... keeping track of what it's listening to +for easier unbinding later. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `obj` | `EventDispatcher` | +| `name` | `string` \| `EventMap` | +| `callback`? | `EventCallback` | +| `priority`? | `number` | + +#### Returns + +`this` + +#### Inherited from + +`Theme.listenTo` + +#### Defined in + +node\_modules/typedoc/dist/lib/utils/events.d.ts:105 + +*** + +### listenToOnce() + +#### listenToOnce(obj, eventMap) + +> **listenToOnce**(`obj`, `eventMap`): `this` + +Inversion-of-control versions of `once`. + +##### Parameters + +| Parameter | Type | +| ------ | ------ | +| `obj` | `EventDispatcher` | +| `eventMap` | `EventMap` | + +##### Returns + +`this` + +##### Inherited from + +`Theme.listenToOnce` + +##### Defined in + +node\_modules/typedoc/dist/lib/utils/events.d.ts:109 + +#### listenToOnce(obj, name, callback, priority) + +> **listenToOnce**(`obj`, `name`, `callback`, `priority`?): `this` + +##### Parameters + +| Parameter | Type | +| ------ | ------ | +| `obj` | `EventDispatcher` | +| `name` | `string` | +| `callback` | `EventCallback` | +| `priority`? | `number` | + +##### Returns + +`this` + +##### Inherited from + +`Theme.listenToOnce` + +##### Defined in + +node\_modules/typedoc/dist/lib/utils/events.d.ts:110 + +*** + +### stopListening() + +> **stopListening**(`obj`?, `name`?, `callback`?): `this` + +Tell this object to stop listening to either specific events ... or +to every object it's currently listening to. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `obj`? | `EventDispatcher` | +| `name`? | `string` \| `EventMap` | +| `callback`? | `EventCallback` | + +#### Returns + +`this` + +#### Inherited from + +`Theme.stopListening` + +#### Defined in + +node\_modules/typedoc/dist/lib/utils/events.d.ts:115 + +*** + +### trigger() + +> **trigger**(`name`, ...`args`): `this` + +Trigger one or many events, firing all bound callbacks. Callbacks are +passed the same arguments as `trigger` is, apart from the event name +(unless you're listening on `"all"`, which will cause your callback to +receive the true name of the event as the first argument). + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `name` | `string` \| `EventMap` \| [`Event`](https://typedoc.org/api/classes/Event.html) | +| ...`args` | `any`[] | + +#### Returns + +`this` + +#### Inherited from + +`Theme.trigger` + +#### Defined in + +node\_modules/typedoc/dist/lib/utils/events.d.ts:122 + +*** + +### render() + +`Internal` + +> **render**(`page`, `template`): `string` + +Renders a template and page model to a string. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `page` | [`MarkdownPageEvent`](../../app/namespaces/events/classes/MarkdownPageEvent.md)\<[`Reflection`](https://typedoc.org/api/classes/Models.Reflection.html)\> | +| `template` | [`RenderTemplate`](../namespaces/types/type-aliases/RenderTemplate.md)\<[`MarkdownPageEvent`](../../app/namespaces/events/classes/MarkdownPageEvent.md)\<[`Reflection`](https://typedoc.org/api/classes/Models.Reflection.html)\>\> | + +#### Returns + +`string` + +#### Overrides + +`Theme.render` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts:47](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts#L47) + +*** + +### getRenderContext() + +> **getRenderContext**(`page`): [`MarkdownThemeContext`](MarkdownThemeContext.md) + +Creates a new instance of the current theme context. + +This method can be overridden to provide an alternative theme context. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `page` | [`MarkdownPageEvent`](../../app/namespaces/events/classes/MarkdownPageEvent.md)\<[`Reflection`](https://typedoc.org/api/classes/Models.Reflection.html)\> | + +#### Returns + +[`MarkdownThemeContext`](MarkdownThemeContext.md) + +#### Defined in + +[packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts:64](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts#L64) + +*** + +### getUrls() + +> **getUrls**(`project`): [`UrlMapping`](../namespaces/types/interfaces/UrlMapping.md)\<[`Reflection`](https://typedoc.org/api/classes/Models.Reflection.html)\>[] + +Maps the models of the given project to the desired output files. + +This method can be overriden to provide an alternative url structure. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `project` | [`ProjectReflection`](https://typedoc.org/api/classes/Models.ProjectReflection.html) | + +#### Returns + +[`UrlMapping`](../namespaces/types/interfaces/UrlMapping.md)\<[`Reflection`](https://typedoc.org/api/classes/Models.Reflection.html)\>[] + +#### Overrides + +`Theme.getUrls` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts:73](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts#L73) + +*** + +### getNavigation() + +> **getNavigation**(`project`): [`NavigationItem`](../namespaces/types/interfaces/NavigationItem.md)[] + +Map the models of the given project to a navigation structure. + +This method can be overriden to provide an alternative navigation structure. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `project` | [`ProjectReflection`](https://typedoc.org/api/classes/Models.ProjectReflection.html) | + +#### Returns + +[`NavigationItem`](../namespaces/types/interfaces/NavigationItem.md)[] + +#### Defined in + +[packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts:82](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts#L82) + +*** + +### getTemplateMapping() + +`Internal` + +> **getTemplateMapping**(`kind`, `outputFileStrategy`?): `any` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `kind` | [`ReflectionKind`](https://typedoc.org/api/enums/Models.ReflectionKind-1.html) | +| `outputFileStrategy`? | [`OutputFileStrategy`](../../options/namespaces/maps/enumerations/OutputFileStrategy.md) | + +#### Returns + +`any` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts:89](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts#L89) + +*** + +### documentTemplate() + +`Internal` + +> **documentTemplate**(`page`): `string` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `page` | [`MarkdownPageEvent`](../../app/namespaces/events/classes/MarkdownPageEvent.md)\<`DocumentReflection`\> | + +#### Returns + +`string` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts:213](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts#L213) + +*** + +### readmeTemplate() + +`Internal` + +> **readmeTemplate**(`page`): `string` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `page` | [`MarkdownPageEvent`](../../app/namespaces/events/classes/MarkdownPageEvent.md)\<[`ProjectReflection`](https://typedoc.org/api/classes/Models.ProjectReflection.html)\> | + +#### Returns + +`string` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts:220](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts#L220) + +*** + +### projectTemplate() + +`Internal` + +> **projectTemplate**(`page`): `string` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `page` | [`MarkdownPageEvent`](../../app/namespaces/events/classes/MarkdownPageEvent.md)\<[`ProjectReflection`](https://typedoc.org/api/classes/Models.ProjectReflection.html)\> | + +#### Returns + +`string` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts:227](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts#L227) + +*** + +### reflectionTemplate() + +`Internal` + +> **reflectionTemplate**(`page`): `string` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `page` | [`MarkdownPageEvent`](../../app/namespaces/events/classes/MarkdownPageEvent.md)\<[`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html)\> | + +#### Returns + +`string` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts:234](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts#L234) diff --git a/packages/typedoc-plugin-markdown/developer-docs/theme/classes/MarkdownThemeContext.md b/developer-docs/typedoc-plugin-markdown/theme/classes/MarkdownThemeContext.md similarity index 54% rename from packages/typedoc-plugin-markdown/developer-docs/theme/classes/MarkdownThemeContext.md rename to developer-docs/typedoc-plugin-markdown/theme/classes/MarkdownThemeContext.md index 6bb6fdabf..36c417322 100644 --- a/packages/typedoc-plugin-markdown/developer-docs/theme/classes/MarkdownThemeContext.md +++ b/developer-docs/typedoc-plugin-markdown/theme/classes/MarkdownThemeContext.md @@ -1,17 +1,9 @@ -[typedoc-plugin-markdown v4.0.3](../../README.md) / [theme](../README.md) / MarkdownThemeContext +[Packages Index](../../../README.md) / [typedoc-plugin-markdown](../../README.md) / [theme](../README.md) / MarkdownThemeContext # Class: MarkdownThemeContext The theme context class that is provided as context on the rendering of every page. -## Table of Contents - -* [Example](#example) -* [Constructors](#constructors) -* [Methods](#methods) -* [Properties](#properties) -* [Resources](#resources) - ## Remarks It is heavily influenced by the equivalent [DefaultThemeRenderContext](https://typedoc.org/api/classes/DefaultThemeRenderContext.html) from the default theme. @@ -32,20 +24,15 @@ class MyMarkdownTheme extends MarkdownTheme { ### new MarkdownThemeContext() -```ts -new MarkdownThemeContext( - theme, - page, - options): MarkdownThemeContext -``` +> **new MarkdownThemeContext**(`theme`, `page`, `options`): [`MarkdownThemeContext`](MarkdownThemeContext.md) #### Parameters -| Parameter | Type | Description | -| --------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------- | -| `theme` | [`MarkdownTheme`](MarkdownTheme.md) | The theme instance. | -| `page` | [`MarkdownPageEvent`](../../app/namespaces/events/classes/MarkdownPageEvent.md)\<[`Reflection`](https://typedoc.org/api/classes/Models.Reflection.html)> | The current page event. | -| `options` | [`Options`](https://typedoc.org/api/classes/Configuration.Options.html) | The options provided to the application. | +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `theme` | [`MarkdownTheme`](MarkdownTheme.md) | The theme instance. | +| `page` | [`MarkdownPageEvent`](../../app/namespaces/events/classes/MarkdownPageEvent.md)\<[`Reflection`](https://typedoc.org/api/classes/Models.Reflection.html)\> | The current page event. | +| `options` | [`Options`](https://typedoc.org/api/classes/Configuration.Options.html) | The options provided to the application. | #### Returns @@ -53,140 +40,152 @@ new MarkdownThemeContext( #### Defined in -[packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts:56](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts#L56) +[packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts:56](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts#L56) -## Methods +## Properties -General context aware helper methods not bound to any specific models that can be used by the theme resources. +Properties are passed into the constructor and are used to provide context to the theme. -### getPackageMetaData() +### internationalization -```ts -getPackageMetaData(packageName): PackageMetaData -``` +> **internationalization**: `Internationalization` -Returns the package meta data for a given package name when entrypointStrategy is set to `packages`. +#### Defined in -#### Parameters +[packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts:50](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts#L50) -| Parameter | Type | Description | -| ------------- | -------- | --------------------------------------------------------- | -| `packageName` | `string` | The package name as per `name` field from `package.json`. | +*** -#### Returns +### i18n -[`PackageMetaData`](../namespaces/types/interfaces/PackageMetaData.md) +> **i18n**: `TranslationProxy` #### Defined in -[packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts:108](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts#L108) +[packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts:51](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts#L51) *** -### getRelativeUrl() +### theme -```ts -getRelativeUrl(url, ignorePublicPath): string -``` +> `private` **theme**: [`MarkdownTheme`](MarkdownTheme.md) -Returns the relative URL (from the current page context url). +The theme instance. -If public path is set, it will be used as the base URL. +#### Defined in -#### Parameters +[packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts:60](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts#L60) -| Parameter | Type | Default value | Description | -| ------------------ | --------- | ------------- | ---------------------------------- | -| `url` | `string` | `undefined` | The URL to make relative. | -| `ignorePublicPath` | `boolean` | `false` | Whether to ignore the public path. | +*** -#### Returns +### page -`string` +> `readonly` **page**: [`MarkdownPageEvent`](../../app/namespaces/events/classes/MarkdownPageEvent.md)\<[`Reflection`](https://typedoc.org/api/classes/Models.Reflection.html)\> + +The current page event. #### Defined in -[packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts:120](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts#L120) +[packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts:64](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts#L64) *** -### hook() +### options -`Internal` +> `readonly` **options**: [`Options`](https://typedoc.org/api/classes/Configuration.Options.html) -```ts -hook(name): string[] -``` +The options provided to the application. -Hook into the TypeDoc rendering system. +#### Defined in -#### Parameters +[packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts:68](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts#L68) -| Parameter | Type | -| --------- | ----------------------------------------------------------------------------------------------- | -| `name` | keyof [`MarkdownRendererHooks`](../../app/namespaces/types/interfaces/MarkdownRendererHooks.md) | +*** -#### Returns +### packagesMetaData -`string`\[] +> `private` **packagesMetaData**: `Record`\<`string`, [`PackageMetaData`](../namespaces/types/interfaces/PackageMetaData.md)\> + +Holds meta data for individual packages (if entryPointStrategy equals `packages`). + +This is required for generating package specific documentation. #### Defined in -[packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts:150](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts#L150) +[packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts:80](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts#L80) -## Properties +## Methods -Properties are passed into the constructor and are used to provide context to the theme. +General context aware helper methods not bound to any specific models that can be used by the theme resources. -### internationalization +### getPackageMetaData() -```ts -internationalization: Internationalization; -``` +> **getPackageMetaData**(`packageName`): [`PackageMetaData`](../namespaces/types/interfaces/PackageMetaData.md) -#### Defined in +Returns the package meta data for a given package name when entrypointStrategy is set to `packages`. -[packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts:50](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts#L50) +#### Parameters -*** +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `packageName` | `string` | The package name as per `name` field from `package.json`. | -### i18n +#### Returns -```ts -i18n: TranslationProxy; -``` +[`PackageMetaData`](../namespaces/types/interfaces/PackageMetaData.md) #### Defined in -[packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts:51](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts#L51) +[packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts:108](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts#L108) *** -### page +### getRelativeUrl() -```ts -readonly page: MarkdownPageEvent; -``` +> **getRelativeUrl**(`url`, `ignorePublicPath`): `string` -The current page event. +Returns the relative URL (from the current page context url). + +If public path is set, it will be used as the base URL. + +#### Parameters + +| Parameter | Type | Default value | Description | +| ------ | ------ | ------ | ------ | +| `url` | `string` | `undefined` | The URL to make relative. | +| `ignorePublicPath` | `boolean` | `false` | Whether to ignore the public path. | + +#### Returns + +`string` #### Defined in -[packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts:64](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts#L64) +[packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts:120](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts#L120) *** -### options +### hook() -```ts -readonly options: Options; -``` +`Internal` -The options provided to the application. +> **hook**(`name`): `string`[] + +Hook into the TypeDoc rendering system. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `name` | keyof [`MarkdownRendererHooks`](../../app/namespaces/types/interfaces/MarkdownRendererHooks.md) | + +#### Returns + +`string`[] #### Defined in -[packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts:68](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts#L68) +[packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts:150](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts#L150) ## Resources @@ -194,46 +193,40 @@ Theme resources are the main building blocks for the theme context. They are spl ### templates -```ts -templates: object = ...; -``` +> **templates**: \{\} #### See -[templates](../namespaces/context/namespaces/templates/README.md) +[templates](MarkdownThemeContext.md#templates) #### Defined in -[packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts:87](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts#L87) +[packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts:87](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts#L87) *** ### partials -```ts -partials: object = ...; -``` +> **partials**: \{\} #### See -[partials](../namespaces/context/namespaces/partials/README.md) +[partials](MarkdownThemeContext.md#partials) #### Defined in -[packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts:94](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts#L94) +[packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts:94](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts#L94) *** ### helpers -```ts -helpers: object = ...; -``` +> **helpers**: \{\} #### See -[helpers](../namespaces/context/namespaces/helpers/README.md) +[helpers](MarkdownThemeContext.md#helpers) #### Defined in -[packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts:101](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts#L101) +[packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts:101](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts#L101) diff --git a/developer-docs/typedoc-plugin-markdown/theme/namespaces/context/README.md b/developer-docs/typedoc-plugin-markdown/theme/namespaces/context/README.md new file mode 100644 index 000000000..81853334a --- /dev/null +++ b/developer-docs/typedoc-plugin-markdown/theme/namespaces/context/README.md @@ -0,0 +1,15 @@ +[Packages Index](../../../../README.md) / [typedoc-plugin-markdown](../../../README.md) / [theme](../../README.md) / context + +# context + +Support and resources for the theme MarkdownThemeContext class. + +## Index + +### Namespaces + +| Namespace | Description | +| ------ | ------ | +| [helpers](namespaces/helpers/README.md) | The `helpers` namespace holds the helpers for the theme and are smaller utility functions that return snippets or text or other data transformations. | +| [partials](namespaces/partials/README.md) | The `partials` namespace holds the partials for the theme and are used by templates to map speficic models to page output. | +| [templates](namespaces/templates/README.md) | Then `templates` namespace holds the main templates for the theme and are mapped to single pages and configured in the MarkdownTheme. | diff --git a/developer-docs/typedoc-plugin-markdown/theme/namespaces/context/namespaces/helpers/README.md b/developer-docs/typedoc-plugin-markdown/theme/namespaces/context/namespaces/helpers/README.md new file mode 100644 index 000000000..3cc570902 --- /dev/null +++ b/developer-docs/typedoc-plugin-markdown/theme/namespaces/context/namespaces/helpers/README.md @@ -0,0 +1,385 @@ +[Packages Index](../../../../../../README.md) / [typedoc-plugin-markdown](../../../../../README.md) / [theme](../../../../README.md) / [context](../../README.md) / helpers + +# helpers + +The `helpers` namespace holds the helpers for the theme and are smaller utility functions that return snippets or text or other data transformations. + +Please note that partials: + +- Take a `model` param (that references a specific TypeDoc model) and an `options` param if required. +- Can reference other helpers but should not reference partials. +- Can return strings or other models. + +## Functions + +### getCommentParts() + +> **getCommentParts**(`this`, `model`): `string` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `this` | [`MarkdownThemeContext`](../../../../classes/MarkdownThemeContext.md) | +| `model` | [`CommentDisplayPart`](https://typedoc.org/api/types/Models.CommentDisplayPart.html)[] | + +#### Returns + +`string` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/theme/context/helpers/get-comment-parts.ts:6](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/context/helpers/get-comment-parts.ts#L6) + +*** + +### isFile() + +> **isFile**(`file`): `boolean` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `file` | `string` | + +#### Returns + +`boolean` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/theme/context/helpers/get-comment-parts.ts:64](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/context/helpers/get-comment-parts.ts#L64) + +*** + +### getDeclarationType() + +> **getDeclarationType**(`model`): `undefined` \| [`SomeType`](https://typedoc.org/api/classes/Models.SomeType.html) + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `model` | [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html) | + +#### Returns + +`undefined` \| [`SomeType`](https://typedoc.org/api/classes/Models.SomeType.html) + +#### Defined in + +[packages/typedoc-plugin-markdown/src/theme/context/helpers/get-declaration-type.ts:3](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/context/helpers/get-declaration-type.ts#L3) + +*** + +### getDescriptionForReflection() + +> **getDescriptionForReflection**(`this`, `model`): `null` \| `string` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `this` | [`MarkdownThemeContext`](../../../../classes/MarkdownThemeContext.md) | +| `model` | [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html) | + +#### Returns + +`null` \| `string` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/theme/context/helpers/get-description-for-reflection.ts:4](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/context/helpers/get-description-for-reflection.ts#L4) + +*** + +### getFlattenedDeclarations() + +> **getFlattenedDeclarations**(`model`, `options`?): [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html)[] + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `model` | [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html)[] | +| `options`? | `object` | +| `options.includeSignatures`? | `boolean` | + +#### Returns + +[`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html)[] + +#### Defined in + +[packages/typedoc-plugin-markdown/src/theme/context/helpers/get-flattened-declarations.ts:3](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/context/helpers/get-flattened-declarations.ts#L3) + +*** + +### getGroupIndexList() + +> **getGroupIndexList**(`this`, `children`): `string` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `this` | [`MarkdownThemeContext`](../../../../classes/MarkdownThemeContext.md) | +| `children` | `DocumentReflection`[] \| [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html)[] | + +#### Returns + +`string` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/theme/context/helpers/get-group-index-list.ts:6](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/context/helpers/get-group-index-list.ts#L6) + +*** + +### getGroupIndexTable() + +> **getGroupIndexTable**(`this`, `children`, `kind`?): `string` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `this` | [`MarkdownThemeContext`](../../../../classes/MarkdownThemeContext.md) | +| `children` | `DocumentReflection`[] \| [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html)[] | +| `kind`? | [`ReflectionKind`](https://typedoc.org/api/enums/Models.ReflectionKind-1.html) | + +#### Returns + +`string` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/theme/context/helpers/get-group-index-table.ts:10](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/context/helpers/get-group-index-table.ts#L10) + +*** + +### getGroupIndex() + +> **getGroupIndex**(`group`): `any` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `group` | [`ReflectionCategory`](https://typedoc.org/api/types/Models.ReflectionCategory.html) \| [`ReflectionGroup`](https://typedoc.org/api/classes/Models.ReflectionGroup.html) | + +#### Returns + +`any` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/theme/context/helpers/get-group-index.ts:8](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/context/helpers/get-group-index.ts#L8) + +*** + +### getHierarchyType() + +> **getHierarchyType**(`this`, `model`, `options`?): `string` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `this` | [`MarkdownThemeContext`](../../../../classes/MarkdownThemeContext.md) | +| `model` | [`SomeType`](https://typedoc.org/api/classes/Models.SomeType.html) | +| `options`? | `object` | +| `options.isTarget`? | `boolean` | + +#### Returns + +`string` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/theme/context/helpers/get-hierarchy-type.ts:5](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/context/helpers/get-hierarchy-type.ts#L5) + +*** + +### getKeyword() + +> **getKeyword**(`model`): `string` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `model` | [`ReflectionKind`](https://typedoc.org/api/enums/Models.ReflectionKind-1.html) | + +#### Returns + +`string` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/theme/context/helpers/get-keyword.ts:3](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/context/helpers/get-keyword.ts#L3) + +*** + +### getModifier() + +> **getModifier**(`model`): `string` \| `null` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `model` | [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html) | + +#### Returns + +`string` \| `null` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/theme/context/helpers/get-modifier.ts:3](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/context/helpers/get-modifier.ts#L3) + +*** + +### getParameterDefaultValue() + +> **getParameterDefaultValue**(`model`): `string` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `model` | [`ParameterReflection`](https://typedoc.org/api/classes/Models.ParameterReflection.html) | + +#### Returns + +`string` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/theme/context/helpers/get-parameter-default-value.ts:3](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/context/helpers/get-parameter-default-value.ts#L3) + +*** + +### getProjectName() + +> **getProjectName**(`stringWithPlaceholders`, `page`): `string` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `stringWithPlaceholders` | `string` | +| `page` | [`MarkdownPageEvent`](../../../../../app/namespaces/events/classes/MarkdownPageEvent.md)\<[`Reflection`](https://typedoc.org/api/classes/Models.Reflection.html)\> | + +#### Returns + +`string` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/theme/context/helpers/get-project-name.ts:4](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/context/helpers/get-project-name.ts#L4) + +*** + +### getPropertyDefaultValue() + +> **getPropertyDefaultValue**(`model`): `null` \| `string` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `model` | [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html) | + +#### Returns + +`null` \| `string` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/theme/context/helpers/get-property-default-value.ts:4](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/context/helpers/get-property-default-value.ts#L4) + +*** + +### getReflectionFlags() + +> **getReflectionFlags**(`this`, `reflection`): `string`[] + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `this` | [`MarkdownThemeContext`](../../../../classes/MarkdownThemeContext.md) | +| `reflection` | [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html) \| [`SignatureReflection`](https://typedoc.org/api/classes/Models.SignatureReflection.html) | + +#### Returns + +`string`[] + +#### Defined in + +[packages/typedoc-plugin-markdown/src/theme/context/helpers/get-reflection-flags.ts:5](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/context/helpers/get-reflection-flags.ts#L5) + +*** + +### getReturnType() + +> **getReturnType**(`this`, `model`?): `string` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `this` | [`MarkdownThemeContext`](../../../../classes/MarkdownThemeContext.md) | +| `model`? | [`SomeType`](https://typedoc.org/api/classes/Models.SomeType.html) | + +#### Returns + +`string` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/theme/context/helpers/get-return-type.ts:5](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/context/helpers/get-return-type.ts#L5) + +*** + +### isGroupKind() + +> **isGroupKind**(`model`): `boolean` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `model` | [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html) \| [`SignatureReflection`](https://typedoc.org/api/classes/Models.SignatureReflection.html) | + +#### Returns + +`boolean` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/theme/context/helpers/is-group-kind.ts:7](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/context/helpers/is-group-kind.ts#L7) + +*** + +### useTableFormat() + +> **useTableFormat**(`this`, `key`): `boolean` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `this` | [`MarkdownThemeContext`](../../../../classes/MarkdownThemeContext.md) | +| `key` | `"parameters"` \| `"properties"` \| `"enums"` \| `"typeDeclarations"` | + +#### Returns + +`boolean` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/theme/context/helpers/use-table.format.ts:3](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/context/helpers/use-table.format.ts#L3) diff --git a/developer-docs/typedoc-plugin-markdown/theme/namespaces/context/namespaces/partials/README.md b/developer-docs/typedoc-plugin-markdown/theme/namespaces/context/namespaces/partials/README.md new file mode 100644 index 000000000..419424680 --- /dev/null +++ b/developer-docs/typedoc-plugin-markdown/theme/namespaces/context/namespaces/partials/README.md @@ -0,0 +1,1394 @@ +[Packages Index](../../../../../../README.md) / [typedoc-plugin-markdown](../../../../../README.md) / [theme](../../../../README.md) / [context](../../README.md) / partials + +# partials + +The `partials` namespace holds the partials for the theme and are used by templates to map speficic models to page output. + +Please note that partials:: + +- Take a `model` param (that references a specific TypeDoc model) and an `options` param if required. +- Can call other partials and helpers. +- Must return a string. + +Partials are categorised by their use: + +- Page Partials: Partials that render core page elements such as header and breadcrumbs. +- Container Partials: Partials that are used to render reflection groups and categories. +- Member Partials: Partials that render specific parts of reflections. +- Comment Partials: Partials that render comments. +- Type Partials: Partials that render specific TypeDoc model types. + +## Comment Partials + +### comment() + +> **comment**(`this`, `model`, `options`): `string` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `this` | [`MarkdownThemeContext`](../../../../classes/MarkdownThemeContext.md) | +| `model` | [`Comment`](https://typedoc.org/api/types/Models.Comment.html) | +| `options` | `object` | +| `options.headingLevel`? | `number` | +| `options.showSummary`? | `boolean` | +| `options.showTags`? | `boolean` | +| `options.isTableColumn`? | `boolean` | + +#### Returns + +`string` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/theme/context/partials/comments.comment.ts:9](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/context/partials/comments.comment.ts#L9) + +*** + +### commentParts() + +> **commentParts**(`this`, `model`): `string` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `this` | [`MarkdownThemeContext`](../../../../classes/MarkdownThemeContext.md) | +| `model` | [`CommentDisplayPart`](https://typedoc.org/api/types/Models.CommentDisplayPart.html)[] | + +#### Returns + +`string` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/theme/context/partials/comments.commentParts.ts:9](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/context/partials/comments.commentParts.ts#L9) + +## Container Partials + +### body() + +> **body**(`this`, `model`, `options`): `string` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `this` | [`MarkdownThemeContext`](../../../../classes/MarkdownThemeContext.md) | +| `model` | [`ContainerReflection`](https://typedoc.org/api/classes/Models.ContainerReflection.html) | +| `options` | `object` | +| `options.headingLevel` | `number` | + +#### Returns + +`string` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/theme/context/partials/container.body.ts:11](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/context/partials/container.body.ts#L11) + +*** + +### categories() + +> **categories**(`this`, `model`, `options`): `string` + +Renders a collection of reflection categories. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `this` | [`MarkdownThemeContext`](../../../../classes/MarkdownThemeContext.md) | +| `model` | [`ReflectionCategory`](https://typedoc.org/api/types/Models.ReflectionCategory.html)[] | +| `options` | `object` | +| `options.headingLevel` | `number` | + +#### Returns + +`string` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/theme/context/partials/container.categories.ts:10](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/context/partials/container.categories.ts#L10) + +*** + +### groups() + +> **groups**(`this`, `model`, `options`): `string` + +Renders a collection of reflection groups. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `this` | [`MarkdownThemeContext`](../../../../classes/MarkdownThemeContext.md) | +| `model` | [`ReflectionGroup`](https://typedoc.org/api/classes/Models.ReflectionGroup.html)[] | +| `options` | `object` | +| `options.headingLevel` | `number` | + +#### Returns + +`string` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/theme/context/partials/container.groups.ts:14](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/context/partials/container.groups.ts#L14) + +*** + +### members() + +> **members**(`this`, `model`, `options`): `string` + +Renders a collection of members. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `this` | [`MarkdownThemeContext`](../../../../classes/MarkdownThemeContext.md) | +| `model` | [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html)[] | +| `options` | `object` | +| `options.headingLevel` | `number` | + +#### Returns + +`string` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/theme/context/partials/container.members.ts:10](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/context/partials/container.members.ts#L10) + +## Member Partials + +### accessor() + +> **accessor**(`this`, `model`, `options`): `string` + +Renders an accessor member. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `this` | [`MarkdownThemeContext`](../../../../classes/MarkdownThemeContext.md) | +| `model` | [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html) | +| `options` | `object` | +| `options.headingLevel` | `number` | + +#### Returns + +`string` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/theme/context/partials/member.accessor.ts:10](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/context/partials/member.accessor.ts#L10) + +*** + +### constructor() + +> **constructor**(`this`, `model`, `options`): `string` + +Renders an constructor member. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `this` | [`MarkdownThemeContext`](../../../../classes/MarkdownThemeContext.md) | +| `model` | [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html) | +| `options` | `object` | +| `options.headingLevel` | `number` | + +#### Returns + +`string` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/theme/context/partials/member.constructors.ts:11](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/context/partials/member.constructors.ts#L11) + +*** + +### memberContainer() + +> **memberContainer**(`this`, `model`, `options`): `string` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `this` | [`MarkdownThemeContext`](../../../../classes/MarkdownThemeContext.md) | +| `model` | [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html) | +| `options` | `object` | +| `options.headingLevel` | `number` | +| `options.nested`? | `boolean` | + +#### Returns + +`string` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/theme/context/partials/member.container.ts:8](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/context/partials/member.container.ts#L8) + +*** + +### declaration() + +> **declaration**(`this`, `model`, `options`): `string` + +Renders a standard declaration member. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `this` | [`MarkdownThemeContext`](../../../../classes/MarkdownThemeContext.md) | +| `model` | [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html) | +| `options` | `object` | +| `options.headingLevel` | `number` | +| `options.nested`? | `boolean` | + +#### Returns + +`string` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/theme/context/partials/member.declaration.ts:16](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/context/partials/member.declaration.ts#L16) + +*** + +### declarationTitle() + +> **declarationTitle**(`this`, `model`): `string` + +Comments for declaration + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `this` | [`MarkdownThemeContext`](../../../../classes/MarkdownThemeContext.md) | +| `model` | [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html) | + +#### Returns + +`string` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/theme/context/partials/member.declarationTitle.ts:11](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/context/partials/member.declarationTitle.ts#L11) + +*** + +### documents() + +> **documents**(`this`, `model`, `options`): `string` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `this` | [`MarkdownThemeContext`](../../../../classes/MarkdownThemeContext.md) | +| `model` | [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html) \| [`ProjectReflection`](https://typedoc.org/api/classes/Models.ProjectReflection.html) \| [`ContainerReflection`](https://typedoc.org/api/classes/Models.ContainerReflection.html) | +| `options` | `object` | +| `options.headingLevel` | `number` | + +#### Returns + +`string` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/theme/context/partials/member.documents.ts:13](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/context/partials/member.documents.ts#L13) + +*** + +### enumMembersTable() + +> **enumMembersTable**(`this`, `model`): `string` + +Renders enum members as a table. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `this` | [`MarkdownThemeContext`](../../../../classes/MarkdownThemeContext.md) | +| `model` | [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html)[] | + +#### Returns + +`string` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/theme/context/partials/member.enumMembersTable.ts:11](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/context/partials/member.enumMembersTable.ts#L11) + +*** + +### hierarchy() + +> **hierarchy**(`this`, `model`, `options`): `string` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `this` | [`MarkdownThemeContext`](../../../../classes/MarkdownThemeContext.md) | +| `model` | [`DeclarationHierarchy`](https://typedoc.org/api/classes/Models.DeclarationHierarchy.html) | +| `options` | `object` | +| `options.headingLevel` | `number` | + +#### Returns + +`string` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/theme/context/partials/member.hierarchy.ts:8](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/context/partials/member.hierarchy.ts#L8) + +*** + +### indexSignature() + +> **indexSignature**(`this`, `model`): `string` + +Renders an index signature block + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `this` | [`MarkdownThemeContext`](../../../../classes/MarkdownThemeContext.md) | +| `model` | [`SignatureReflection`](https://typedoc.org/api/classes/Models.SignatureReflection.html) | + +#### Returns + +`string` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/theme/context/partials/member.indexSignature.ts:10](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/context/partials/member.indexSignature.ts#L10) + +*** + +### inheritance() + +> **inheritance**(`this`, `model`, `options`): `string` + +Renders an inheritance section. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `this` | [`MarkdownThemeContext`](../../../../classes/MarkdownThemeContext.md) | +| `model` | [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html) \| [`SignatureReflection`](https://typedoc.org/api/classes/Models.SignatureReflection.html) | +| `options` | `object` | +| `options.headingLevel` | `number` | + +#### Returns + +`string` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/theme/context/partials/member.inheritance.ts:10](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/context/partials/member.inheritance.ts#L10) + +*** + +### memberTitle() + +> **memberTitle**(`this`, `model`): `string` + +Renders the main member title. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `this` | [`MarkdownThemeContext`](../../../../classes/MarkdownThemeContext.md) | +| `model` | [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html) | + +#### Returns + +`string` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/theme/context/partials/member.memberTitle.ts:11](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/context/partials/member.memberTitle.ts#L11) + +*** + +### memberWithGroups() + +> **memberWithGroups**(`this`, `model`, `options`): `string` + +Renders a top-level member that contains group and child members such as Classes, Interfaces and Enums. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `this` | [`MarkdownThemeContext`](../../../../classes/MarkdownThemeContext.md) | +| `model` | [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html) | +| `options` | `object` | +| `options.headingLevel` | `number` | + +#### Returns + +`string` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/theme/context/partials/member.memberWithGroups.ts:10](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/context/partials/member.memberWithGroups.ts#L10) + +*** + +### parametersList() + +> **parametersList**(`this`, `model`): `string` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `this` | [`MarkdownThemeContext`](../../../../classes/MarkdownThemeContext.md) | +| `model` | [`ParameterReflection`](https://typedoc.org/api/classes/Models.ParameterReflection.html)[] | + +#### Returns + +`string` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/theme/context/partials/member.parametersList.ts:9](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/context/partials/member.parametersList.ts#L9) + +*** + +### parametersTable() + +> **parametersTable**(`this`, `model`): `string` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `this` | [`MarkdownThemeContext`](../../../../classes/MarkdownThemeContext.md) | +| `model` | [`ParameterReflection`](https://typedoc.org/api/classes/Models.ParameterReflection.html)[] | + +#### Returns + +`string` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/theme/context/partials/member.parametersTable.ts:9](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/context/partials/member.parametersTable.ts#L9) + +*** + +### propertiesTable() + +> **propertiesTable**(`this`, `model`, `options`?): `string` + +Renders a collection of properties in a table. + +There is no association list partial for properties as these are handled as a standard list of members. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `this` | [`MarkdownThemeContext`](../../../../classes/MarkdownThemeContext.md) | +| `model` | [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html)[] | +| `options`? | `object` | +| `options.isEventProps`? | `boolean` | + +#### Returns + +`string` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/theme/context/partials/member.propertiesTable.ts:15](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/context/partials/member.propertiesTable.ts#L15) + +*** + +### referenceMember() + +> **referenceMember**(`this`, `model`): `string` + +Renders an reference member. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `this` | [`MarkdownThemeContext`](../../../../classes/MarkdownThemeContext.md) | +| `model` | [`ReferenceReflection`](https://typedoc.org/api/classes/Models.ReferenceReflection.html) | + +#### Returns + +`string` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/theme/context/partials/member.reference.ts:10](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/context/partials/member.reference.ts#L10) + +*** + +### reflectionIndex() + +> **reflectionIndex**(`this`, `model`, `options`): `string` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `this` | [`MarkdownThemeContext`](../../../../classes/MarkdownThemeContext.md) | +| `model` | [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html) \| [`ProjectReflection`](https://typedoc.org/api/classes/Models.ProjectReflection.html) | +| `options` | `object` | +| `options.headingLevel` | `number` | + +#### Returns + +`string` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/theme/context/partials/member.reflectionIndex.ts:13](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/context/partials/member.reflectionIndex.ts#L13) + +*** + +### signature() + +> **signature**(`this`, `model`, `options`): `string` + +Renders a signature member. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `this` | [`MarkdownThemeContext`](../../../../classes/MarkdownThemeContext.md) | +| `model` | [`SignatureReflection`](https://typedoc.org/api/classes/Models.SignatureReflection.html) | +| `options` | `object` | +| `options.headingLevel` | `number` | +| `options.nested`? | `boolean` | +| `options.accessor`? | `string` | +| `options.multipleSignatures`? | `boolean` | + +#### Returns + +`string` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/theme/context/partials/member.signature.ts:10](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/context/partials/member.signature.ts#L10) + +*** + +### signatureParameters() + +> **signatureParameters**(`this`, `model`): `string` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `this` | [`MarkdownThemeContext`](../../../../classes/MarkdownThemeContext.md) | +| `model` | [`ParameterReflection`](https://typedoc.org/api/classes/Models.ParameterReflection.html)[] | + +#### Returns + +`string` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/theme/context/partials/member.signatureParameters.ts:8](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/context/partials/member.signatureParameters.ts#L8) + +*** + +### signatureReturns() + +> **signatureReturns**(`this`, `model`, `options`): `string` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `this` | [`MarkdownThemeContext`](../../../../classes/MarkdownThemeContext.md) | +| `model` | [`SignatureReflection`](https://typedoc.org/api/classes/Models.SignatureReflection.html) | +| `options` | `object` | +| `options.headingLevel` | `number` | + +#### Returns + +`string` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/theme/context/partials/member.signatureReturns.ts:13](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/context/partials/member.signatureReturns.ts#L13) + +*** + +### signatureTitle() + +> **signatureTitle**(`this`, `model`, `options`?): `string` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `this` | [`MarkdownThemeContext`](../../../../classes/MarkdownThemeContext.md) | +| `model` | [`SignatureReflection`](https://typedoc.org/api/classes/Models.SignatureReflection.html) | +| `options`? | `object` | +| `options.accessor`? | `string` | +| `options.includeType`? | `boolean` | + +#### Returns + +`string` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/theme/context/partials/member.signatureTitle.ts:9](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/context/partials/member.signatureTitle.ts#L9) + +*** + +### signatures() + +> **signatures**(`this`, `model`, `options`): `string` + +Renders a signature collection. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `this` | [`MarkdownThemeContext`](../../../../classes/MarkdownThemeContext.md) | +| `model` | [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html) | +| `options` | `object` | +| `options.headingLevel` | `number` | +| `options.nested`? | `boolean` | + +#### Returns + +`string` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/theme/context/partials/member.signatures.ts:11](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/context/partials/member.signatures.ts#L11) + +*** + +### sources() + +> **sources**(`this`, `model`, `options`): `string` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `this` | [`MarkdownThemeContext`](../../../../classes/MarkdownThemeContext.md) | +| `model` | [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html) \| [`SignatureReflection`](https://typedoc.org/api/classes/Models.SignatureReflection.html) | +| `options` | `object` | +| `options.headingLevel` | `number` | + +#### Returns + +`string` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/theme/context/partials/member.sources.ts:9](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/context/partials/member.sources.ts#L9) + +*** + +### member() + +> **member**(`this`, `model`, `options`): `string` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `this` | [`MarkdownThemeContext`](../../../../classes/MarkdownThemeContext.md) | +| `model` | [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html) | +| `options` | `object` | +| `options.headingLevel` | `number` | +| `options.nested`? | `boolean` | + +#### Returns + +`string` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/theme/context/partials/member.ts:11](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/context/partials/member.ts#L11) + +*** + +### typeAndParent() + +> **typeAndParent**(`this`, `model`): `string` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `this` | [`MarkdownThemeContext`](../../../../classes/MarkdownThemeContext.md) | +| `model` | [`ReferenceType`](https://typedoc.org/api/classes/Models.ReferenceType.html) \| [`ArrayType`](https://typedoc.org/api/types/Models.ArrayType.html) | + +#### Returns + +`string` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/theme/context/partials/member.typeAndParent.ts:8](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/context/partials/member.typeAndParent.ts#L8) + +*** + +### typeArguments() + +> **typeArguments**(`this`, `model`, `options`?): `string` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `this` | [`MarkdownThemeContext`](../../../../classes/MarkdownThemeContext.md) | +| `model` | [`SomeType`](https://typedoc.org/api/classes/Models.SomeType.html)[] | +| `options`? | `object` | +| `options.forceCollapse`? | `boolean` | + +#### Returns + +`string` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/theme/context/partials/member.typeArguments.ts:7](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/context/partials/member.typeArguments.ts#L7) + +*** + +### typeDeclaration() + +> **typeDeclaration**(`this`, `model`, `options`): `string` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `this` | [`MarkdownThemeContext`](../../../../classes/MarkdownThemeContext.md) | +| `model` | [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html)[] | +| `options` | `object` | +| `options.headingLevel` | `number` | + +#### Returns + +`string` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/theme/context/partials/member.typeDeclaration.ts:7](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/context/partials/member.typeDeclaration.ts#L7) + +*** + +### typeDeclarationList() + +> **typeDeclarationList**(`this`, `model`, `options`): `string` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `this` | [`MarkdownThemeContext`](../../../../classes/MarkdownThemeContext.md) | +| `model` | [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html)[] | +| `options` | `object` | +| `options.headingLevel` | `number` | + +#### Returns + +`string` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/theme/context/partials/member.typeDeclarationList.ts:7](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/context/partials/member.typeDeclarationList.ts#L7) + +*** + +### typeDeclarationTable() + +> **typeDeclarationTable**(`this`, `model`): `string` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `this` | [`MarkdownThemeContext`](../../../../classes/MarkdownThemeContext.md) | +| `model` | [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html)[] | + +#### Returns + +`string` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/theme/context/partials/member.typeDeclarationTable.ts:9](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/context/partials/member.typeDeclarationTable.ts#L9) + +*** + +### typeParametersList() + +> **typeParametersList**(`this`, `model`): `string` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `this` | [`MarkdownThemeContext`](../../../../classes/MarkdownThemeContext.md) | +| `model` | [`TypeParameterReflection`](https://typedoc.org/api/classes/Models.TypeParameterReflection.html)[] | + +#### Returns + +`string` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/theme/context/partials/member.typeParametersList.ts:8](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/context/partials/member.typeParametersList.ts#L8) + +*** + +### typeParametersTable() + +> **typeParametersTable**(`this`, `model`): `string` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `this` | [`MarkdownThemeContext`](../../../../classes/MarkdownThemeContext.md) | +| `model` | [`TypeParameterReflection`](https://typedoc.org/api/classes/Models.TypeParameterReflection.html)[] | + +#### Returns + +`string` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/theme/context/partials/member.typeParametersTable.ts:8](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/context/partials/member.typeParametersTable.ts#L8) + +## Other + +### isFile() + +> **isFile**(`file`): `boolean` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `file` | `string` | + +#### Returns + +`boolean` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/theme/context/partials/comments.commentParts.ts:67](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/context/partials/comments.commentParts.ts#L67) + +## Page Partials + +### breadcrumbs() + +> **breadcrumbs**(`this`): `string` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `this` | [`MarkdownThemeContext`](../../../../classes/MarkdownThemeContext.md) | + +#### Returns + +`string` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/theme/context/partials/page.breadcrumbs.ts:9](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/context/partials/page.breadcrumbs.ts#L9) + +*** + +### footer() + +> **footer**(`this`): `string` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `this` | [`MarkdownThemeContext`](../../../../classes/MarkdownThemeContext.md) | + +#### Returns + +`string` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/theme/context/partials/page.footer.ts:6](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/context/partials/page.footer.ts#L6) + +*** + +### header() + +> **header**(`this`): `string` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `this` | [`MarkdownThemeContext`](../../../../classes/MarkdownThemeContext.md) | + +#### Returns + +`string` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/theme/context/partials/page.header.ts:15](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/context/partials/page.header.ts#L15) + +*** + +### packagesIndex() + +> **packagesIndex**(`this`, `model`): `string` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `this` | [`MarkdownThemeContext`](../../../../classes/MarkdownThemeContext.md) | +| `model` | [`ProjectReflection`](https://typedoc.org/api/classes/Models.ProjectReflection.html) | + +#### Returns + +`string` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/theme/context/partials/page.packagesIndex.ts:10](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/context/partials/page.packagesIndex.ts#L10) + +*** + +### pageTitle() + +> **pageTitle**(`this`): `string` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `this` | [`MarkdownThemeContext`](../../../../classes/MarkdownThemeContext.md) | + +#### Returns + +`string` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/theme/context/partials/page.pageTitle.ts:7](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/context/partials/page.pageTitle.ts#L7) + +## Type Partials + +### arrayType() + +> **arrayType**(`this`, `model`): `string` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `this` | [`MarkdownThemeContext`](../../../../classes/MarkdownThemeContext.md) | +| `model` | [`ArrayType`](https://typedoc.org/api/types/Models.ArrayType.html) | + +#### Returns + +`string` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/theme/context/partials/type.array.ts:7](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/context/partials/type.array.ts#L7) + +*** + +### conditionalType() + +> **conditionalType**(`this`, `model`): `string` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `this` | [`MarkdownThemeContext`](../../../../classes/MarkdownThemeContext.md) | +| `model` | [`ConditionalType`](https://typedoc.org/api/types/Models.ConditionalType.html) | + +#### Returns + +`string` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/theme/context/partials/type.conditional.ts:8](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/context/partials/type.conditional.ts#L8) + +*** + +### indexAccessType() + +> **indexAccessType**(`this`, `model`): `string` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `this` | [`MarkdownThemeContext`](../../../../classes/MarkdownThemeContext.md) | +| `model` | [`IndexedAccessType`](https://typedoc.org/api/types/Models.IndexedAccessType.html) | + +#### Returns + +`string` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/theme/context/partials/type.index-access.ts:7](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/context/partials/type.index-access.ts#L7) + +*** + +### inferredType() + +> **inferredType**(`this`, `model`): `string` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `this` | [`MarkdownThemeContext`](../../../../classes/MarkdownThemeContext.md) | +| `model` | [`InferredType`](https://typedoc.org/api/types/Models.InferredType.html) | + +#### Returns + +`string` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/theme/context/partials/type.inferred.ts:8](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/context/partials/type.inferred.ts#L8) + +*** + +### intersectionType() + +> **intersectionType**(`this`, `model`): `string` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `this` | [`MarkdownThemeContext`](../../../../classes/MarkdownThemeContext.md) | +| `model` | [`IntersectionType`](https://typedoc.org/api/types/Models.IntersectionType.html) | + +#### Returns + +`string` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/theme/context/partials/type.intersection.ts:7](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/context/partials/type.intersection.ts#L7) + +*** + +### intrinsicType() + +> **intrinsicType**(`this`, `model`): `string` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `this` | [`MarkdownThemeContext`](../../../../classes/MarkdownThemeContext.md) | +| `model` | [`IntrinsicType`](https://typedoc.org/api/types/Models.IntrinsicType.html) | + +#### Returns + +`string` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/theme/context/partials/type.intrinsic.ts:8](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/context/partials/type.intrinsic.ts#L8) + +*** + +### literalType() + +> **literalType**(`this`, `model`): `string` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `this` | [`MarkdownThemeContext`](../../../../classes/MarkdownThemeContext.md) | +| `model` | [`LiteralType`](https://typedoc.org/api/types/Models.LiteralType.html) | + +#### Returns + +`string` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/theme/context/partials/type.literal.ts:7](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/context/partials/type.literal.ts#L7) + +*** + +### namedTupleType() + +> **namedTupleType**(`this`, `model`): `string` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `this` | [`MarkdownThemeContext`](../../../../classes/MarkdownThemeContext.md) | +| `model` | [`NamedTupleMember`](https://typedoc.org/api/types/Models.NamedTupleMember.html) | + +#### Returns + +`string` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/theme/context/partials/type.named-tuple.ts:7](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/context/partials/type.named-tuple.ts#L7) + +*** + +### queryType() + +> **queryType**(`this`, `model`): `string` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `this` | [`MarkdownThemeContext`](../../../../classes/MarkdownThemeContext.md) | +| `model` | [`QueryType`](https://typedoc.org/api/types/Models.QueryType.html) | + +#### Returns + +`string` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/theme/context/partials/type.query.ts:8](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/context/partials/type.query.ts#L8) + +*** + +### referenceType() + +> **referenceType**(`this`, `model`): `string` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `this` | [`MarkdownThemeContext`](../../../../classes/MarkdownThemeContext.md) | +| `model` | [`ReferenceType`](https://typedoc.org/api/classes/Models.ReferenceType.html) | + +#### Returns + +`string` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/theme/context/partials/type.reference.ts:8](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/context/partials/type.reference.ts#L8) + +*** + +### declarationType() + +> **declarationType**(`this`, `model`): `string` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `this` | [`MarkdownThemeContext`](../../../../classes/MarkdownThemeContext.md) | +| `model` | [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html) | + +#### Returns + +`string` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/theme/context/partials/type.reflection.declaration.ts:8](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/context/partials/type.reflection.declaration.ts#L8) + +*** + +### functionType() + +> **functionType**(`this`, `model`, `options`?): `string` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `this` | [`MarkdownThemeContext`](../../../../classes/MarkdownThemeContext.md) | +| `model` | [`SignatureReflection`](https://typedoc.org/api/classes/Models.SignatureReflection.html)[] | +| `options`? | `object` | +| `options.forceParameterType`? | `boolean` | + +#### Returns + +`string` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/theme/context/partials/type.reflection.function.ts:8](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/context/partials/type.reflection.function.ts#L8) + +*** + +### reflectionType() + +> **reflectionType**(`this`, `model`, `options`?): `string` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `this` | [`MarkdownThemeContext`](../../../../classes/MarkdownThemeContext.md) | +| `model` | [`ReflectionType`](https://typedoc.org/api/classes/Models.ReflectionType.html) | +| `options`? | `object` | +| `options.forceCollapse`? | `boolean` | + +#### Returns + +`string` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/theme/context/partials/type.reflection.ts:8](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/context/partials/type.reflection.ts#L8) + +*** + +### someType() + +> **someType**(`this`, `model`?): `string` + +Takes a generic Type and returns the appropriate partial for it. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `this` | [`MarkdownThemeContext`](../../../../classes/MarkdownThemeContext.md) | +| `model`? | [`SomeType`](https://typedoc.org/api/classes/Models.SomeType.html) | + +#### Returns + +`string` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/theme/context/partials/type.some.ts:26](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/context/partials/type.some.ts#L26) + +*** + +### tupleType() + +> **tupleType**(`this`, `model`): `string` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `this` | [`MarkdownThemeContext`](../../../../classes/MarkdownThemeContext.md) | +| `model` | [`TupleType`](https://typedoc.org/api/classes/Models.TupleType.html) | + +#### Returns + +`string` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/theme/context/partials/type.tuple.ts:7](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/context/partials/type.tuple.ts#L7) + +*** + +### typeOperatorType() + +> **typeOperatorType**(`this`, `model`): `string` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `this` | [`MarkdownThemeContext`](../../../../classes/MarkdownThemeContext.md) | +| `model` | [`TypeOperatorType`](https://typedoc.org/api/interfaces/TypeOperatorType.html) | + +#### Returns + +`string` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/theme/context/partials/type.type-operator.ts:7](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/context/partials/type.type-operator.ts#L7) + +*** + +### unionType() + +> **unionType**(`this`, `model`): `string` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `this` | [`MarkdownThemeContext`](../../../../classes/MarkdownThemeContext.md) | +| `model` | [`UnionType`](https://typedoc.org/api/types/Models.UnionType.html) | + +#### Returns + +`string` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/theme/context/partials/type.union.ts:7](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/context/partials/type.union.ts#L7) + +*** + +### unknownType() + +> **unknownType**(`this`, `model`): `string` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `this` | [`MarkdownThemeContext`](../../../../classes/MarkdownThemeContext.md) | +| `model` | [`UnknownType`](https://typedoc.org/api/types/Models.UnknownType.html) | + +#### Returns + +`string` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/theme/context/partials/type.unknown.ts:8](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/context/partials/type.unknown.ts#L8) diff --git a/developer-docs/typedoc-plugin-markdown/theme/namespaces/context/namespaces/templates/README.md b/developer-docs/typedoc-plugin-markdown/theme/namespaces/context/namespaces/templates/README.md new file mode 100644 index 000000000..3fba2e623 --- /dev/null +++ b/developer-docs/typedoc-plugin-markdown/theme/namespaces/context/namespaces/templates/README.md @@ -0,0 +1,99 @@ +[Packages Index](../../../../../../README.md) / [typedoc-plugin-markdown](../../../../../README.md) / [theme](../../../../README.md) / [context](../../README.md) / templates + +# templates + +Then `templates` namespace holds the main templates for the theme and are mapped to single pages and configured in the MarkdownTheme. + +All templates return a string that is passed back to the renderer. Internally templates call partials and helpers. + +## Functions + +### document() + +> **document**(`this`, `page`): `string` + +Template that maps to a project document. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `this` | [`MarkdownThemeContext`](../../../../classes/MarkdownThemeContext.md) | +| `page` | [`MarkdownPageEvent`](../../../../../app/namespaces/events/classes/MarkdownPageEvent.md)\<`DocumentReflection`\> | + +#### Returns + +`string` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/theme/context/templates/document.ts:8](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/context/templates/document.ts#L8) + +*** + +### project() + +> **project**(`this`, `page`): `string` + +Template that maps to the root project reflection. This will be the index page / documentation root page. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `this` | [`MarkdownThemeContext`](../../../../classes/MarkdownThemeContext.md) | +| `page` | [`MarkdownPageEvent`](../../../../../app/namespaces/events/classes/MarkdownPageEvent.md)\<[`ProjectReflection`](https://typedoc.org/api/classes/Models.ProjectReflection.html)\> | + +#### Returns + +`string` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/theme/context/templates/project.ts:14](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/context/templates/project.ts#L14) + +*** + +### readme() + +> **readme**(`this`, `page`): `string` + +Template that specifically maps to the resolved readme file. This template is not used when 'readme' is set to 'none'. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `this` | [`MarkdownThemeContext`](../../../../classes/MarkdownThemeContext.md) | +| `page` | [`MarkdownPageEvent`](../../../../../app/namespaces/events/classes/MarkdownPageEvent.md)\<[`ProjectReflection`](https://typedoc.org/api/classes/Models.ProjectReflection.html)\> | + +#### Returns + +`string` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/theme/context/templates/read-me.ts:8](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/context/templates/read-me.ts#L8) + +*** + +### reflection() + +> **reflection**(`this`, `page`): `string` + +Template that maps to individual reflection models. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `this` | [`MarkdownThemeContext`](../../../../classes/MarkdownThemeContext.md) | +| `page` | [`MarkdownPageEvent`](../../../../../app/namespaces/events/classes/MarkdownPageEvent.md)\<[`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html)\> | + +#### Returns + +`string` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/theme/context/templates/reflection.ts:9](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/context/templates/reflection.ts#L9) diff --git a/developer-docs/typedoc-plugin-markdown/theme/namespaces/core/README.md b/developer-docs/typedoc-plugin-markdown/theme/namespaces/core/README.md new file mode 100644 index 000000000..df8570dd1 --- /dev/null +++ b/developer-docs/typedoc-plugin-markdown/theme/namespaces/core/README.md @@ -0,0 +1,14 @@ +[Packages Index](../../../../README.md) / [typedoc-plugin-markdown](../../../README.md) / [theme](../../README.md) / core + +# core + +Support for the MarkdownTheme core class building URLs and navigation. + +## Index + +### Classes + +| Class | Description | +| ------ | ------ | +| [NavigationBuilder](classes/NavigationBuilder.md) | - | +| [UrlBuilder](classes/UrlBuilder.md) | Map the models of the given project to the desired output files. Based on TypeDoc DefaultTheme.getUrls() | diff --git a/developer-docs/typedoc-plugin-markdown/theme/namespaces/core/classes/NavigationBuilder.md b/developer-docs/typedoc-plugin-markdown/theme/namespaces/core/classes/NavigationBuilder.md new file mode 100644 index 000000000..f61d5ebf9 --- /dev/null +++ b/developer-docs/typedoc-plugin-markdown/theme/namespaces/core/classes/NavigationBuilder.md @@ -0,0 +1,232 @@ +[Packages Index](../../../../../README.md) / [typedoc-plugin-markdown](../../../../README.md) / [theme](../../../README.md) / [core](../README.md) / NavigationBuilder + +# Class: NavigationBuilder + +## Constructors + +### new NavigationBuilder() + +> **new NavigationBuilder**(`theme`, `project`): [`NavigationBuilder`](NavigationBuilder.md) + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `theme` | [`MarkdownTheme`](../../../classes/MarkdownTheme.md) | +| `project` | [`ProjectReflection`](https://typedoc.org/api/classes/Models.ProjectReflection.html) | + +#### Returns + +[`NavigationBuilder`](NavigationBuilder.md) + +#### Defined in + +[packages/typedoc-plugin-markdown/src/theme/core/navigation-builder.ts:25](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/core/navigation-builder.ts#L25) + +## Properties + +### options + +> `private` **options**: [`Options`](https://typedoc.org/api/classes/Configuration.Options.html) + +#### Defined in + +[packages/typedoc-plugin-markdown/src/theme/core/navigation-builder.ts:19](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/core/navigation-builder.ts#L19) + +*** + +### packagesMeta + +> `private` **packagesMeta**: `any` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/theme/core/navigation-builder.ts:20](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/core/navigation-builder.ts#L20) + +*** + +### navigationOptions + +> `private` **navigationOptions**: `any` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/theme/core/navigation-builder.ts:21](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/core/navigation-builder.ts#L21) + +*** + +### navigation + +> `private` **navigation**: [`NavigationItem`](../../types/interfaces/NavigationItem.md)[] = `[]` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/theme/core/navigation-builder.ts:22](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/core/navigation-builder.ts#L22) + +*** + +### isPackages + +> `private` **isPackages**: `boolean` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/theme/core/navigation-builder.ts:23](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/core/navigation-builder.ts#L23) + +*** + +### theme + +> **theme**: [`MarkdownTheme`](../../../classes/MarkdownTheme.md) + +#### Defined in + +[packages/typedoc-plugin-markdown/src/theme/core/navigation-builder.ts:26](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/core/navigation-builder.ts#L26) + +*** + +### project + +> **project**: [`ProjectReflection`](https://typedoc.org/api/classes/Models.ProjectReflection.html) + +#### Defined in + +[packages/typedoc-plugin-markdown/src/theme/core/navigation-builder.ts:27](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/core/navigation-builder.ts#L27) + +## Methods + +### getNavigation() + +> **getNavigation**(): [`NavigationItem`](../../types/interfaces/NavigationItem.md)[] + +#### Returns + +[`NavigationItem`](../../types/interfaces/NavigationItem.md)[] + +#### Defined in + +[packages/typedoc-plugin-markdown/src/theme/core/navigation-builder.ts:40](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/core/navigation-builder.ts#L40) + +*** + +### buildNavigationFromPackage() + +> `private` **buildNavigationFromPackage**(`projectChild`): `void` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `projectChild` | [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html) | + +#### Returns + +`void` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/theme/core/navigation-builder.ts:56](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/core/navigation-builder.ts#L56) + +*** + +### buildNavigationFromProject() + +> `private` **buildNavigationFromProject**(`project`): `void` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `project` | [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html) \| [`ProjectReflection`](https://typedoc.org/api/classes/Models.ProjectReflection.html) | + +#### Returns + +`void` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/theme/core/navigation-builder.ts:117](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/core/navigation-builder.ts#L117) + +*** + +### getCategoryGroupChildren() + +> `private` **getCategoryGroupChildren**(`group`): \{`title`: `string`;`kind`: [`ReflectionKind`](https://typedoc.org/api/enums/Models.ReflectionKind-1.html);`url`: `undefined` \| `string`;`children`: `undefined` \| [`NavigationItem`](../../types/interfaces/NavigationItem.md)[]; \}[] + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `group` | [`ReflectionCategory`](https://typedoc.org/api/types/Models.ReflectionCategory.html) | + +#### Returns + +\{`title`: `string`;`kind`: [`ReflectionKind`](https://typedoc.org/api/enums/Models.ReflectionKind-1.html);`url`: `undefined` \| `string`;`children`: `undefined` \| [`NavigationItem`](../../types/interfaces/NavigationItem.md)[]; \}[] + +#### Defined in + +[packages/typedoc-plugin-markdown/src/theme/core/navigation-builder.ts:190](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/core/navigation-builder.ts#L190) + +*** + +### getGroupChildren() + +> `private` **getGroupChildren**(`group`, `outputFileStrategy`?): `undefined` \| [`NavigationItem`](../../types/interfaces/NavigationItem.md)[] \| \{`title`: `string`;`children`: \{`title`: `string`;`kind`: [`ReflectionKind`](https://typedoc.org/api/enums/Models.ReflectionKind-1.html);`url`: `undefined` \| `string`;`children`: `undefined` \| [`NavigationItem`](../../types/interfaces/NavigationItem.md)[]; \}[]; \}[] + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `group` | [`ReflectionGroup`](https://typedoc.org/api/classes/Models.ReflectionGroup.html) | +| `outputFileStrategy`? | [`OutputFileStrategy`](../../../../options/namespaces/maps/enumerations/OutputFileStrategy.md) | + +#### Returns + +`undefined` \| [`NavigationItem`](../../types/interfaces/NavigationItem.md)[] \| \{`title`: `string`;`children`: \{`title`: `string`;`kind`: [`ReflectionKind`](https://typedoc.org/api/enums/Models.ReflectionKind-1.html);`url`: `undefined` \| `string`;`children`: `undefined` \| [`NavigationItem`](../../types/interfaces/NavigationItem.md)[]; \}[]; \}[] + +#### Defined in + +[packages/typedoc-plugin-markdown/src/theme/core/navigation-builder.ts:207](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/core/navigation-builder.ts#L207) + +*** + +### getReflectionGroups() + +> `private` **getReflectionGroups**(`reflection`, `outputFileStrategy`?): `null` \| [`NavigationItem`](../../types/interfaces/NavigationItem.md)[] + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `reflection` | [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html) \| `DocumentReflection` | +| `outputFileStrategy`? | [`OutputFileStrategy`](../../../../options/namespaces/maps/enumerations/OutputFileStrategy.md) | + +#### Returns + +`null` \| [`NavigationItem`](../../types/interfaces/NavigationItem.md)[] + +#### Defined in + +[packages/typedoc-plugin-markdown/src/theme/core/navigation-builder.ts:252](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/core/navigation-builder.ts#L252) + +*** + +### processChildren() + +> `private` **processChildren**(`acc`, `child`, `children`): [`NavigationItem`](../../types/interfaces/NavigationItem.md)[] + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `acc` | [`NavigationItem`](../../types/interfaces/NavigationItem.md)[] | +| `child` | [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html) \| `DocumentReflection` | +| `children` | `null` \| [`NavigationItem`](../../types/interfaces/NavigationItem.md)[] | + +#### Returns + +[`NavigationItem`](../../types/interfaces/NavigationItem.md)[] + +#### Defined in + +[packages/typedoc-plugin-markdown/src/theme/core/navigation-builder.ts:312](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/core/navigation-builder.ts#L312) diff --git a/developer-docs/typedoc-plugin-markdown/theme/namespaces/core/classes/UrlBuilder.md b/developer-docs/typedoc-plugin-markdown/theme/namespaces/core/classes/UrlBuilder.md new file mode 100644 index 000000000..6dd808760 --- /dev/null +++ b/developer-docs/typedoc-plugin-markdown/theme/namespaces/core/classes/UrlBuilder.md @@ -0,0 +1,460 @@ +[Packages Index](../../../../../README.md) / [typedoc-plugin-markdown](../../../../README.md) / [theme](../../../README.md) / [core](../README.md) / UrlBuilder + +# Class: UrlBuilder + +Map the models of the given project to the desired output files. +Based on TypeDoc DefaultTheme.getUrls() + +## Param + +The project whose urls should be generated. + +## Constructors + +### new UrlBuilder() + +> **new UrlBuilder**(`theme`, `project`): [`UrlBuilder`](UrlBuilder.md) + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `theme` | [`MarkdownTheme`](../../../classes/MarkdownTheme.md) | +| `project` | [`ProjectReflection`](https://typedoc.org/api/classes/Models.ProjectReflection.html) | + +#### Returns + +[`UrlBuilder`](UrlBuilder.md) + +#### Defined in + +[packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts:40](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts#L40) + +## Properties + +### options + +> `private` **options**: [`Options`](https://typedoc.org/api/classes/Configuration.Options.html) + +#### Defined in + +[packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts:30](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts#L30) + +*** + +### packagesMeta + +> `private` **packagesMeta**: `any` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts:31](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts#L31) + +*** + +### fileExtension + +> `private` **fileExtension**: `string` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts:32](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts#L32) + +*** + +### ignoreScopes + +> `private` **ignoreScopes**: `boolean` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts:33](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts#L33) + +*** + +### entryFileName + +> `private` **entryFileName**: `string` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts:34](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts#L34) + +*** + +### isPackages + +> `private` **isPackages**: `boolean` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts:35](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts#L35) + +*** + +### flattenOutputFiles + +> `private` **flattenOutputFiles**: `boolean` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts:36](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts#L36) + +*** + +### urls + +> `private` **urls**: [`UrlMapping`](../../types/interfaces/UrlMapping.md)\<[`Reflection`](https://typedoc.org/api/classes/Models.Reflection.html)\>[] = `[]` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts:37](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts#L37) + +*** + +### anchors + +> `private` **anchors**: `Record`\<`string`, `string`[]\> = `{}` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts:38](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts#L38) + +*** + +### theme + +> **theme**: [`MarkdownTheme`](../../../classes/MarkdownTheme.md) + +#### Defined in + +[packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts:41](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts#L41) + +*** + +### project + +> **project**: [`ProjectReflection`](https://typedoc.org/api/classes/Models.ProjectReflection.html) + +#### Defined in + +[packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts:42](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts#L42) + +## Methods + +### getUrls() + +> **getUrls**(): [`UrlMapping`](../../types/interfaces/UrlMapping.md)\<[`Reflection`](https://typedoc.org/api/classes/Models.Reflection.html)\>[] + +#### Returns + +[`UrlMapping`](../../types/interfaces/UrlMapping.md)\<[`Reflection`](https://typedoc.org/api/classes/Models.Reflection.html)\>[] + +#### Defined in + +[packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts:65](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts#L65) + +*** + +### buildEntryUrls() + +> `private` **buildEntryUrls**(): `void` + +#### Returns + +`void` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts:83](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts#L83) + +*** + +### buildUrlsFromProject() + +> `private` **buildUrlsFromProject**(`project`, `parentUrl`?, `outputFileStrategy`?, `entryModule`?, `entryFileName`?): `void` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `project` | [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html) \| [`ProjectReflection`](https://typedoc.org/api/classes/Models.ProjectReflection.html) | +| `parentUrl`? | `string` | +| `outputFileStrategy`? | [`OutputFileStrategy`](../../../../options/namespaces/maps/enumerations/OutputFileStrategy.md) | +| `entryModule`? | `string` | +| `entryFileName`? | `string` | + +#### Returns + +`void` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts:133](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts#L133) + +*** + +### buildUrlsFromPackage() + +> `private` **buildUrlsFromPackage**(`projectChild`): `void` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `projectChild` | [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html) | + +#### Returns + +`void` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts:157](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts#L157) + +*** + +### buildUrlsForDocument() + +> `private` **buildUrlsForDocument**(`reflection`): `void` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `reflection` | `DocumentReflection` | + +#### Returns + +`void` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts:261](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts#L261) + +*** + +### buildUrlsFromGroup() + +> `private` **buildUrlsFromGroup**(`reflection`, `urlOptions`): `void` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `reflection` | [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html) | +| `urlOptions` | [`UrlOption`](../../types/interfaces/UrlOption.md) | + +#### Returns + +`void` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts:305](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts#L305) + +*** + +### getUrl() + +> `private` **getUrl**(`reflection`, `urlPath`, `urlOptions`): `string` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `reflection` | [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html) | +| `urlPath` | `string` | +| `urlOptions` | [`UrlOption`](../../types/interfaces/UrlOption.md) | + +#### Returns + +`string` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts:373](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts#L373) + +*** + +### getFlattenedUrl() + +> **getFlattenedUrl**(`reflection`): `string` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `reflection` | [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html) | + +#### Returns + +`string` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts:401](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts#L401) + +*** + +### getAlias() + +> `private` **getAlias**(`name`): `string` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `name` | `string` | + +#### Returns + +`string` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts:418](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts#L418) + +*** + +### getUrlPath() + +> `private` **getUrlPath**(`reflection`, `urlOption`): `string` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `reflection` | [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html) | +| `urlOption` | [`UrlOption`](../../types/interfaces/UrlOption.md) | + +#### Returns + +`string` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts:428](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts#L428) + +*** + +### traverseChildren() + +> `private` **traverseChildren**(`reflection`, `container`): `void` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `reflection` | [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html) | +| `container` | [`Reflection`](https://typedoc.org/api/classes/Models.Reflection.html) | + +#### Returns + +`void` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts:476](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts#L476) + +*** + +### applyAnchorUrl() + +> `private` **applyAnchorUrl**(`reflection`, `containerUrl`): `void` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `reflection` | [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html) | +| `containerUrl` | `string` | + +#### Returns + +`void` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts:495](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts#L495) + +*** + +### getAnchorId() + +> `private` **getAnchorId**(`reflection`): `null` \| `string` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `reflection` | [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html) | + +#### Returns + +`null` \| `string` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts:531](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts#L531) + +*** + +### getAnchorName() + +> `private` **getAnchorName**(`reflection`): `null` \| `string` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `reflection` | [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html) | + +#### Returns + +`null` \| `string` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts:543](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts#L543) + +*** + +### moduleHasSubfolders() + +> `private` **moduleHasSubfolders**(`reflection`): `undefined` \| `boolean` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `reflection` | [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html) | + +#### Returns + +`undefined` \| `boolean` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts:571](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts#L571) + +*** + +### getIndexFileName() + +> `private` **getIndexFileName**(`reflection`, `isPackages`): `string` + +#### Parameters + +| Parameter | Type | Default value | +| ------ | ------ | ------ | +| `reflection` | [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html) \| [`ProjectReflection`](https://typedoc.org/api/classes/Models.ProjectReflection.html) | `undefined` | +| `isPackages` | `boolean` | `false` | + +#### Returns + +`string` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts:577](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts#L577) diff --git a/developer-docs/typedoc-plugin-markdown/theme/namespaces/types/README.md b/developer-docs/typedoc-plugin-markdown/theme/namespaces/types/README.md new file mode 100644 index 000000000..782e1068b --- /dev/null +++ b/developer-docs/typedoc-plugin-markdown/theme/namespaces/types/README.md @@ -0,0 +1,21 @@ +[Packages Index](../../../../README.md) / [typedoc-plugin-markdown](../../../README.md) / [theme](../../README.md) / types + +# types + +## Index + +### Interfaces + +| Interface | Description | +| ------ | ------ | +| [PackageMetaData](interfaces/PackageMetaData.md) | The model used to define the package metadata when in packages mode. | +| [UrlMapping](interfaces/UrlMapping.md) | The model used to define the URL mapping structure. | +| [NavigationItem](interfaces/NavigationItem.md) | The model used to define the navigation structure. | +| [TemplateMapping](interfaces/TemplateMapping.md) | - | +| [UrlOption](interfaces/UrlOption.md) | - | + +### Type Aliases + +| Type alias | Description | +| ------ | ------ | +| [RenderTemplate](type-aliases/RenderTemplate.md) | - | diff --git a/developer-docs/typedoc-plugin-markdown/theme/namespaces/types/interfaces/NavigationItem.md b/developer-docs/typedoc-plugin-markdown/theme/namespaces/types/interfaces/NavigationItem.md new file mode 100644 index 000000000..9729de75e --- /dev/null +++ b/developer-docs/typedoc-plugin-markdown/theme/namespaces/types/interfaces/NavigationItem.md @@ -0,0 +1,45 @@ +[Packages Index](../../../../../README.md) / [typedoc-plugin-markdown](../../../../README.md) / [theme](../../../README.md) / [types](../README.md) / NavigationItem + +# Interface: NavigationItem + +The model used to define the navigation structure. + +## Properties + +### title + +> **title**: `string` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/theme/types.ts:29](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/types.ts#L29) + +*** + +### path? + +> `optional` **path**: `null` \| `string` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/theme/types.ts:30](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/types.ts#L30) + +*** + +### kind? + +> `optional` **kind**: [`ReflectionKind`](https://typedoc.org/api/enums/Models.ReflectionKind-1.html) + +#### Defined in + +[packages/typedoc-plugin-markdown/src/theme/types.ts:31](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/types.ts#L31) + +*** + +### children? + +> `optional` **children**: [`NavigationItem`](NavigationItem.md)[] + +#### Defined in + +[packages/typedoc-plugin-markdown/src/theme/types.ts:32](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/types.ts#L32) diff --git a/developer-docs/typedoc-plugin-markdown/theme/namespaces/types/interfaces/PackageMetaData.md b/developer-docs/typedoc-plugin-markdown/theme/namespaces/types/interfaces/PackageMetaData.md new file mode 100644 index 000000000..01c86a89b --- /dev/null +++ b/developer-docs/typedoc-plugin-markdown/theme/namespaces/types/interfaces/PackageMetaData.md @@ -0,0 +1,25 @@ +[Packages Index](../../../../../README.md) / [typedoc-plugin-markdown](../../../../README.md) / [theme](../../../README.md) / [types](../README.md) / PackageMetaData + +# Interface: PackageMetaData + +The model used to define the package metadata when in packages mode. + +## Properties + +### description + +> **description**: `string` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/theme/types.ts:10](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/types.ts#L10) + +*** + +### options + +> **options**: [`Options`](https://typedoc.org/api/classes/Configuration.Options.html) + +#### Defined in + +[packages/typedoc-plugin-markdown/src/theme/types.ts:11](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/types.ts#L11) diff --git a/developer-docs/typedoc-plugin-markdown/theme/namespaces/types/interfaces/TemplateMapping.md b/developer-docs/typedoc-plugin-markdown/theme/namespaces/types/interfaces/TemplateMapping.md new file mode 100644 index 000000000..bd97d48d9 --- /dev/null +++ b/developer-docs/typedoc-plugin-markdown/theme/namespaces/types/interfaces/TemplateMapping.md @@ -0,0 +1,33 @@ +[Packages Index](../../../../../README.md) / [typedoc-plugin-markdown](../../../../README.md) / [theme](../../../README.md) / [types](../README.md) / TemplateMapping + +# Interface: TemplateMapping + +## Properties + +### directory + +> **directory**: `null` \| `string` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/theme/types.ts:38](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/types.ts#L38) + +*** + +### template + +> **template**: `any` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/theme/types.ts:39](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/types.ts#L39) + +*** + +### kind + +> **kind**: [`ReflectionKind`](https://typedoc.org/api/enums/Models.ReflectionKind-1.html) + +#### Defined in + +[packages/typedoc-plugin-markdown/src/theme/types.ts:40](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/types.ts#L40) diff --git a/developer-docs/typedoc-plugin-markdown/theme/namespaces/types/interfaces/UrlMapping.md b/developer-docs/typedoc-plugin-markdown/theme/namespaces/types/interfaces/UrlMapping.md new file mode 100644 index 000000000..b97a2bfe6 --- /dev/null +++ b/developer-docs/typedoc-plugin-markdown/theme/namespaces/types/interfaces/UrlMapping.md @@ -0,0 +1,51 @@ +[Packages Index](../../../../../README.md) / [typedoc-plugin-markdown](../../../../README.md) / [theme](../../../README.md) / [types](../README.md) / UrlMapping + +# Interface: UrlMapping\ + +The model used to define the URL mapping structure. + +## Type Parameters + +| Type Parameter | +| ------ | +| `Model` | + +## Properties + +### url + +> **url**: `string` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/theme/types.ts:19](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/types.ts#L19) + +*** + +### model + +> **model**: `Model` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/theme/types.ts:20](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/types.ts#L20) + +*** + +### template() + +> **template**: (`data`) => `string` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `data` | [`MarkdownPageEvent`](../../../../app/namespaces/events/classes/MarkdownPageEvent.md)\<`Model`\> | + +#### Returns + +`string` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/theme/types.ts:21](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/types.ts#L21) diff --git a/developer-docs/typedoc-plugin-markdown/theme/namespaces/types/interfaces/UrlOption.md b/developer-docs/typedoc-plugin-markdown/theme/namespaces/types/interfaces/UrlOption.md new file mode 100644 index 000000000..4e812a716 --- /dev/null +++ b/developer-docs/typedoc-plugin-markdown/theme/namespaces/types/interfaces/UrlOption.md @@ -0,0 +1,63 @@ +[Packages Index](../../../../../README.md) / [typedoc-plugin-markdown](../../../../README.md) / [theme](../../../README.md) / [types](../README.md) / UrlOption + +# Interface: UrlOption + +## Properties + +### parentUrl? + +> `optional` **parentUrl**: `string` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/theme/types.ts:44](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/types.ts#L44) + +*** + +### directory? + +> `optional` **directory**: `null` \| `string` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/theme/types.ts:45](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/types.ts#L45) + +*** + +### forceDirectory? + +> `optional` **forceDirectory**: `boolean` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/theme/types.ts:46](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/types.ts#L46) + +*** + +### outputFileStrategy? + +> `optional` **outputFileStrategy**: [`OutputFileStrategy`](../../../../options/namespaces/maps/enumerations/OutputFileStrategy.md) + +#### Defined in + +[packages/typedoc-plugin-markdown/src/theme/types.ts:47](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/types.ts#L47) + +*** + +### entryModule? + +> `optional` **entryModule**: `string` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/theme/types.ts:48](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/types.ts#L48) + +*** + +### entryFileName? + +> `optional` **entryFileName**: `string` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/theme/types.ts:49](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/types.ts#L49) diff --git a/developer-docs/typedoc-plugin-markdown/theme/namespaces/types/type-aliases/RenderTemplate.md b/developer-docs/typedoc-plugin-markdown/theme/namespaces/types/type-aliases/RenderTemplate.md new file mode 100644 index 000000000..124f9010e --- /dev/null +++ b/developer-docs/typedoc-plugin-markdown/theme/namespaces/types/type-aliases/RenderTemplate.md @@ -0,0 +1,25 @@ +[Packages Index](../../../../../README.md) / [typedoc-plugin-markdown](../../../../README.md) / [theme](../../../README.md) / [types](../README.md) / RenderTemplate + +# Type Alias: RenderTemplate()\ + +> **RenderTemplate**\<`T`\>: (`data`) => `string` + +## Type Parameters + +| Type Parameter | +| ------ | +| `T` | + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `data` | `T` | + +## Returns + +`string` + +## Defined in + +[packages/typedoc-plugin-markdown/src/theme/types.ts:35](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-markdown/src/theme/types.ts#L35) diff --git a/devtools/packages/fixtures/cli.ts b/devtools/packages/fixtures/cli.ts index 4498a1704..f730048b9 100755 --- a/devtools/packages/fixtures/cli.ts +++ b/devtools/packages/fixtures/cli.ts @@ -41,7 +41,7 @@ async function main() { const outputFileStrategies: ('members' | 'modules')[] = config.outputFileStrategies || ['members', 'modules']; - writeHtml(key, config.entryPoints); + //writeHtml(key, config.entryPoints); outputFileStrategies.forEach((outputFileStrategy) => { config.options.forEach((optionGroup, index: number) => { const options = { diff --git a/devtools/packages/prebuild-options/tasks/generate-models.ts b/devtools/packages/prebuild-options/tasks/generate-models.ts index 043a289be..5b5eb8ca1 100644 --- a/devtools/packages/prebuild-options/tasks/generate-models.ts +++ b/devtools/packages/prebuild-options/tasks/generate-models.ts @@ -36,7 +36,7 @@ import { ManuallyValidatedOption } from 'typedoc'`); if (manuallyValidatedOptions.length) { manuallyValidatedOptions.forEach((option: any) => { - out.push(`import { ${option} } from '../options/option-types';`); + out.push(`import { ${option} } from './options/types';`); }); } diff --git a/devtools/typedoc-plugins/typedoc-default-values.js b/devtools/typedoc-plugins/typedoc-default-values.js new file mode 100644 index 000000000..c3baaa60a --- /dev/null +++ b/devtools/typedoc-plugins/typedoc-default-values.js @@ -0,0 +1,79 @@ +const { Converter, TypeScript, CommentTag, Comment } = require('typedoc'); +const { ModifierFlags } = require('typescript'); + +exports.load = function (app) { + const printer = TypeScript.createPrinter({ + removeComments: true, + omitTrailingSemicolon: true, + }); + + app.converter.on( + Converter.EVENT_CREATE_DECLARATION, + (_context, reflection) => { + const node = + reflection.project.getSymbolFromReflection(reflection) + ?.declarations?.[0]; + + if (!node || !node.initializer) return; + + if ( + (node.initializer.kind === + //TypeScript.SyntaxKind.ObjectLiteralExpression || + node.initializer.kind) === + TypeScript.SyntaxKind.ArrayLiteralExpression + ) { + const defaultValue = printer.printNode( + TypeScript.EmitHint.Expression, + node.initializer, + node.getSourceFile(), + ); + + if (Boolean(reflection.comment)) { + reflection.comment.blockTags = [ + ...(reflection.comment.blockTags || []), + getTag(defaultValue), + ]; + } else { + reflection.comment = new Comment([], [getTag(defaultValue)]); + } + + /* + if (!reflection.comment) { + reflection.comment = new Comment({ + summary: [ + { + kind: 'text', + text: 'defaultValue: ' + defaultValue, + }, + ], + modifierTags: [], + blockTags: [getTag(defaultValue)], + }); + } else { + if (!reflection.comment?.summary) { + reflection.comment.summary = []; + } + + if (reflection.comment?.blockTags) { + reflection.comment.blockTags = [ + ...(reflection.comment?.blockTags || []), + getTag(defaultValue), + ]; + } + }*/ + } + }, + ); +}; +function getTag(value) { + return new CommentTag('@defaultValue', [ + { + kind: 'code', + text: makeCodeBlock(value), + }, + ]); +} + +function makeCodeBlock(text) { + return '```ts\n' + text + '\n```'; +} diff --git a/devtools/typedoc-plugins/typedoc.docs.mjs b/devtools/typedoc-plugins/typedoc.docs.mjs new file mode 100644 index 000000000..4b897567c --- /dev/null +++ b/devtools/typedoc-plugins/typedoc.docs.mjs @@ -0,0 +1,8 @@ +export function load(app) { + app.renderer.markdownHooks.on( + 'packages.content.begin', + () => ` +Please select the package you would like to view documentation for: + `, + ); +} diff --git a/package-lock.json b/package-lock.json index f6c48564c..d58e145f4 100644 --- a/package-lock.json +++ b/package-lock.json @@ -45,7 +45,7 @@ "ts-morph": "^22.0.0", "ts-node": "^10.9.2", "tsc-alias": "^1.8.10", - "typedoc": "^0.26.0-beta.2", + "typedoc": "^0.26.0-beta.3", "typescript": "^5.4.5", "unified-prettier": "^2.0.1" } @@ -22152,9 +22152,9 @@ } }, "node_modules/typedoc": { - "version": "0.26.0-beta.2", - "resolved": "https://registry.npmjs.org/typedoc/-/typedoc-0.26.0-beta.2.tgz", - "integrity": "sha512-sFVUArw13cF8K7jeayUXyVCby9pRsEdjkQSvgnRxL8Wzuow9G7xlrXBhWU1BFBoGK8RC25hXD/4oJmMQhnnEnQ==", + "version": "0.26.0-beta.3", + "resolved": "https://registry.npmjs.org/typedoc/-/typedoc-0.26.0-beta.3.tgz", + "integrity": "sha512-Kqr++JyaFLrzkAgOU46vxsVxI6bePOMbZy/gt6mkDW/isYa0cad92Wuhfxh/17HYxSYBSJ8t2WPTPR75JMY0Wg==", "dependencies": { "lunr": "^2.3.9", "markdown-it": "^14.1.0", diff --git a/package.json b/package.json index 94b606825..95214e260 100644 --- a/package.json +++ b/package.json @@ -12,7 +12,7 @@ ], "scripts": { "docs": "ts-node ./devtools/scripts/generate-readmes && node ./devtools/scripts/tocs.mjs", - "devdocs": "typedoc", + "devdocs": "npm run build --workspace typedoc-plugin-markdown && typedoc", "devdocs:html": "typedoc --options typedoc.html.json", "build-all": "npm run build --workspaces --if-present", "test-all": "npm run test --workspaces --if-present", @@ -51,7 +51,7 @@ "ts-morph": "^22.0.0", "ts-node": "^10.9.2", "tsc-alias": "^1.8.10", - "typedoc": "^0.26.0-beta.2", + "typedoc": "^0.26.0-beta.3", "typescript": "^5.4.5", "unified-prettier": "^2.0.1" } diff --git a/packages/docusaurus-plugin-typedoc/src/defs/typedoc.d.ts b/packages/docusaurus-plugin-typedoc/src/_typedoc.d.ts similarity index 82% rename from packages/docusaurus-plugin-typedoc/src/defs/typedoc.d.ts rename to packages/docusaurus-plugin-typedoc/src/_typedoc.d.ts index a5e85594b..73075d8e9 100644 --- a/packages/docusaurus-plugin-typedoc/src/defs/typedoc.d.ts +++ b/packages/docusaurus-plugin-typedoc/src/_typedoc.d.ts @@ -1,6 +1,6 @@ // THIS FILE IS AUTO GENERATED FROM THE OPTIONS CONFIG. DO NOT EDIT DIRECTLY. import { ManuallyValidatedOption } from 'typedoc'; -import { Sidebar } from '../options/option-types'; +import { Sidebar } from './options/types'; declare module 'typedoc' { export interface TypeDocOptionMap { sidebar: ManuallyValidatedOption; diff --git a/packages/docusaurus-plugin-typedoc/src/models.ts b/packages/docusaurus-plugin-typedoc/src/models.ts index ed5734709..ea079e9ab 100644 --- a/packages/docusaurus-plugin-typedoc/src/models.ts +++ b/packages/docusaurus-plugin-typedoc/src/models.ts @@ -1,5 +1,5 @@ import { PluginOptions as TypedocPluginMarkdownOptions } from 'typedoc-plugin-markdown'; -import { PluginOptions as DocusaurusOptions } from './options/option-types'; +import { PluginOptions as DocusaurusOptions } from './options/types'; export interface PluginOptions extends TypedocPluginMarkdownOptions, diff --git a/packages/docusaurus-plugin-typedoc/src/options/types.ts b/packages/docusaurus-plugin-typedoc/src/options/types.ts new file mode 100644 index 000000000..b353e471e --- /dev/null +++ b/packages/docusaurus-plugin-typedoc/src/options/types.ts @@ -0,0 +1,25 @@ +/** + * Describes the options declared by the plugin. + * + * @privateRemarks + * + * THIS FILE IS AUTO GENERATED FROM THE OPTIONS CONFIG. DO NOT EDIT DIRECTLY + * + * @module + */ +export interface PluginOptions { + /** + * Configures the autogenerated Docusaurus sidebar. + */ + sidebar: Sidebar; +} + +/** + * + * + * @category Options + */ +export interface Sidebar { + autoConfiguration: boolean; + pretty: boolean; +} diff --git a/packages/typedoc-github-wiki-theme/src/defs/typedoc.d.ts b/packages/typedoc-github-wiki-theme/src/_typedoc.d.ts similarity index 82% rename from packages/typedoc-github-wiki-theme/src/defs/typedoc.d.ts rename to packages/typedoc-github-wiki-theme/src/_typedoc.d.ts index a5e85594b..73075d8e9 100644 --- a/packages/typedoc-github-wiki-theme/src/defs/typedoc.d.ts +++ b/packages/typedoc-github-wiki-theme/src/_typedoc.d.ts @@ -1,6 +1,6 @@ // THIS FILE IS AUTO GENERATED FROM THE OPTIONS CONFIG. DO NOT EDIT DIRECTLY. import { ManuallyValidatedOption } from 'typedoc'; -import { Sidebar } from '../options/option-types'; +import { Sidebar } from './options/types'; declare module 'typedoc' { export interface TypeDocOptionMap { sidebar: ManuallyValidatedOption; diff --git a/packages/typedoc-github-wiki-theme/src/options/types.ts b/packages/typedoc-github-wiki-theme/src/options/types.ts new file mode 100644 index 000000000..d55a7c680 --- /dev/null +++ b/packages/typedoc-github-wiki-theme/src/options/types.ts @@ -0,0 +1,25 @@ +/** + * Describes the options declared by the plugin. + * + * @privateRemarks + * + * THIS FILE IS AUTO GENERATED FROM THE OPTIONS CONFIG. DO NOT EDIT DIRECTLY + * + * @module + */ +export interface PluginOptions { + /** + * Configures the autogenerated `_sidebar.md file`. + */ + sidebar: Sidebar; +} + +/** + * + * + * @category Options + */ +export interface Sidebar { + autoConfiguration: boolean; + heading: string; +} diff --git a/packages/typedoc-gitlab-wiki-theme/src/defs/typedoc.d.ts b/packages/typedoc-gitlab-wiki-theme/src/_typedoc.d.ts similarity index 82% rename from packages/typedoc-gitlab-wiki-theme/src/defs/typedoc.d.ts rename to packages/typedoc-gitlab-wiki-theme/src/_typedoc.d.ts index a5e85594b..73075d8e9 100644 --- a/packages/typedoc-gitlab-wiki-theme/src/defs/typedoc.d.ts +++ b/packages/typedoc-gitlab-wiki-theme/src/_typedoc.d.ts @@ -1,6 +1,6 @@ // THIS FILE IS AUTO GENERATED FROM THE OPTIONS CONFIG. DO NOT EDIT DIRECTLY. import { ManuallyValidatedOption } from 'typedoc'; -import { Sidebar } from '../options/option-types'; +import { Sidebar } from './options/types'; declare module 'typedoc' { export interface TypeDocOptionMap { sidebar: ManuallyValidatedOption; diff --git a/packages/typedoc-gitlab-wiki-theme/src/options/types.ts b/packages/typedoc-gitlab-wiki-theme/src/options/types.ts new file mode 100644 index 000000000..cd6a2d0ff --- /dev/null +++ b/packages/typedoc-gitlab-wiki-theme/src/options/types.ts @@ -0,0 +1,25 @@ +/** + * Describes the options declared by the plugin. + * + * @privateRemarks + * + * THIS FILE IS AUTO GENERATED FROM THE OPTIONS CONFIG. DO NOT EDIT DIRECTLY + * + * @module + */ +export interface PluginOptions { + /** + * Configures the autogenerated `_Sidebar.md file`. + */ + sidebar: Sidebar; +} + +/** + * + * + * @category Options + */ +export interface Sidebar { + autoConfiguration: boolean; + heading: string; +} diff --git a/packages/typedoc-plugin-frontmatter/src/defs/typedoc.d.ts b/packages/typedoc-plugin-frontmatter/src/_typedoc.d.ts similarity index 74% rename from packages/typedoc-plugin-frontmatter/src/defs/typedoc.d.ts rename to packages/typedoc-plugin-frontmatter/src/_typedoc.d.ts index 655c5b1a4..d864b1580 100644 --- a/packages/typedoc-plugin-frontmatter/src/defs/typedoc.d.ts +++ b/packages/typedoc-plugin-frontmatter/src/_typedoc.d.ts @@ -1,8 +1,8 @@ // THIS FILE IS AUTO GENERATED FROM THE OPTIONS CONFIG. DO NOT EDIT DIRECTLY. import { ManuallyValidatedOption } from 'typedoc'; -import { FrontmatterGlobals } from '../options/option-types'; -import { IndexFrontmatter } from '../options/option-types'; -import { ReadmeFrontmatter } from '../options/option-types'; +import { FrontmatterGlobals } from './options/types'; +import { IndexFrontmatter } from './options/types'; +import { ReadmeFrontmatter } from './options/types'; declare module 'typedoc' { export interface TypeDocOptionMap { frontmatterCommentTags: any[]; diff --git a/packages/typedoc-plugin-frontmatter/src/options/types.ts b/packages/typedoc-plugin-frontmatter/src/options/types.ts new file mode 100644 index 000000000..6184d73a7 --- /dev/null +++ b/packages/typedoc-plugin-frontmatter/src/options/types.ts @@ -0,0 +1,61 @@ +/** + * Describes the options declared by the plugin. + * + * @privateRemarks + * + * THIS FILE IS AUTO GENERATED FROM THE OPTIONS CONFIG. DO NOT EDIT DIRECTLY + * + * @module + */ +export interface PluginOptions { + /** + * Specify which comment block tags should be added to frontmatter. + */ + frontmatterCommentTags: any[]; + + /** + * Specify static variables to be added to all frontmatter blocks. + */ + frontmatterGlobals: FrontmatterGlobals; + + /** + * The naming convention that variables should be output as. + */ + frontmatterNamingConvention: 'camelCase' | 'snakeCase'; + + /** + * Specify static variables to be added to the index page only. + */ + indexFrontmatter: IndexFrontmatter; + + /** + * Preserve tags defined in frontmatter block tags in output. + */ + preserveFrontmatterCommentTags: boolean; + + /** + * Specify static variables to be added to the readme page only. + */ + readmeFrontmatter: ReadmeFrontmatter; +} + +/** + * + * + * @category Options + */ +export interface FrontmatterGlobals {} + +/** + * + * + * @category Options + */ +export interface IndexFrontmatter {} + +/** + * + * + * @category Options + */ +export interface ReadmeFrontmatter {} diff --git a/packages/typedoc-plugin-frontmatter/typedoc.json b/packages/typedoc-plugin-frontmatter/typedoc.json index bb73a1c4c..205a7f493 100644 --- a/packages/typedoc-plugin-frontmatter/typedoc.json +++ b/packages/typedoc-plugin-frontmatter/typedoc.json @@ -1,4 +1,3 @@ { - "extends": ["../../typedoc.base.json"], "entryPoints": ["./src"] } diff --git a/packages/typedoc-plugin-markdown/.docs/plugins/typedoc-default-values.js b/packages/typedoc-plugin-markdown/.docs/plugins/typedoc-default-values.js deleted file mode 100644 index db7ff15c8..000000000 --- a/packages/typedoc-plugin-markdown/.docs/plugins/typedoc-default-values.js +++ /dev/null @@ -1,41 +0,0 @@ -const { Converter, TypeScript } = require('typedoc'); - -exports.load = function ({ application }) { - /** @type {Map} */ - const defaultValues = new Map(); - - const printer = TypeScript.createPrinter({ - removeComments: true, - omitTrailingSemicolon: true, - }); - - application.converter.on( - Converter.EVENT_CREATE_DECLARATION, - (_context, reflection) => { - const node = - reflection.project.getSymbolFromReflection(reflection) - ?.declarations?.[0]; - if (!node || !node.initializer) return; - - if ( - node.initializer.kind === TypeScript.SyntaxKind.ObjectLiteralExpression - ) { - defaultValues.set( - reflection, - printer.printNode( - TypeScript.EmitHint.Expression, - node.initializer, - node.getSourceFile(), - ), - ); - } - }, - ); - - application.converter.on(Converter.EVENT_RESOLVE_BEGIN, () => { - for (const [refl, init] of defaultValues) { - refl.defaultValue = init; - } - defaultValues.clear(); - }); -}; diff --git a/packages/typedoc-plugin-markdown/.gitignore b/packages/typedoc-plugin-markdown/.gitignore new file mode 100644 index 000000000..42ca75dd6 --- /dev/null +++ b/packages/typedoc-plugin-markdown/.gitignore @@ -0,0 +1 @@ +playground/docs \ No newline at end of file diff --git a/packages/typedoc-plugin-markdown/.scripts/schema/get-scheme.cjs b/packages/typedoc-plugin-markdown/.scripts/schema/get-scheme.cjs index 0d3fc3b06..e31132b87 100755 --- a/packages/typedoc-plugin-markdown/.scripts/schema/get-scheme.cjs +++ b/packages/typedoc-plugin-markdown/.scripts/schema/get-scheme.cjs @@ -2,7 +2,7 @@ module.exports = { getSchema: async () => { /** @type {import('ts-json-schema-generator/dist/src/Config').Config} */ const config = { - path: './src/options/option-types.ts', + path: './src/options/types.ts', tsconfig: './.scripts/schema/tsconfig.schema.json', type: 'PluginOptions', topRef: false, diff --git a/packages/typedoc-plugin-markdown/CONTRIBUTING.md b/packages/typedoc-plugin-markdown/CONTRIBUTING.md new file mode 100644 index 000000000..a5cf70e21 --- /dev/null +++ b/packages/typedoc-plugin-markdown/CONTRIBUTING.md @@ -0,0 +1,170 @@ +# Contributing to "typedoc-plugin-markdown" + +Thank you for showing interest in contributing to the project. + +This package is the core package of the repository monorepo. For a general overview and machine setup please see the [root-level contributing guide](../../CONTRIBUTING.md). + +## Overview + +The best place to start is to have a look at the code in the [`src`](./src) directory. +You can also view the [auto-generated code docs]() to gain an understanding of code structure and architecture. +These docs will be referred to throughout the guide. + +## Getting Started + +To get started we can spin up a simple playground environment. + +### Run the playground + +To get started you can create a simple task of running a playground and editing a template. + +#### 1. Setup project + +If you have not done this yet please see [Machine Setup]() in the overall contributing docs for the project. + +#### 2. cd into package + +From the repository root cd into package. + +```shell +cd packages/typedoc-plugin-markdown +``` + +#### 3. Run playground docs + +> This will run several pre-build tasks. You don't need to worry about this for now but is explained in [Prebuild Tasks]() section. + +```shell +npm run playground +``` + +### Viewing the docs + +The above commands will generate some the markdown docs in the `./playground/docs` folder. + +You may find it easier to visually view the docs in a browser. You have 2 options. + +1. Using [Markdown Viewer](https://chromewebstore.google.com/detail/markdown-viewer/ckkdlimhmcjmikdlpkmbgfkaikojcbjk?hl=en&pli=1) chrome extension and viewing the docs as a local file through the browser. +2. Using [markserv](https://www.npmjs.com/package/markserv) and spinning up the docs folder on a server. + +We will use option 2 as an example here: + +1. Install `markserv` globally. + +``` + npm i -g markserv +``` + +2. View the playground in the browser: + +``` +markserv ./playground/docs/README.md +``` + +## Development Tasks + +> _We are simply detailing the steps to perform tasks here. If you would like a deeper dive into the code please visit the [automated code docs]()._ + +Now we have a playground setup we can perform some typical development tasks. + +For the sake of demo task we will + +1. Customize some output (add a timestamp to the page template). +2. Introduce an option to format the date. +3. Finally add some localization support. + +### 1. Customize Some Output + +Templates and Partials are provided by the inbuilt theme context. + +Lets say we wanted to add a timestamp to the main template. + +1. Open up the index template located at `packages/index.ts`. + +2. Add the current date after the defining the `const md= []`; + +```ts +const md: string[] = []; + +md.push(`Updated: ${new Date().toUTCString()}`); +``` + +_We use an array to build up strings and then join them with new lines. This is a good and common practice especially when you need to construct complex strings or handle multi-line text and is easier to manage than pure template literals._ + +3. Run the playground again (we don't currently have any live reloading development capability) + +``` +npm run playground +``` + +4. View the `README.md` again and you should see the timestamp added to the top of the page. + +### 2. Add a New Option + +Options exposed to TypeDoc are added as a named export to the declarations `declarations.ts` options config file. + +```ts +/** + * Some more detailed comments about the option. + * + * @category UI + */ +export const myNewOption: Partial = { + help: 'A short description of the option.', + type: ParameterType.Boolean, + defaultValue: false, +}; +``` + +This will be exposed to TypeDoc as a new option when bootstrapping the plugin, with the name of the option the name of the exported variable. + +In addition, when the `prebuild` task is run: + +- The option type will be added to `TypeDocOptionsMap`. +- The documentation will be updated using the JSDoc comments. + +### 3. Add a new locale + +TODO + +## Prebuild Tasks + +TODO + +- Prebuild options +- Prebuild docs +- Prebuild theme resources + +## Linting + +TODO + +- markdownlint +- remark-mdx + +## Testing + +### Running tests + +```bash +npm run test +``` + +If you require to update the snapshots run the following command: + +```bash +npm run test:update +``` + +### Test Fixtures + +A series of snapshot tests are used to ensure the output of the plugin is consistent. + +- Example code for fixtures are located at `/test/fixtures/src`. +- Fixtures output scenarios are setup using a config file (`/test/fixtures/config.ts`) that provides a mechanism to easily provide a combination of options. + +## Submitting a PR + +- Please open pull requests against the `next` branch. +- Please provide a clear description of what the change is. +- Commit lint diff --git a/packages/typedoc-plugin-markdown/DEVELOP.md b/packages/typedoc-plugin-markdown/DEVELOP.md deleted file mode 100644 index 5f84a19c1..000000000 --- a/packages/typedoc-plugin-markdown/DEVELOP.md +++ /dev/null @@ -1,9 +0,0 @@ -# typedoc-plugin-markdown - -This guide will help you get started: - -The code is divided into some understandable areas. - -- Have a look at the { @link bootstrap } module to see how plugin is initialized. -- See the { @link theme } module contains the custom Markdown theme that is exposed. -- The { @link libs } module contains general pure methods and functions. diff --git a/packages/typedoc-plugin-markdown/developer-docs/README.md b/packages/typedoc-plugin-markdown/developer-docs/README.md deleted file mode 100644 index 48efc1f43..000000000 --- a/packages/typedoc-plugin-markdown/developer-docs/README.md +++ /dev/null @@ -1,27 +0,0 @@ -# typedoc-plugin-markdown - -This guide will help you get started: - -The code is divided into some understandable areas. - -* Have a look at the bootstrap module to see how plugin is initialized. -* See the [ theme ](theme/README.md) module contains the custom Markdown theme that is exposed. -* The [ libs ](libs/README.md) module contains general pure methods and functions. - -## typedoc-plugin-markdown v4.0.3 - -### Documents - -| Member | Description | -| --------------------------------------------- | ----------- | -| [Adding Options](documents/Adding-Options.md) | - | - -### Modules - -| Module | Description | -| ------------------------------------------------------ | ----------------------------------------------------------------- | -| [app](app/README.md) | Contains all the events and overrides of the typedoc Application. | -| [options](options/README.md) | Configures plugin options. | -| [internationalization](internationalization/README.md) | Exposes additional i18n keys and translations used by the theme. | -| [theme](theme/README.md) | This is the built-in Markdown theme. | -| [libs](libs/README.md) | General pure library functions to be consumed across the plugin. | diff --git a/packages/typedoc-plugin-markdown/developer-docs/app/README.md b/packages/typedoc-plugin-markdown/developer-docs/app/README.md deleted file mode 100644 index 2b0489317..000000000 --- a/packages/typedoc-plugin-markdown/developer-docs/app/README.md +++ /dev/null @@ -1,16 +0,0 @@ -[typedoc-plugin-markdown v4.0.3](../README.md) / app - -# app - -Contains all the events and overrides of the typedoc Application. - -## Index - -### Namespaces - -| Namespace | Description | -| --------------------------------------------- | ----------------------------------------------------------------------------- | -| [initialize](namespaces/initialize/README.md) | Initialization and bootstrapping of the plugin. | -| [events](namespaces/events/README.md) | Contains all the events and overrides of the typedoc Application. | -| [renderer](namespaces/renderer/README.md) | Contains override methods to decouple HTML logic from the TypeDoc's Renderer} | -| [types](namespaces/types/README.md) | Types used for the app. | diff --git a/packages/typedoc-plugin-markdown/developer-docs/app/namespaces/events/README.md b/packages/typedoc-plugin-markdown/developer-docs/app/namespaces/events/README.md deleted file mode 100644 index f43cf6057..000000000 --- a/packages/typedoc-plugin-markdown/developer-docs/app/namespaces/events/README.md +++ /dev/null @@ -1,18 +0,0 @@ -[typedoc-plugin-markdown v4.0.3](../../../README.md) / [app](../../README.md) / events - -# Namespace: events - -Contains all the events and overrides of the typedoc Application. - -## Table of Contents - -* [Index](#index) - -## Index - -### Classes - -| Class | Description | -| --------------------------------------------------------- | ---------------------------------------------------------------------- | -| [MarkdownPageEvent](classes/MarkdownPageEvent.md) | An event emitted by before and after the markup of a page is rendered. | -| [MarkdownRendererEvent](classes/MarkdownRendererEvent.md) | An event emitted at the beginning and end of the rendering process. | diff --git a/packages/typedoc-plugin-markdown/developer-docs/app/namespaces/events/classes/MarkdownRendererEvent.md b/packages/typedoc-plugin-markdown/developer-docs/app/namespaces/events/classes/MarkdownRendererEvent.md deleted file mode 100644 index 3cc5b47e1..000000000 --- a/packages/typedoc-plugin-markdown/developer-docs/app/namespaces/events/classes/MarkdownRendererEvent.md +++ /dev/null @@ -1,105 +0,0 @@ -[typedoc-plugin-markdown v4.0.3](../../../../README.md) / [app](../../../README.md) / [events](../README.md) / MarkdownRendererEvent - -# Class: MarkdownRendererEvent - -An event emitted at the beginning and end of the rendering process. - -```ts -app.renderer.on(MarkdownRendererEvent.BEGIN, (event) => { - console.log(`Render Starting for ${event.project.name}!`); -}); -``` - -## Table of Contents - -* [Extends](#extends) -* [Events](#events) -* [Properties](#properties) - -## Extends - -* [`Event`](https://typedoc.org/api/classes/Event.html) - -## Events - -### BEGIN - -```ts -static readonly BEGIN: "beginRender" = 'beginRender'; -``` - -Triggered before the renderer starts rendering a project. - -#### Defined in - -[packages/typedoc-plugin-markdown/src/app/events/markdown-renderer-event.ts:41](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/app/events/markdown-renderer-event.ts#L41) - -*** - -### END - -```ts -static readonly END: "endRender" = 'endRender'; -``` - -Triggered after the renderer has written all documents. - -#### Defined in - -[packages/typedoc-plugin-markdown/src/app/events/markdown-renderer-event.ts:47](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/app/events/markdown-renderer-event.ts#L47) - -## Properties - -### project - -```ts -readonly project: ProjectReflection; -``` - -The project the renderer is currently processing. - -#### Defined in - -[packages/typedoc-plugin-markdown/src/app/events/markdown-renderer-event.ts:20](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/app/events/markdown-renderer-event.ts#L20) - -*** - -### outputDirectory - -```ts -readonly outputDirectory: string; -``` - -The path of the directory the documentation should be written to. - -#### Defined in - -[packages/typedoc-plugin-markdown/src/app/events/markdown-renderer-event.ts:25](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/app/events/markdown-renderer-event.ts#L25) - -*** - -### urls? - -```ts -optional urls: UrlMapping[]; -``` - -A list of all pages that should be generated. - -#### Defined in - -[packages/typedoc-plugin-markdown/src/app/events/markdown-renderer-event.ts:30](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/app/events/markdown-renderer-event.ts#L30) - -*** - -### navigation? - -```ts -optional navigation: NavigationItem[]; -``` - -The navigation structure of the project that can be utilised by plugins. - -#### Defined in - -[packages/typedoc-plugin-markdown/src/app/events/markdown-renderer-event.ts:35](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/app/events/markdown-renderer-event.ts#L35) diff --git a/packages/typedoc-plugin-markdown/developer-docs/app/namespaces/initialize/README.md b/packages/typedoc-plugin-markdown/developer-docs/app/namespaces/initialize/README.md deleted file mode 100644 index a816523c3..000000000 --- a/packages/typedoc-plugin-markdown/developer-docs/app/namespaces/initialize/README.md +++ /dev/null @@ -1,54 +0,0 @@ -[typedoc-plugin-markdown v4.0.3](../../../README.md) / [app](../../README.md) / initialize - -# Namespace: initialize - -Initialization and bootstrapping of the plugin. - -## Table of Contents - -* [load()](#load) - -## load() - -```ts -function load(app): void -``` - -This method is exposed to the `"plugin"` configuration option and contains all initialization functionality. - -### Parameters - -| Parameter | Type | Description | -| --------- | ----------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| `app` | [`Application`](https://typedoc.org/api/classes/Application.html) | When loaded TypeDoc provides an instance of the Application referred to as the `"pluginHost"`. | - -### Returns - -`void` - -### Remarks - -The following initialization steps are taken in this method: - -**1. Declare options:** - -* Iterate over declaration definitions and to the container. - -**2. Replace default theme:** - -* Replace the default HTML theme the with the [MarkdownTheme](../../../theme/classes/MarkdownTheme.md) - -**3. Override TypeDoc methods:** - -* Intercept and modify some TypeDoc core methods that are coupled to the HTML theme. - **4. Configure localization:** - -* Load the additional translations used by the theme for the selected language. - -### See - -[https://typedoc.org/guides/development/#plugins](https://typedoc.org/guides/development/#plugins). - -### Defined in - -[packages/typedoc-plugin-markdown/src/app/\_initialize.ts:49](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/app/_initialize.ts#L49) diff --git a/packages/typedoc-plugin-markdown/developer-docs/app/namespaces/renderer/README.md b/packages/typedoc-plugin-markdown/developer-docs/app/namespaces/renderer/README.md deleted file mode 100644 index 23c8c8c94..000000000 --- a/packages/typedoc-plugin-markdown/developer-docs/app/namespaces/renderer/README.md +++ /dev/null @@ -1,96 +0,0 @@ -[typedoc-plugin-markdown v4.0.3](../../../README.md) / [app](../../README.md) / renderer - -# Namespace: renderer - -Contains override methods to decouple HTML logic from the TypeDoc's Renderer} - -## Table of Contents - -* [generateDocs()](#generatedocs) -* [render()](#render) -* [resolvePackages()](#resolvepackages) - -## generateDocs() - -```ts -function generateDocs(project, out): Promise -``` - -Replacement of TypeDoc's Application.generateDocs method to decouple HTML logic. - -### Parameters - -| Parameter | Type | -| --------- | ------------------------------------------------------------------------------------ | -| `project` | [`ProjectReflection`](https://typedoc.org/api/classes/Models.ProjectReflection.html) | -| `out` | `string` | - -### Returns - -`Promise`\<`void`> - -### Defined in - -[packages/typedoc-plugin-markdown/src/app/renderer.ts:26](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/app/renderer.ts#L26) - -*** - -## render() - -```ts -function render(project, outputDirectory): Promise -``` - -Replacement of TypeDoc's Renderer.render method to decouple HTML logic. - -This is essentially a copy of the base method with a few tweaks. - -* Removes unnecessary async calls to load highlighters only required for html theme. -* Removes hooks logic that are jsx specific. -* Adds any logic specific to markdown rendering. - -### Parameters - -| Parameter | Type | -| ----------------- | ------------------------------------------------------------------------------------ | -| `project` | [`ProjectReflection`](https://typedoc.org/api/classes/Models.ProjectReflection.html) | -| `outputDirectory` | `string` | - -### Returns - -`Promise`\<`void`> - -### Defined in - -[packages/typedoc-plugin-markdown/src/app/renderer.ts:48](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/app/renderer.ts#L48) - -*** - -## resolvePackages() - -```ts -function resolvePackages( - app, - context, - packageDir): void -``` - -Currently options set for packages are only stored on the converter and are destroyed before being passed to the Renderer. - -By intercepting the package options set in the converter and storing them on the renderer we can use them later in the theme. - -### Parameters - -| Parameter | Type | -| ------------ | ----------------------------------------------------------------- | -| `app` | [`Application`](https://typedoc.org/api/classes/Application.html) | -| `context` | `Context` | -| `packageDir` | `string` | - -### Returns - -`void` - -### Defined in - -[packages/typedoc-plugin-markdown/src/app/renderer.ts:145](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/app/renderer.ts#L145) diff --git a/packages/typedoc-plugin-markdown/developer-docs/app/namespaces/types/README.md b/packages/typedoc-plugin-markdown/developer-docs/app/namespaces/types/README.md deleted file mode 100644 index 2a81f74ff..000000000 --- a/packages/typedoc-plugin-markdown/developer-docs/app/namespaces/types/README.md +++ /dev/null @@ -1,19 +0,0 @@ -[typedoc-plugin-markdown v4.0.3](../../../README.md) / [app](../../README.md) / types - -# Namespace: types - -Types used for the app. - -## Table of Contents - -* [Index](#index) - -## Index - -### Interfaces - -| Interface | Description | -| ------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [MarkdownApplication](interfaces/MarkdownApplication.md) | This interface is essentially an extended typing of TypeDoc's [`Application`](https://typedoc.org/api/classes/Application.html) instance. | -| [MarkdownRendererHooks](interfaces/MarkdownRendererHooks.md) | Describes the hooks available to inject output in the markdown theme. | -| [MarkdownRenderer](interfaces/MarkdownRenderer.md) | An extended typing of TypeDoc's [`Renderer`](https://typedoc.org/api/classes/Renderer.html) class that includes updated typings for hooks and async jobs. | diff --git a/packages/typedoc-plugin-markdown/developer-docs/app/namespaces/types/interfaces/MarkdownApplication.md b/packages/typedoc-plugin-markdown/developer-docs/app/namespaces/types/interfaces/MarkdownApplication.md deleted file mode 100644 index c5384b91f..000000000 --- a/packages/typedoc-plugin-markdown/developer-docs/app/namespaces/types/interfaces/MarkdownApplication.md +++ /dev/null @@ -1,43 +0,0 @@ -[typedoc-plugin-markdown v4.0.3](../../../../README.md) / [app](../../../README.md) / [types](../README.md) / MarkdownApplication - -# Interface: MarkdownApplication - -This interface is essentially an extended typing of TypeDoc's [`Application`](https://typedoc.org/api/classes/Application.html) instance. - -## Table of Contents - -* [Example](#example) -* [Extends](#extends) -* [Properties](#properties) - -## Example - -```ts -import { MarkdownApplication } from 'typedoc-plugin-markdown'; - -export function load(app: MarkdownApplication) { - ... -} -``` - -## Extends - -* [`Application`](https://typedoc.org/api/classes/Application.html) - -## Properties - -### renderer - -```ts -renderer: MarkdownRenderer; -``` - -Re-types the `renderer` instance to [`MarkdownRenderer`](MarkdownRenderer.md). - -#### Overrides - -`Application.renderer` - -#### Defined in - -[packages/typedoc-plugin-markdown/src/app/types/markdown-application.ts:22](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/app/types/markdown-application.ts#L22) diff --git a/packages/typedoc-plugin-markdown/developer-docs/app/namespaces/types/interfaces/MarkdownRenderer.md b/packages/typedoc-plugin-markdown/developer-docs/app/namespaces/types/interfaces/MarkdownRenderer.md deleted file mode 100644 index 7bec5bff3..000000000 --- a/packages/typedoc-plugin-markdown/developer-docs/app/namespaces/types/interfaces/MarkdownRenderer.md +++ /dev/null @@ -1,130 +0,0 @@ -[typedoc-plugin-markdown v4.0.3](../../../../README.md) / [app](../../../README.md) / [types](../README.md) / MarkdownRenderer - -# Interface: MarkdownRenderer - -An extended typing of TypeDoc's [`Renderer`](https://typedoc.org/api/classes/Renderer.html) class that includes updated typings for hooks and async jobs. - -## Table of Contents - -* [Example](#example) -* [Extends](#extends) -* [Properties](#properties) - -## Example - -```ts -import { MarkdownApplication } from 'typedoc-plugin-markdown'; - -export function load(app: MarkdownApplication) { - -app.renderer.markdownHooks.on( - 'page.begin', () => '> This is some markdown at the top of the page', -); - -app.renderer.preRenderAsyncJobs.push(async (output: MarkdownRendererEvent) => { - await doSomethingAsync(output); -}); - -app.renderer.postRenderAsyncJobs.push(async (output: MarkdownRendererEvent)) => { - await doSomethingAsync(output); -}); - -} -``` - -## Extends - -* [`Renderer`](https://typedoc.org/api/classes/Renderer.html) - -## Properties - -### markdownHooks - -```ts -markdownHooks: EventHooks; -``` - -Replaces the event hooks typings the [`MarkdownRendererHooks`](MarkdownRendererHooks.md) used by the plugin. - -#### Defined in - -[packages/typedoc-plugin-markdown/src/app/types/markdown-renderer.ts:36](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/app/types/markdown-renderer.ts#L36) - -*** - -### packagesMeta - -`Internal` - -```ts -packagesMeta: Record; -``` - -#### Defined in - -[packages/typedoc-plugin-markdown/src/app/types/markdown-renderer.ts:38](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/app/types/markdown-renderer.ts#L38) - -*** - -### defineTheme() - -`Internal` - -```ts -defineTheme: (name, theme) => void; -``` - -#### Parameters - -| Parameter | Type | -| --------- | ----------------------------------------------------------------------------- | -| `name` | `string` | -| `theme` | (`renderer`) => [`MarkdownTheme`](../../../../theme/classes/MarkdownTheme.md) | - -#### Returns - -`void` - -#### Overrides - -`Renderer.defineTheme` - -#### Defined in - -[packages/typedoc-plugin-markdown/src/app/types/markdown-renderer.ts:40](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/app/types/markdown-renderer.ts#L40) - -*** - -### preRenderAsyncJobs - -```ts -preRenderAsyncJobs: (output) => Promise[]; -``` - -Re-types the returned argument argument to [`MarkdownRendererEvent`](../../events/classes/MarkdownRendererEvent.md). - -#### Overrides - -`Renderer.preRenderAsyncJobs` - -#### Defined in - -[packages/typedoc-plugin-markdown/src/app/types/markdown-renderer.ts:47](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/app/types/markdown-renderer.ts#L47) - -*** - -### postRenderAsyncJobs - -```ts -postRenderAsyncJobs: (output) => Promise[]; -``` - -Re-types the returned argument argument to [`MarkdownRendererEvent`](../../events/classes/MarkdownRendererEvent.md). - -#### Overrides - -`Renderer.postRenderAsyncJobs` - -#### Defined in - -[packages/typedoc-plugin-markdown/src/app/types/markdown-renderer.ts:51](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/app/types/markdown-renderer.ts#L51) diff --git a/packages/typedoc-plugin-markdown/developer-docs/app/namespaces/types/interfaces/MarkdownRendererHooks.md b/packages/typedoc-plugin-markdown/developer-docs/app/namespaces/types/interfaces/MarkdownRendererHooks.md deleted file mode 100644 index 495e3014d..000000000 --- a/packages/typedoc-plugin-markdown/developer-docs/app/namespaces/types/interfaces/MarkdownRendererHooks.md +++ /dev/null @@ -1,89 +0,0 @@ -[typedoc-plugin-markdown v4.0.3](../../../../README.md) / [app](../../../README.md) / [types](../README.md) / MarkdownRendererHooks - -# Interface: MarkdownRendererHooks - -Describes the hooks available to inject output in the markdown theme. - -## Table of Contents - -* [Example](#example) -* [Hooks](#hooks) - -## Example - -```ts - app.renderer.markdownHooks.on( - 'page.end', - () => `**Generated using \`page.end\` hook**`, -); -``` - -## Hooks - -### page.begin - -```ts -page.begin: [MarkdownThemeContext]; -``` - -Applied at the start of the markdown output. - -#### Defined in - -[packages/typedoc-plugin-markdown/src/app/types/markdown-renderer-hooks.ts:22](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/app/types/markdown-renderer-hooks.ts#L22) - -*** - -### page.end - -```ts -page.end: [MarkdownThemeContext]; -``` - -Applied at the end of the markdown output. - -#### Defined in - -[packages/typedoc-plugin-markdown/src/app/types/markdown-renderer-hooks.ts:29](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/app/types/markdown-renderer-hooks.ts#L29) - -*** - -### content.begin - -```ts -content.begin: [MarkdownThemeContext]; -``` - -Applied before the main markdown content is rendered. - -#### Defined in - -[packages/typedoc-plugin-markdown/src/app/types/markdown-renderer-hooks.ts:36](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/app/types/markdown-renderer-hooks.ts#L36) - -*** - -### index.page.begin - -```ts -index.page.begin: [MarkdownThemeContext]; -``` - -Applied at the start of the markdown output on the index page. - -#### Defined in - -[packages/typedoc-plugin-markdown/src/app/types/markdown-renderer-hooks.ts:43](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/app/types/markdown-renderer-hooks.ts#L43) - -*** - -### index.page.end - -```ts -index.page.end: [MarkdownThemeContext]; -``` - -Applied at the end of the markdown output on the index page. - -#### Defined in - -[packages/typedoc-plugin-markdown/src/app/types/markdown-renderer-hooks.ts:50](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/app/types/markdown-renderer-hooks.ts#L50) diff --git a/packages/typedoc-plugin-markdown/developer-docs/documents/Adding-Options.md b/packages/typedoc-plugin-markdown/developer-docs/documents/Adding-Options.md deleted file mode 100644 index f06afcaa1..000000000 --- a/packages/typedoc-plugin-markdown/developer-docs/documents/Adding-Options.md +++ /dev/null @@ -1,3 +0,0 @@ -[typedoc-plugin-markdown v4.0.3](../README.md) / Adding Options - -# How to add options diff --git a/packages/typedoc-plugin-markdown/developer-docs/internationalization/README.md b/packages/typedoc-plugin-markdown/developer-docs/internationalization/README.md deleted file mode 100644 index 9cdee5e51..000000000 --- a/packages/typedoc-plugin-markdown/developer-docs/internationalization/README.md +++ /dev/null @@ -1,15 +0,0 @@ -[typedoc-plugin-markdown v4.0.3](../README.md) / internationalization - -# internationalization - -Exposes additional i18n keys and translations used by the theme. - -## Index - -### Namespaces - -| Namespace | Description | -| ------------------------------------------------- | ------------------------------------------------ | -| [locales](namespaces/locales/README.md) | List of plugin specific translations per locale. | -| [translatable](namespaces/translatable/README.md) | Translations methods. | -| [types](namespaces/types/README.md) | Internationalization types. | diff --git a/packages/typedoc-plugin-markdown/developer-docs/internationalization/namespaces/locales/README.md b/packages/typedoc-plugin-markdown/developer-docs/internationalization/namespaces/locales/README.md deleted file mode 100644 index 6010ed7ad..000000000 --- a/packages/typedoc-plugin-markdown/developer-docs/internationalization/namespaces/locales/README.md +++ /dev/null @@ -1,62 +0,0 @@ -[typedoc-plugin-markdown v4.0.3](../../../README.md) / [internationalization](../../README.md) / locales - -# Namespace: locales - -List of plugin specific translations per locale. - -## Table of Contents - -* [en](#en) -* [ko](#ko) - -## en - -```ts -const en: TranslatableStrings = { - theme_default_value: 'Default value', - theme_default_type: 'Default type', - theme_description: 'Description', - theme_event: 'Event', - theme_extends: 'Extends', - theme_extended_by: 'Extended by', - theme_member: 'Member', - theme_member_plural: 'Members', - theme_modifier: 'Modifier', - theme_name: 'Name', - theme_packages: 'Packages', - theme_type: 'Type', - theme_value: 'Value', - theme_version: 'Version', -}; -``` - -### Defined in - -[packages/typedoc-plugin-markdown/src/internationalization/locales/en.ts:3](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/internationalization/locales/en.ts#L3) - -*** - -## ko - -```ts -const ko: Partial = { - theme_default_value: '기본 값', - theme_default_type: '기본 유형', - theme_description: '설명', - theme_event: '이벤트', - theme_extends: '확장', - theme_extended_by: '에 의해 확장됨', - theme_member: '멤버', - theme_member_plural: '멤버들', - theme_modifier: '수정자', - theme_name: '이름', - theme_packages: '패키지', - theme_type: '유형', - theme_value: '값', - theme_version: '버전', -}; -``` - -### Defined in - -[packages/typedoc-plugin-markdown/src/internationalization/locales/ko.ts:3](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/internationalization/locales/ko.ts#L3) diff --git a/packages/typedoc-plugin-markdown/developer-docs/internationalization/namespaces/translatable/README.md b/packages/typedoc-plugin-markdown/developer-docs/internationalization/namespaces/translatable/README.md deleted file mode 100644 index c87f9bb41..000000000 --- a/packages/typedoc-plugin-markdown/developer-docs/internationalization/namespaces/translatable/README.md +++ /dev/null @@ -1,33 +0,0 @@ -[typedoc-plugin-markdown v4.0.3](../../../README.md) / [internationalization](../../README.md) / translatable - -# Namespace: translatable - -Translations methods. - -## Table of Contents - -* [getTranslatable()](#gettranslatable) - -## getTranslatable() - -```ts -function getTranslatable(app): any -``` - -Returns subset of translatable strings for the plugin. - -These will then be merged with the main set of TypeDoc string. - -### Parameters - -| Parameter | Type | -| --------- | ----------------------------------------------------------------- | -| `app` | [`Application`](https://typedoc.org/api/classes/Application.html) | - -### Returns - -`any` - -### Defined in - -[packages/typedoc-plugin-markdown/src/internationalization/translatable.ts:14](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/internationalization/translatable.ts#L14) diff --git a/packages/typedoc-plugin-markdown/developer-docs/internationalization/namespaces/types/README.md b/packages/typedoc-plugin-markdown/developer-docs/internationalization/namespaces/types/README.md deleted file mode 100644 index 3bec5b70e..000000000 --- a/packages/typedoc-plugin-markdown/developer-docs/internationalization/namespaces/types/README.md +++ /dev/null @@ -1,17 +0,0 @@ -[typedoc-plugin-markdown v4.0.3](../../../README.md) / [internationalization](../../README.md) / types - -# Namespace: types - -Internationalization types. - -## Table of Contents - -* [Index](#index) - -## Index - -### Interfaces - -| Interface | Description | -| -------------------------------------------------------- | ----------------------------------------------------------------- | -| [TranslatableStrings](interfaces/TranslatableStrings.md) | The model of translatable strings specific to the Markdown theme. | diff --git a/packages/typedoc-plugin-markdown/developer-docs/libs/README.md b/packages/typedoc-plugin-markdown/developer-docs/libs/README.md deleted file mode 100644 index fb885ee6a..000000000 --- a/packages/typedoc-plugin-markdown/developer-docs/libs/README.md +++ /dev/null @@ -1,14 +0,0 @@ -[typedoc-plugin-markdown v4.0.3](../README.md) / libs - -# libs - -General pure library functions to be consumed across the plugin. - -## Index - -### Namespaces - -| Namespace | Description | -| ----------------------------------------- | ------------------------------------ | -| [markdown](namespaces/markdown/README.md) | Helpers to render markdown elements. | -| [utils](namespaces/utils/README.md) | General utility pure functions. | diff --git a/packages/typedoc-plugin-markdown/developer-docs/libs/namespaces/markdown/README.md b/packages/typedoc-plugin-markdown/developer-docs/libs/namespaces/markdown/README.md deleted file mode 100644 index 526a51cd0..000000000 --- a/packages/typedoc-plugin-markdown/developer-docs/libs/namespaces/markdown/README.md +++ /dev/null @@ -1,320 +0,0 @@ -[typedoc-plugin-markdown v4.0.3](../../../README.md) / [libs](../../README.md) / markdown - -# Namespace: markdown - -Helpers to render markdown elements. - -## Table of Contents - -* [backTicks()](#backticks) -* [blockQuoteBlock()](#blockquoteblock) -* [bold()](#bold) -* [codeBlock()](#codeblock) -* [heading()](#heading) -* [horizontalRule()](#horizontalrule) -* [htmlTable()](#htmltable) -* [indentBlock()](#indentblock) -* [italic()](#italic) -* [link()](#link) -* [strikeThrough()](#strikethrough) -* [table()](#table) -* [unorderedList()](#unorderedlist) - -## backTicks() - -```ts -function backTicks(text): string -``` - -Wraps a string in backticks. -If the input string itself contains a backtick, pipe, or backslash (which can result in unwanted side effects) the string is escaped instead. - -### Parameters - -| Parameter | Type | -| --------- | -------- | -| `text` | `string` | - -### Returns - -`string` - -### Defined in - -[packages/typedoc-plugin-markdown/src/libs/markdown/back-ticks.ts:7](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/libs/markdown/back-ticks.ts#L7) - -*** - -## blockQuoteBlock() - -```ts -function blockQuoteBlock(content): string -``` - -### Parameters - -| Parameter | Type | -| --------- | -------- | -| `content` | `string` | - -### Returns - -`string` - -### Defined in - -[packages/typedoc-plugin-markdown/src/libs/markdown/block-quote-block.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/libs/markdown/block-quote-block.ts#L1) - -*** - -## bold() - -```ts -function bold(text): string -``` - -### Parameters - -| Parameter | Type | -| --------- | -------- | -| `text` | `string` | - -### Returns - -`string` - -### Defined in - -[packages/typedoc-plugin-markdown/src/libs/markdown/bold.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/libs/markdown/bold.ts#L1) - -*** - -## codeBlock() - -```ts -function codeBlock(content): string -``` - -### Parameters - -| Parameter | Type | -| --------- | -------- | -| `content` | `string` | - -### Returns - -`string` - -### Defined in - -[packages/typedoc-plugin-markdown/src/libs/markdown/code-block.ts:3](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/libs/markdown/code-block.ts#L3) - -*** - -## heading() - -```ts -function heading(level, text): string -``` - -Returns a heading in markdown format - -### Parameters - -| Parameter | Type | Description | -| --------- | -------- | ------------------------ | -| `level` | `number` | The level of the heading | -| `text` | `string` | The text of the heading | - -### Returns - -`string` - -### Defined in - -[packages/typedoc-plugin-markdown/src/libs/markdown/heading.ts:6](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/libs/markdown/heading.ts#L6) - -*** - -## horizontalRule() - -```ts -function horizontalRule(): string -``` - -### Returns - -`string` - -### Defined in - -[packages/typedoc-plugin-markdown/src/libs/markdown/horizontal-rule.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/libs/markdown/horizontal-rule.ts#L1) - -*** - -## htmlTable() - -```ts -function htmlTable( - headers, - rows, - leftAlignHeadings): string -``` - -### Parameters - -| Parameter | Type | Default value | -| ------------------- | -------------- | ------------- | -| `headers` | `string`\[] | `undefined` | -| `rows` | `string`\[]\[] | `undefined` | -| `leftAlignHeadings` | `boolean` | `false` | - -### Returns - -`string` - -### Defined in - -[packages/typedoc-plugin-markdown/src/libs/markdown/html-table.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/libs/markdown/html-table.ts#L1) - -*** - -## indentBlock() - -```ts -function indentBlock(content): string -``` - -### Parameters - -| Parameter | Type | -| --------- | -------- | -| `content` | `string` | - -### Returns - -`string` - -### Defined in - -[packages/typedoc-plugin-markdown/src/libs/markdown/indent-block.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/libs/markdown/indent-block.ts#L1) - -*** - -## italic() - -```ts -function italic(text): string -``` - -### Parameters - -| Parameter | Type | -| --------- | -------- | -| `text` | `string` | - -### Returns - -`string` - -### Defined in - -[packages/typedoc-plugin-markdown/src/libs/markdown/italic.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/libs/markdown/italic.ts#L1) - -*** - -## link() - -```ts -function link(label, url): string -``` - -The link element - -### Parameters - -| Parameter | Type | Description | -| --------- | ------------------ | -------------------------------- | -| `label` | `string` | The text to display for the link | -| `url` | `null` \| `string` | The url to link to | - -### Returns - -`string` - -### Defined in - -[packages/typedoc-plugin-markdown/src/libs/markdown/link.ts:6](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/libs/markdown/link.ts#L6) - -*** - -## strikeThrough() - -```ts -function strikeThrough(content): string -``` - -### Parameters - -| Parameter | Type | -| --------- | -------- | -| `content` | `string` | - -### Returns - -`string` - -### Defined in - -[packages/typedoc-plugin-markdown/src/libs/markdown/strike-through.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/libs/markdown/strike-through.ts#L1) - -*** - -## table() - -```ts -function table( - headers, - rows, - headerLeftAlign): string -``` - -Comments for table - -### Parameters - -| Parameter | Type | Default value | Description | -| ----------------- | -------------- | ------------- | ----------- | -| `headers` | `string`\[] | `undefined` | | -| `rows` | `string`\[]\[] | `undefined` | | -| `headerLeftAlign` | `boolean` | `false` | - | - -### Returns - -`string` - -### Defined in - -[packages/typedoc-plugin-markdown/src/libs/markdown/table.ts:7](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/libs/markdown/table.ts#L7) - -*** - -## unorderedList() - -```ts -function unorderedList(items): string -``` - -### Parameters - -| Parameter | Type | -| --------- | ----------- | -| `items` | `string`\[] | - -### Returns - -`string` - -### Defined in - -[packages/typedoc-plugin-markdown/src/libs/markdown/unordered-list.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/libs/markdown/unordered-list.ts#L1) diff --git a/packages/typedoc-plugin-markdown/developer-docs/libs/namespaces/utils/README.md b/packages/typedoc-plugin-markdown/developer-docs/libs/namespaces/utils/README.md deleted file mode 100644 index 7e8825953..000000000 --- a/packages/typedoc-plugin-markdown/developer-docs/libs/namespaces/utils/README.md +++ /dev/null @@ -1,312 +0,0 @@ -[typedoc-plugin-markdown v4.0.3](../../../README.md) / [libs](../../README.md) / utils - -# Namespace: utils - -General utility pure functions. - -## Table of Contents - -* [camelToTitleCase()](#cameltotitlecase) -* [escapeChars()](#escapechars) -* [formatMarkdown()](#formatmarkdown) -* [formatTableCell()](#formattablecell) -* [getFileNameWithExtension()](#getfilenamewithextension) -* [isQuoted()](#isquoted) -* [normalizeLineBreaks()](#normalizelinebreaks) -* [removeFirstScopedDirectory()](#removefirstscopeddirectory) -* [removeLineBreaks()](#removelinebreaks) -* [sanitizeComments()](#sanitizecomments) -* [slugify()](#slugify) -* [toPascalCase()](#topascalcase) -* [unEscapeChars()](#unescapechars) - -## camelToTitleCase() - -```ts -function camelToTitleCase(text): string -``` - -### Parameters - -| Parameter | Type | -| --------- | -------- | -| `text` | `string` | - -### Returns - -`string` - -### Defined in - -[packages/typedoc-plugin-markdown/src/libs/utils/camel-to-title-case.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/libs/utils/camel-to-title-case.ts#L1) - -*** - -## escapeChars() - -```ts -function escapeChars(str): string -``` - -### Parameters - -| Parameter | Type | -| --------- | -------- | -| `str` | `string` | - -### Returns - -`string` - -### Defined in - -[packages/typedoc-plugin-markdown/src/libs/utils/escape-chars.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/libs/utils/escape-chars.ts#L1) - -*** - -## formatMarkdown() - -```ts -function formatMarkdown(str): string -``` - -### Parameters - -| Parameter | Type | -| --------- | -------- | -| `str` | `string` | - -### Returns - -`string` - -### Defined in - -[packages/typedoc-plugin-markdown/src/libs/utils/format-markdown.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/libs/utils/format-markdown.ts#L1) - -*** - -## formatTableCell() - -```ts -function formatTableCell(str): string -``` - -* Replace new lines with spaces -* Replaces code blocks with single backticks -* Replaces multiple spaces with single spaces - -### Parameters - -| Parameter | Type | -| --------- | -------- | -| `str` | `string` | - -### Returns - -`string` - -### Defined in - -[packages/typedoc-plugin-markdown/src/libs/utils/format-table-cell.ts:6](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/libs/utils/format-table-cell.ts#L6) - -*** - -## getFileNameWithExtension() - -```ts -function getFileNameWithExtension(fileName, fileExtension): string -``` - -Returns a filename with extension while normalizing both the input name and input extension. - -### Parameters - -| Parameter | Type | -| --------------- | -------- | -| `fileName` | `string` | -| `fileExtension` | `string` | - -### Returns - -`string` - -### Defined in - -[packages/typedoc-plugin-markdown/src/libs/utils/get-file-name-with-extension.ts:6](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/libs/utils/get-file-name-with-extension.ts#L6) - -*** - -## isQuoted() - -```ts -function isQuoted(str): boolean -``` - -### Parameters - -| Parameter | Type | -| --------- | -------- | -| `str` | `string` | - -### Returns - -`boolean` - -### Defined in - -[packages/typedoc-plugin-markdown/src/libs/utils/is-quoted.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/libs/utils/is-quoted.ts#L1) - -*** - -## normalizeLineBreaks() - -```ts -function normalizeLineBreaks(str): string -``` - -### Parameters - -| Parameter | Type | -| --------- | -------- | -| `str` | `string` | - -### Returns - -`string` - -### Defined in - -[packages/typedoc-plugin-markdown/src/libs/utils/normalize-line-breaks.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/libs/utils/normalize-line-breaks.ts#L1) - -*** - -## removeFirstScopedDirectory() - -```ts -function removeFirstScopedDirectory(urlString): string -``` - -### Parameters - -| Parameter | Type | -| ----------- | -------- | -| `urlString` | `string` | - -### Returns - -`string` - -### Defined in - -[packages/typedoc-plugin-markdown/src/libs/utils/remove-first-scoped-directory.ts:3](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/libs/utils/remove-first-scoped-directory.ts#L3) - -*** - -## removeLineBreaks() - -```ts -function removeLineBreaks(str): string -``` - -### Parameters - -| Parameter | Type | -| --------- | -------- | -| `str` | `string` | - -### Returns - -`string` - -### Defined in - -[packages/typedoc-plugin-markdown/src/libs/utils/remove-line-breaks.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/libs/utils/remove-line-breaks.ts#L1) - -*** - -## sanitizeComments() - -```ts -function sanitizeComments(str): string -``` - -### Parameters - -| Parameter | Type | -| --------- | -------- | -| `str` | `string` | - -### Returns - -`string` - -### Defined in - -[packages/typedoc-plugin-markdown/src/libs/utils/sanitize-comments.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/libs/utils/sanitize-comments.ts#L1) - -*** - -## slugify() - -```ts -function slugify(url): string -``` - -### Parameters - -| Parameter | Type | -| --------- | -------- | -| `url` | `string` | - -### Returns - -`string` - -### Defined in - -[packages/typedoc-plugin-markdown/src/libs/utils/slugify.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/libs/utils/slugify.ts#L1) - -*** - -## toPascalCase() - -```ts -function toPascalCase(text): string -``` - -### Parameters - -| Parameter | Type | -| --------- | -------- | -| `text` | `string` | - -### Returns - -`string` - -### Defined in - -[packages/typedoc-plugin-markdown/src/libs/utils/to-pascal-case.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/libs/utils/to-pascal-case.ts#L1) - -*** - -## unEscapeChars() - -```ts -function unEscapeChars(str): string -``` - -### Parameters - -| Parameter | Type | -| --------- | -------- | -| `str` | `string` | - -### Returns - -`string` - -### Defined in - -[packages/typedoc-plugin-markdown/src/libs/utils/un-escape-chars.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/libs/utils/un-escape-chars.ts#L1) diff --git a/packages/typedoc-plugin-markdown/developer-docs/options/README.md b/packages/typedoc-plugin-markdown/developer-docs/options/README.md deleted file mode 100644 index a1a5f9169..000000000 --- a/packages/typedoc-plugin-markdown/developer-docs/options/README.md +++ /dev/null @@ -1,16 +0,0 @@ -[typedoc-plugin-markdown v4.0.3](../README.md) / options - -# options - -Configures plugin options. - -## Index - -### Namespaces - -| Namespace | Description | -| ------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | -| [constants](namespaces/constants/README.md) | Contains constant default values used in options. | -| [declarations](namespaces/declarations/README.md) | Typedoc options declarations. Each exported variable will be added to the TypeDoc options and also the public documentation. | -| [maps](namespaces/maps/README.md) | Maps a given value to the option type. | -| [types](namespaces/types/README.md) | Describes the options declared by the plugin. | diff --git a/packages/typedoc-plugin-markdown/developer-docs/options/namespaces/constants/README.md b/packages/typedoc-plugin-markdown/developer-docs/options/namespaces/constants/README.md deleted file mode 100644 index edda28822..000000000 --- a/packages/typedoc-plugin-markdown/developer-docs/options/namespaces/constants/README.md +++ /dev/null @@ -1,77 +0,0 @@ -[typedoc-plugin-markdown v4.0.3](../../../README.md) / [options](../../README.md) / constants - -# Namespace: constants - -Contains constant default values used in options. - -## Table of Contents - -* [ALLOWED\_OWN\_FILE\_MEMBERS](#allowed_own_file_members) -* [TEXT\_CONTENT\_MAPPINGS](#text_content_mappings) - -## ALLOWED\_OWN\_FILE\_MEMBERS - -```ts -const ALLOWED_OWN_FILE_MEMBERS: string[] = ...; -``` - -### Defined in - -[packages/typedoc-plugin-markdown/src/options/constants.ts:9](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/constants.ts#L9) - -*** - -## TEXT\_CONTENT\_MAPPINGS - -```ts -const TEXT_CONTENT_MAPPINGS: object = { - 'header.title': '{projectName} {version}', - 'header.docs': 'Docs', - 'breadcrumbs.home': '{projectName} {version}', - 'title.indexPage': '{projectName} {version}', - 'title.memberPage': '{kind}: {name}', - 'footer.text': '', -}; -``` - -### Type declaration - -#### header.title - -```ts -header.title: string = '{projectName} {version}'; -``` - -#### header.docs - -```ts -header.docs: string = 'Docs'; -``` - -#### breadcrumbs.home - -```ts -breadcrumbs.home: string = '{projectName} {version}'; -``` - -#### title.indexPage - -```ts -title.indexPage: string = '{projectName} {version}'; -``` - -#### title.memberPage - -```ts -title.memberPage: string = '{kind}: {name}'; -``` - -#### footer.text - -```ts -footer.text: string = ''; -``` - -### Defined in - -[packages/typedoc-plugin-markdown/src/options/constants.ts:18](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/constants.ts#L18) diff --git a/packages/typedoc-plugin-markdown/developer-docs/options/namespaces/maps/README.md b/packages/typedoc-plugin-markdown/developer-docs/options/namespaces/maps/README.md deleted file mode 100644 index 46944c7d4..000000000 --- a/packages/typedoc-plugin-markdown/developer-docs/options/namespaces/maps/README.md +++ /dev/null @@ -1,19 +0,0 @@ -[typedoc-plugin-markdown v4.0.3](../../../README.md) / [options](../../README.md) / maps - -# Namespace: maps - -Maps a given value to the option type. - -## Table of Contents - -* [Index](#index) - -## Index - -### Enumerations - -| Enumeration | Description | -| -------------------------------------------------------- | -------------------------------------------------------- | -| [OutputFileStrategy](enumerations/OutputFileStrategy.md) | The allowed values of the `--outputFileStrategy` option. | -| [ReflectionFormat](enumerations/ReflectionFormat.md) | The allowed values for formatting reflections. | -| [IndexFormat](enumerations/IndexFormat.md) | The allowed values for formatting indexes. | diff --git a/packages/typedoc-plugin-markdown/developer-docs/options/namespaces/maps/enumerations/IndexFormat.md b/packages/typedoc-plugin-markdown/developer-docs/options/namespaces/maps/enumerations/IndexFormat.md deleted file mode 100644 index f31232652..000000000 --- a/packages/typedoc-plugin-markdown/developer-docs/options/namespaces/maps/enumerations/IndexFormat.md +++ /dev/null @@ -1,14 +0,0 @@ -[typedoc-plugin-markdown v4.0.3](../../../../README.md) / [options](../../../README.md) / [maps](../README.md) / IndexFormat - -# Enumeration: IndexFormat - -The allowed values for formatting indexes. - -## Table of Contents - -## Enumeration Members - -| Enumeration Member | Value | -| ------------------ | --------- | -| `List` | `"list"` | -| `Table` | `"table"` | diff --git a/packages/typedoc-plugin-markdown/developer-docs/options/namespaces/maps/enumerations/OutputFileStrategy.md b/packages/typedoc-plugin-markdown/developer-docs/options/namespaces/maps/enumerations/OutputFileStrategy.md deleted file mode 100644 index cee15263b..000000000 --- a/packages/typedoc-plugin-markdown/developer-docs/options/namespaces/maps/enumerations/OutputFileStrategy.md +++ /dev/null @@ -1,14 +0,0 @@ -[typedoc-plugin-markdown v4.0.3](../../../../README.md) / [options](../../../README.md) / [maps](../README.md) / OutputFileStrategy - -# Enumeration: OutputFileStrategy - -The allowed values of the `--outputFileStrategy` option. - -## Table of Contents - -## Enumeration Members - -| Enumeration Member | Value | -| ------------------ | ----------- | -| `Members` | `"members"` | -| `Modules` | `"modules"` | diff --git a/packages/typedoc-plugin-markdown/developer-docs/options/namespaces/maps/enumerations/ReflectionFormat.md b/packages/typedoc-plugin-markdown/developer-docs/options/namespaces/maps/enumerations/ReflectionFormat.md deleted file mode 100644 index 449483e53..000000000 --- a/packages/typedoc-plugin-markdown/developer-docs/options/namespaces/maps/enumerations/ReflectionFormat.md +++ /dev/null @@ -1,15 +0,0 @@ -[typedoc-plugin-markdown v4.0.3](../../../../README.md) / [options](../../../README.md) / [maps](../README.md) / ReflectionFormat - -# Enumeration: ReflectionFormat - -The allowed values for formatting reflections. - -## Table of Contents - -## Enumeration Members - -| Enumeration Member | Value | -| ------------------ | ------------- | -| `List` | `"list"` | -| `Table` | `"table"` | -| `HtmlTable` | `"htmlTable"` | diff --git a/packages/typedoc-plugin-markdown/developer-docs/options/namespaces/types/README.md b/packages/typedoc-plugin-markdown/developer-docs/options/namespaces/types/README.md deleted file mode 100644 index 146542668..000000000 --- a/packages/typedoc-plugin-markdown/developer-docs/options/namespaces/types/README.md +++ /dev/null @@ -1,17 +0,0 @@ -[typedoc-plugin-markdown v4.0.3](../../../README.md) / [options](../../README.md) / types - -# Namespace: types - -Describes the options declared by the plugin. - -## Table of Contents - -* [Index](#index) - -## Index - -### Interfaces - -| Interface | Description | -| -------------------------------------------- | ----------- | -| [PluginOptions](interfaces/PluginOptions.md) | - | diff --git a/packages/typedoc-plugin-markdown/developer-docs/options/namespaces/types/interfaces/PluginOptions.md b/packages/typedoc-plugin-markdown/developer-docs/options/namespaces/types/interfaces/PluginOptions.md deleted file mode 100644 index fd2b62be0..000000000 --- a/packages/typedoc-plugin-markdown/developer-docs/options/namespaces/types/interfaces/PluginOptions.md +++ /dev/null @@ -1,517 +0,0 @@ -[typedoc-plugin-markdown v4.0.3](../../../../README.md) / [options](../../../README.md) / [types](../README.md) / PluginOptions - -# Interface: PluginOptions - -## Table of Contents - -* [Properties](#properties) - -## Properties - -### anchorPrefix - -```ts -anchorPrefix: string; -``` - -Custom anchor prefix when anchoring to in-page symbols. - -#### Defined in - -[packages/typedoc-plugin-markdown/src/options/types.ts:14](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/types.ts#L14) - -*** - -### entryFileName - -```ts -entryFileName: string; -``` - -The file name of the entry page. - -#### Defined in - -[packages/typedoc-plugin-markdown/src/options/types.ts:19](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/types.ts#L19) - -*** - -### entryModule - -```ts -entryModule: string; -``` - -The name of a module that should act as the root page for the documentation. - -#### Defined in - -[packages/typedoc-plugin-markdown/src/options/types.ts:24](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/types.ts#L24) - -*** - -### enumMembersFormat - -```ts -enumMembersFormat: "table" | "list" | "htmlTable"; -``` - -Specify the render style of enumeration members. - -#### Defined in - -[packages/typedoc-plugin-markdown/src/options/types.ts:29](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/types.ts#L29) - -*** - -### ~~excludeGroups~~ - -```ts -excludeGroups: boolean; -``` - -#### Deprecated - -This option has been renamed hideGroupHeadings to better reflect its purpose. - -#### Defined in - -[packages/typedoc-plugin-markdown/src/options/types.ts:34](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/types.ts#L34) - -*** - -### excludeScopesInPaths - -```ts -excludeScopesInPaths: boolean; -``` - -Exclude writing @ scope directories in paths. - -#### Defined in - -[packages/typedoc-plugin-markdown/src/options/types.ts:39](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/types.ts#L39) - -*** - -### expandObjects - -```ts -expandObjects: boolean; -``` - -Expand objects inside declarations. - -#### Defined in - -[packages/typedoc-plugin-markdown/src/options/types.ts:44](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/types.ts#L44) - -*** - -### expandParameters - -```ts -expandParameters: boolean; -``` - -Expand parameters in signature parentheses to display type information. - -#### Defined in - -[packages/typedoc-plugin-markdown/src/options/types.ts:49](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/types.ts#L49) - -*** - -### fileExtension - -```ts -fileExtension: string; -``` - -Specify the file extension for generated output files. - -#### Defined in - -[packages/typedoc-plugin-markdown/src/options/types.ts:54](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/types.ts#L54) - -*** - -### flattenOutputFiles - -```ts -flattenOutputFiles: boolean; -``` - -Flatten output files to a single directory. - -#### Defined in - -[packages/typedoc-plugin-markdown/src/options/types.ts:59](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/types.ts#L59) - -*** - -### hideBreadcrumbs - -```ts -hideBreadcrumbs: boolean; -``` - -Do not print breadcrumbs. - -#### Defined in - -[packages/typedoc-plugin-markdown/src/options/types.ts:64](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/types.ts#L64) - -*** - -### hideGroupHeadings - -```ts -hideGroupHeadings: boolean; -``` - -Excludes grouping by kind so all members are rendered and sorted at the same level. - -#### Defined in - -[packages/typedoc-plugin-markdown/src/options/types.ts:69](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/types.ts#L69) - -*** - -### hidePageHeader - -```ts -hidePageHeader: boolean; -``` - -Do not print page header. - -#### Defined in - -[packages/typedoc-plugin-markdown/src/options/types.ts:74](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/types.ts#L74) - -*** - -### hidePageTitle - -```ts -hidePageTitle: boolean; -``` - -Do not print page title. - -#### Defined in - -[packages/typedoc-plugin-markdown/src/options/types.ts:79](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/types.ts#L79) - -*** - -### indexFormat - -```ts -indexFormat: "table" | "list"; -``` - -Specify the render format for index items. - -#### Defined in - -[packages/typedoc-plugin-markdown/src/options/types.ts:84](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/types.ts#L84) - -*** - -### membersWithOwnFile - -```ts -membersWithOwnFile: ( - | "Enum" - | "Variable" - | "Function" - | "Class" - | "Interface" - | "TypeAlias")[]; -``` - -Determines which members are exported to their own file when `outputFileStrategy` equals `members`. - -#### Defined in - -[packages/typedoc-plugin-markdown/src/options/types.ts:89](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/types.ts#L89) - -*** - -### mergeReadme - -```ts -mergeReadme: boolean; -``` - -Merges the resolved readme into the project index page. - -#### Defined in - -[packages/typedoc-plugin-markdown/src/options/types.ts:101](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/types.ts#L101) - -*** - -### navigationModel - -```ts -navigationModel: object; -``` - -Configures how the navigation model will be generated. - -#### excludeGroups - -```ts -excludeGroups: boolean; -``` - -#### excludeCategories - -```ts -excludeCategories: boolean; -``` - -#### excludeFolders - -```ts -excludeFolders: boolean; -``` - -#### Defined in - -[packages/typedoc-plugin-markdown/src/options/types.ts:106](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/types.ts#L106) - -*** - -### outputFileStrategy - -```ts -outputFileStrategy: "members" | "modules"; -``` - -Determines how output files are generated. - -#### Defined in - -[packages/typedoc-plugin-markdown/src/options/types.ts:115](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/types.ts#L115) - -*** - -### parametersFormat - -```ts -parametersFormat: "table" | "list" | "htmlTable"; -``` - -Specify the render style of parameter and type parameter groups. - -#### Defined in - -[packages/typedoc-plugin-markdown/src/options/types.ts:120](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/types.ts#L120) - -*** - -### preserveAnchorCasing - -```ts -preserveAnchorCasing: boolean; -``` - -Preserve anchor casing when generating link to symbols. - -#### Defined in - -[packages/typedoc-plugin-markdown/src/options/types.ts:125](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/types.ts#L125) - -*** - -### propertiesFormat - -```ts -propertiesFormat: "table" | "list" | "htmlTable"; -``` - -Specify the render style of property groups for interfaces and classes. - -#### Defined in - -[packages/typedoc-plugin-markdown/src/options/types.ts:130](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/types.ts#L130) - -*** - -### publicPath - -```ts -publicPath: string; -``` - -Specify the base path for all urls. - -#### Defined in - -[packages/typedoc-plugin-markdown/src/options/types.ts:135](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/types.ts#L135) - -*** - -### sanitizeComments - -```ts -sanitizeComments: boolean; -``` - -Sanitize HTML and JSX inside JsDoc comments. - -#### Defined in - -[packages/typedoc-plugin-markdown/src/options/types.ts:140](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/types.ts#L140) - -*** - -### tableColumnSettings - -```ts -tableColumnSettings: object; -``` - -Control header alignment and column visibility in tables. - -#### hideDefaults - -```ts -hideDefaults: boolean; -``` - -#### hideInherited - -```ts -hideInherited: boolean; -``` - -#### hideModifiers - -```ts -hideModifiers: boolean; -``` - -#### hideOverrides - -```ts -hideOverrides: boolean; -``` - -#### hideSources - -```ts -hideSources: boolean; -``` - -#### hideValues - -```ts -hideValues: boolean; -``` - -#### leftAlignHeaders - -```ts -leftAlignHeaders: boolean; -``` - -#### Defined in - -[packages/typedoc-plugin-markdown/src/options/types.ts:145](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/types.ts#L145) - -*** - -### textContentMappings - -```ts -textContentMappings: object; -``` - -Change specific text placeholders in the template. - -#### header.title - -```ts -header.title: string; -``` - -#### header.docs - -```ts -header.docs: string; -``` - -#### breadcrumbs.home - -```ts -breadcrumbs.home: string; -``` - -#### title.indexPage - -```ts -title.indexPage: string; -``` - -#### title.memberPage - -```ts -title.memberPage: string; -``` - -#### footer.text - -```ts -footer.text: string; -``` - -#### Defined in - -[packages/typedoc-plugin-markdown/src/options/types.ts:158](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/types.ts#L158) - -*** - -### typeDeclarationFormat - -```ts -typeDeclarationFormat: "table" | "list" | "htmlTable"; -``` - -Specify the render style for type declaration members. - -#### Defined in - -[packages/typedoc-plugin-markdown/src/options/types.ts:170](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/types.ts#L170) - -*** - -### useCodeBlocks - -```ts -useCodeBlocks: boolean; -``` - -Wraps signatures and declarations in code blocks. - -#### Defined in - -[packages/typedoc-plugin-markdown/src/options/types.ts:175](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/types.ts#L175) - -*** - -### useHTMLAnchors - -```ts -useHTMLAnchors: boolean; -``` - -Add HTML named anchors to headings and table rows. - -#### Defined in - -[packages/typedoc-plugin-markdown/src/options/types.ts:180](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/types.ts#L180) diff --git a/packages/typedoc-plugin-markdown/developer-docs/theme/README.md b/packages/typedoc-plugin-markdown/developer-docs/theme/README.md deleted file mode 100644 index c57cc1ec6..000000000 --- a/packages/typedoc-plugin-markdown/developer-docs/theme/README.md +++ /dev/null @@ -1,22 +0,0 @@ -[typedoc-plugin-markdown v4.0.3](../README.md) / theme - -# theme - -This is the built-in Markdown theme. - -## Index - -### Namespaces - -| Namespace | Description | -| --------------------------------------- | ---------------------------------------------------------------------- | -| [context](namespaces/context/README.md) | Support and resources for the theme MarkdownThemeContext class. | -| [core](namespaces/core/README.md) | Support for the MarkdownTheme core class building URLs and navigation. | -| [types](namespaces/types/README.md) | - | - -### Classes - -| Class | Description | -| ------------------------------------------------------- | ----------------------------------------------------------------------------------- | -| [MarkdownThemeContext](classes/MarkdownThemeContext.md) | The theme context class that is provided as context on the rendering of every page. | -| [MarkdownTheme](classes/MarkdownTheme.md) | The main theme class for the plugin. | diff --git a/packages/typedoc-plugin-markdown/developer-docs/theme/classes/MarkdownTheme.md b/packages/typedoc-plugin-markdown/developer-docs/theme/classes/MarkdownTheme.md deleted file mode 100644 index 1fbbff59a..000000000 --- a/packages/typedoc-plugin-markdown/developer-docs/theme/classes/MarkdownTheme.md +++ /dev/null @@ -1,298 +0,0 @@ -[typedoc-plugin-markdown v4.0.3](../../README.md) / [theme](../README.md) / MarkdownTheme - -# Class: MarkdownTheme - -The main theme class for the plugin. - -## Table of Contents - -* [Example](#example) -* [Extends](#extends) -* [Constructors](#constructors) -* [Methods](#methods) - -## Remarks - -The class controls how TypeDoc models are mapped to files and templates and extends TypeDoc's base Theme class. - -You would typically only be interested in overriding the the theme's render context instance. - -The API follows the implementation of [TypeDoc's custom theming](https://github.com/TypeStrong/typedoc/blob/master/internal-docs/custom-themes.md) with some minor adjustments. - -## Example - -```ts -export function load(app) { - app.renderer.defineTheme('customTheme', MyMarkdownTheme); -} - -class MyMarkdownTheme extends MarkdownTheme { - ... -} -``` - -## Extends - -* [`Theme`](https://typedoc.org/api/classes/Theme.html) - -## Constructors - -### new MarkdownTheme() - -```ts -new MarkdownTheme(owner): MarkdownTheme -``` - -Create new Component instance. - -#### Parameters - -| Parameter | Type | -| --------- | ----------------------------------------------------------- | -| `owner` | [`Renderer`](https://typedoc.org/api/classes/Renderer.html) | - -#### Returns - -[`MarkdownTheme`](MarkdownTheme.md) - -#### Inherited from - -`Theme.constructor` - -#### Defined in - -node\_modules/typedoc/dist/lib/utils/component.d.ts:52 - -## Methods - -### render() - -`Internal` - -```ts -render(page, template): string -``` - -Renders a template and page model to a string. - -#### Parameters - -| Parameter | Type | -| ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `page` | [`MarkdownPageEvent`](../../app/namespaces/events/classes/MarkdownPageEvent.md)\<[`Reflection`](https://typedoc.org/api/classes/Models.Reflection.html)> | -| `template` | [`RenderTemplate`](../namespaces/types/type-aliases/RenderTemplate.md)\<[`MarkdownPageEvent`](../../app/namespaces/events/classes/MarkdownPageEvent.md)\<[`Reflection`](https://typedoc.org/api/classes/Models.Reflection.html)>> | - -#### Returns - -`string` - -#### Overrides - -`Theme.render` - -#### Defined in - -[packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts:47](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts#L47) - -*** - -### getRenderContext() - -```ts -getRenderContext(page): MarkdownThemeContext -``` - -Creates a new instance of the current theme context. - -This method can be overridden to provide an alternative theme context. - -#### Parameters - -| Parameter | Type | -| --------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `page` | [`MarkdownPageEvent`](../../app/namespaces/events/classes/MarkdownPageEvent.md)\<[`Reflection`](https://typedoc.org/api/classes/Models.Reflection.html)> | - -#### Returns - -[`MarkdownThemeContext`](MarkdownThemeContext.md) - -#### Defined in - -[packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts:64](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts#L64) - -*** - -### getUrls() - -```ts -getUrls(project): UrlMapping[] -``` - -Maps the models of the given project to the desired output files. - -This method can be overriden to provide an alternative url structure. - -#### Parameters - -| Parameter | Type | -| --------- | ------------------------------------------------------------------------------------ | -| `project` | [`ProjectReflection`](https://typedoc.org/api/classes/Models.ProjectReflection.html) | - -#### Returns - -[`UrlMapping`](../namespaces/types/interfaces/UrlMapping.md)\<[`Reflection`](https://typedoc.org/api/classes/Models.Reflection.html)>\[] - -#### Overrides - -`Theme.getUrls` - -#### Defined in - -[packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts:73](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts#L73) - -*** - -### getNavigation() - -```ts -getNavigation(project): NavigationItem[] -``` - -Map the models of the given project to a navigation structure. - -This method can be overriden to provide an alternative navigation structure. - -#### Parameters - -| Parameter | Type | -| --------- | ------------------------------------------------------------------------------------ | -| `project` | [`ProjectReflection`](https://typedoc.org/api/classes/Models.ProjectReflection.html) | - -#### Returns - -[`NavigationItem`](../namespaces/types/interfaces/NavigationItem.md)\[] - -#### Defined in - -[packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts:82](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts#L82) - -*** - -### getTemplateMapping() - -`Internal` - -```ts -getTemplateMapping(kind, outputFileStrategy?): any -``` - -#### Parameters - -| Parameter | Type | -| --------------------- | ---------------------------------------------------------------------------------------- | -| `kind` | [`ReflectionKind`](https://typedoc.org/api/enums/Models.ReflectionKind-1.html) | -| `outputFileStrategy`? | [`OutputFileStrategy`](../../options/namespaces/maps/enumerations/OutputFileStrategy.md) | - -#### Returns - -`any` - -#### Defined in - -[packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts:89](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts#L89) - -*** - -### documentTemplate() - -`Internal` - -```ts -documentTemplate(page): string -``` - -#### Parameters - -| Parameter | Type | -| --------- | ------------------------------------------------------------------------------------------------------ | -| `page` | [`MarkdownPageEvent`](../../app/namespaces/events/classes/MarkdownPageEvent.md)\<`DocumentReflection`> | - -#### Returns - -`string` - -#### Defined in - -[packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts:213](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts#L213) - -*** - -### readmeTemplate() - -`Internal` - -```ts -readmeTemplate(page): string -``` - -#### Parameters - -| Parameter | Type | -| --------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `page` | [`MarkdownPageEvent`](../../app/namespaces/events/classes/MarkdownPageEvent.md)\<[`ProjectReflection`](https://typedoc.org/api/classes/Models.ProjectReflection.html)> | - -#### Returns - -`string` - -#### Defined in - -[packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts:220](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts#L220) - -*** - -### projectTemplate() - -`Internal` - -```ts -projectTemplate(page): string -``` - -#### Parameters - -| Parameter | Type | -| --------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `page` | [`MarkdownPageEvent`](../../app/namespaces/events/classes/MarkdownPageEvent.md)\<[`ProjectReflection`](https://typedoc.org/api/classes/Models.ProjectReflection.html)> | - -#### Returns - -`string` - -#### Defined in - -[packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts:227](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts#L227) - -*** - -### reflectionTemplate() - -`Internal` - -```ts -reflectionTemplate(page): string -``` - -#### Parameters - -| Parameter | Type | -| --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `page` | [`MarkdownPageEvent`](../../app/namespaces/events/classes/MarkdownPageEvent.md)\<[`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html)> | - -#### Returns - -`string` - -#### Defined in - -[packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts:234](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts#L234) diff --git a/packages/typedoc-plugin-markdown/developer-docs/theme/namespaces/context/README.md b/packages/typedoc-plugin-markdown/developer-docs/theme/namespaces/context/README.md deleted file mode 100644 index b74974c82..000000000 --- a/packages/typedoc-plugin-markdown/developer-docs/theme/namespaces/context/README.md +++ /dev/null @@ -1,19 +0,0 @@ -[typedoc-plugin-markdown v4.0.3](../../../README.md) / [theme](../../README.md) / context - -# Namespace: context - -Support and resources for the theme MarkdownThemeContext class. - -## Table of Contents - -* [Index](#index) - -## Index - -### Namespaces - -| Namespace | Description | -| ------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | -| [helpers](namespaces/helpers/README.md) | The `helpers` namespace holds the helpers for the theme and are smaller utility functions that return snippets or text or other data transformations. | -| [partials](namespaces/partials/README.md) | The `partials` namespace holds the partials for the theme and are used by templates to map speficic models to page output. | -| [templates](namespaces/templates/README.md) | Then `templates` namespace holds the main templates for the theme and are mapped to single pages and configured in the MarkdownTheme. | diff --git a/packages/typedoc-plugin-markdown/developer-docs/theme/namespaces/context/namespaces/helpers/README.md b/packages/typedoc-plugin-markdown/developer-docs/theme/namespaces/context/namespaces/helpers/README.md deleted file mode 100644 index 470b2050a..000000000 --- a/packages/typedoc-plugin-markdown/developer-docs/theme/namespaces/context/namespaces/helpers/README.md +++ /dev/null @@ -1,446 +0,0 @@ -[typedoc-plugin-markdown v4.0.3](../../../../../README.md) / [theme](../../../../README.md) / [context](../../README.md) / helpers - -# Namespace: helpers - -The `helpers` namespace holds the helpers for the theme and are smaller utility functions that return snippets or text or other data transformations. - -Please note that partials: - -* Take a `model` param (that references a specific TypeDoc model) and an `options` param if required. -* Can reference other helpers but should not reference partials. -* Can return strings or other models. - -## Table of Contents - -* [getCommentParts()](#getcommentparts) -* [isFile()](#isfile) -* [getDeclarationType()](#getdeclarationtype) -* [getDescriptionForReflection()](#getdescriptionforreflection) -* [getFlattenedDeclarations()](#getflatteneddeclarations) -* [getGroupIndexList()](#getgroupindexlist) -* [getGroupIndexTable()](#getgroupindextable) -* [getGroupIndex()](#getgroupindex) -* [getHierarchyType()](#gethierarchytype) -* [getKeyword()](#getkeyword) -* [getModifier()](#getmodifier) -* [getParameterDefaultValue()](#getparameterdefaultvalue) -* [getProjectName()](#getprojectname) -* [getPropertyDefaultValue()](#getpropertydefaultvalue) -* [getReflectionFlags()](#getreflectionflags) -* [getReturnType()](#getreturntype) -* [isGroupKind()](#isgroupkind) -* [useTableFormat()](#usetableformat) - -## getCommentParts() - -```ts -function getCommentParts(this, model): string -``` - -### Parameters - -| Parameter | Type | -| --------- | --------------------------------------------------------------------------------------- | -| `this` | [`MarkdownThemeContext`](../../../../classes/MarkdownThemeContext.md) | -| `model` | [`CommentDisplayPart`](https://typedoc.org/api/types/Models.CommentDisplayPart.html)\[] | - -### Returns - -`string` - -### Defined in - -[packages/typedoc-plugin-markdown/src/theme/context/helpers/get-comment-parts.ts:6](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/helpers/get-comment-parts.ts#L6) - -*** - -## isFile() - -```ts -function isFile(file): boolean -``` - -### Parameters - -| Parameter | Type | -| --------- | -------- | -| `file` | `string` | - -### Returns - -`boolean` - -### Defined in - -[packages/typedoc-plugin-markdown/src/theme/context/helpers/get-comment-parts.ts:64](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/helpers/get-comment-parts.ts#L64) - -*** - -## getDeclarationType() - -```ts -function getDeclarationType(model): undefined | SomeType -``` - -### Parameters - -| Parameter | Type | -| --------- | -------------------------------------------------------------------------------------------- | -| `model` | [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html) | - -### Returns - -`undefined` | [`SomeType`](https://typedoc.org/api/classes/Models.SomeType.html) - -### Defined in - -[packages/typedoc-plugin-markdown/src/theme/context/helpers/get-declaration-type.ts:3](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/helpers/get-declaration-type.ts#L3) - -*** - -## getDescriptionForReflection() - -```ts -function getDescriptionForReflection(this, model): null | string -``` - -### Parameters - -| Parameter | Type | -| --------- | -------------------------------------------------------------------------------------------- | -| `this` | [`MarkdownThemeContext`](../../../../classes/MarkdownThemeContext.md) | -| `model` | [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html) | - -### Returns - -`null` | `string` - -### Defined in - -[packages/typedoc-plugin-markdown/src/theme/context/helpers/get-description-for-reflection.ts:4](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/helpers/get-description-for-reflection.ts#L4) - -*** - -## getFlattenedDeclarations() - -```ts -function getFlattenedDeclarations(model, options?): DeclarationReflection[] -``` - -### Parameters - -| Parameter | Type | -| ---------------------------- | ----------------------------------------------------------------------------------------------- | -| `model` | [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html)\[] | -| `options`? | `object` | -| `options.includeSignatures`? | `boolean` | - -### Returns - -[`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html)\[] - -### Defined in - -[packages/typedoc-plugin-markdown/src/theme/context/helpers/get-flattened-declarations.ts:3](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/helpers/get-flattened-declarations.ts#L3) - -*** - -## getGroupIndexList() - -```ts -function getGroupIndexList(this, children): string -``` - -### Parameters - -| Parameter | Type | -| ---------- | -------------------------------------------------------------------------------------------------------------------------- | -| `this` | [`MarkdownThemeContext`](../../../../classes/MarkdownThemeContext.md) | -| `children` | [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html)\[] \| `DocumentReflection`\[] | - -### Returns - -`string` - -### Defined in - -[packages/typedoc-plugin-markdown/src/theme/context/helpers/get-group-index-list.ts:6](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/helpers/get-group-index-list.ts#L6) - -*** - -## getGroupIndexTable() - -```ts -function getGroupIndexTable( - this, - children, - kind?): string -``` - -### Parameters - -| Parameter | Type | -| ---------- | -------------------------------------------------------------------------------------------------------------------------- | -| `this` | [`MarkdownThemeContext`](../../../../classes/MarkdownThemeContext.md) | -| `children` | [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html)\[] \| `DocumentReflection`\[] | -| `kind`? | [`ReflectionKind`](https://typedoc.org/api/enums/Models.ReflectionKind-1.html) | - -### Returns - -`string` - -### Defined in - -[packages/typedoc-plugin-markdown/src/theme/context/helpers/get-group-index-table.ts:10](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/helpers/get-group-index-table.ts#L10) - -*** - -## getGroupIndex() - -```ts -function getGroupIndex(group): any -``` - -### Parameters - -| Parameter | Type | -| --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `group` | [`ReflectionCategory`](https://typedoc.org/api/types/Models.ReflectionCategory.html) \| [`ReflectionGroup`](https://typedoc.org/api/classes/Models.ReflectionGroup.html) | - -### Returns - -`any` - -### Defined in - -[packages/typedoc-plugin-markdown/src/theme/context/helpers/get-group-index.ts:8](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/helpers/get-group-index.ts#L8) - -*** - -## getHierarchyType() - -```ts -function getHierarchyType( - this, - model, - options?): string -``` - -### Parameters - -| Parameter | Type | -| ------------------- | --------------------------------------------------------------------- | -| `this` | [`MarkdownThemeContext`](../../../../classes/MarkdownThemeContext.md) | -| `model` | [`SomeType`](https://typedoc.org/api/classes/Models.SomeType.html) | -| `options`? | `object` | -| `options.isTarget`? | `boolean` | - -### Returns - -`string` - -### Defined in - -[packages/typedoc-plugin-markdown/src/theme/context/helpers/get-hierarchy-type.ts:5](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/helpers/get-hierarchy-type.ts#L5) - -*** - -## getKeyword() - -```ts -function getKeyword(model): string -``` - -### Parameters - -| Parameter | Type | -| --------- | ------------------------------------------------------------------------------ | -| `model` | [`ReflectionKind`](https://typedoc.org/api/enums/Models.ReflectionKind-1.html) | - -### Returns - -`string` - -### Defined in - -[packages/typedoc-plugin-markdown/src/theme/context/helpers/get-keyword.ts:3](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/helpers/get-keyword.ts#L3) - -*** - -## getModifier() - -```ts -function getModifier(model): string | null -``` - -### Parameters - -| Parameter | Type | -| --------- | -------------------------------------------------------------------------------------------- | -| `model` | [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html) | - -### Returns - -`string` | `null` - -### Defined in - -[packages/typedoc-plugin-markdown/src/theme/context/helpers/get-modifier.ts:3](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/helpers/get-modifier.ts#L3) - -*** - -## getParameterDefaultValue() - -```ts -function getParameterDefaultValue(model): string -``` - -### Parameters - -| Parameter | Type | -| --------- | ---------------------------------------------------------------------------------------- | -| `model` | [`ParameterReflection`](https://typedoc.org/api/classes/Models.ParameterReflection.html) | - -### Returns - -`string` - -### Defined in - -[packages/typedoc-plugin-markdown/src/theme/context/helpers/get-parameter-default-value.ts:3](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/helpers/get-parameter-default-value.ts#L3) - -*** - -## getProjectName() - -```ts -function getProjectName(stringWithPlaceholders, page): string -``` - -### Parameters - -| Parameter | Type | -| ------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `stringWithPlaceholders` | `string` | -| `page` | [`MarkdownPageEvent`](../../../../../app/namespaces/events/classes/MarkdownPageEvent.md)\<[`Reflection`](https://typedoc.org/api/classes/Models.Reflection.html)> | - -### Returns - -`string` - -### Defined in - -[packages/typedoc-plugin-markdown/src/theme/context/helpers/get-project-name.ts:4](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/helpers/get-project-name.ts#L4) - -*** - -## getPropertyDefaultValue() - -```ts -function getPropertyDefaultValue(model): null | string -``` - -### Parameters - -| Parameter | Type | -| --------- | -------------------------------------------------------------------------------------------- | -| `model` | [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html) | - -### Returns - -`null` | `string` - -### Defined in - -[packages/typedoc-plugin-markdown/src/theme/context/helpers/get-property-default-value.ts:4](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/helpers/get-property-default-value.ts#L4) - -*** - -## getReflectionFlags() - -```ts -function getReflectionFlags(this, reflection): string[] -``` - -### Parameters - -| Parameter | Type | -| ------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `this` | [`MarkdownThemeContext`](../../../../classes/MarkdownThemeContext.md) | -| `reflection` | [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html) \| [`SignatureReflection`](https://typedoc.org/api/classes/Models.SignatureReflection.html) | - -### Returns - -`string`\[] - -### Defined in - -[packages/typedoc-plugin-markdown/src/theme/context/helpers/get-reflection-flags.ts:5](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/helpers/get-reflection-flags.ts#L5) - -*** - -## getReturnType() - -```ts -function getReturnType(this, model?): string -``` - -### Parameters - -| Parameter | Type | -| --------- | --------------------------------------------------------------------- | -| `this` | [`MarkdownThemeContext`](../../../../classes/MarkdownThemeContext.md) | -| `model`? | [`SomeType`](https://typedoc.org/api/classes/Models.SomeType.html) | - -### Returns - -`string` - -### Defined in - -[packages/typedoc-plugin-markdown/src/theme/context/helpers/get-return-type.ts:5](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/helpers/get-return-type.ts#L5) - -*** - -## isGroupKind() - -```ts -function isGroupKind(model): boolean -``` - -### Parameters - -| Parameter | Type | -| --------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `model` | [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html) \| [`SignatureReflection`](https://typedoc.org/api/classes/Models.SignatureReflection.html) | - -### Returns - -`boolean` - -### Defined in - -[packages/typedoc-plugin-markdown/src/theme/context/helpers/is-group-kind.ts:7](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/helpers/is-group-kind.ts#L7) - -*** - -## useTableFormat() - -```ts -function useTableFormat(this, key): boolean -``` - -### Parameters - -| Parameter | Type | -| --------- | --------------------------------------------------------------------- | -| `this` | [`MarkdownThemeContext`](../../../../classes/MarkdownThemeContext.md) | -| `key` | `"parameters"` \| `"properties"` \| `"enums"` \| `"typeDeclarations"` | - -### Returns - -`boolean` - -### Defined in - -[packages/typedoc-plugin-markdown/src/theme/context/helpers/use-table.format.ts:3](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/helpers/use-table.format.ts#L3) diff --git a/packages/typedoc-plugin-markdown/developer-docs/theme/namespaces/context/namespaces/partials/README.md b/packages/typedoc-plugin-markdown/developer-docs/theme/namespaces/context/namespaces/partials/README.md deleted file mode 100644 index 94e44c6ae..000000000 --- a/packages/typedoc-plugin-markdown/developer-docs/theme/namespaces/context/namespaces/partials/README.md +++ /dev/null @@ -1,1602 +0,0 @@ -[typedoc-plugin-markdown v4.0.3](../../../../../README.md) / [theme](../../../../README.md) / [context](../../README.md) / partials - -# Namespace: partials - -The `partials` namespace holds the partials for the theme and are used by templates to map speficic models to page output. - -Please note that partials:: - -* Take a `model` param (that references a specific TypeDoc model) and an `options` param if required. -* Can call other partials and helpers. -* Must return a string. - -Partials are categorised by their use: - -* Page Partials: Partials that render core page elements such as header and breadcrumbs. -* Container Partials: Partials that are used to render reflection groups and categories. -* Member Partials: Partials that render specific parts of reflections. -* Comment Partials: Partials that render comments. -* Type Partials: Partials that render specific TypeDoc model types. - -## Table of Contents - -* [Page Partials](#page-partials) -* [Container Partials](#container-partials) -* [Member Partials](#member-partials) -* [Comment Partials](#comment-partials) -* [Type Partials](#type-partials) -* [Other](#other) - -## Page Partials - -### breadcrumbs() - -```ts -function breadcrumbs(this): string -``` - -#### Parameters - -| Parameter | Type | -| --------- | --------------------------------------------------------------------- | -| `this` | [`MarkdownThemeContext`](../../../../classes/MarkdownThemeContext.md) | - -#### Returns - -`string` - -#### Defined in - -[packages/typedoc-plugin-markdown/src/theme/context/partials/page.breadcrumbs.ts:9](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/page.breadcrumbs.ts#L9) - -*** - -### footer() - -```ts -function footer(this): string -``` - -#### Parameters - -| Parameter | Type | -| --------- | --------------------------------------------------------------------- | -| `this` | [`MarkdownThemeContext`](../../../../classes/MarkdownThemeContext.md) | - -#### Returns - -`string` - -#### Defined in - -[packages/typedoc-plugin-markdown/src/theme/context/partials/page.footer.ts:6](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/page.footer.ts#L6) - -*** - -### header() - -```ts -function header(this): string -``` - -#### Parameters - -| Parameter | Type | -| --------- | --------------------------------------------------------------------- | -| `this` | [`MarkdownThemeContext`](../../../../classes/MarkdownThemeContext.md) | - -#### Returns - -`string` - -#### Defined in - -[packages/typedoc-plugin-markdown/src/theme/context/partials/page.header.ts:15](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/page.header.ts#L15) - -*** - -### packagesIndex() - -```ts -function packagesIndex(this, model): string -``` - -#### Parameters - -| Parameter | Type | -| --------- | ------------------------------------------------------------------------------------ | -| `this` | [`MarkdownThemeContext`](../../../../classes/MarkdownThemeContext.md) | -| `model` | [`ProjectReflection`](https://typedoc.org/api/classes/Models.ProjectReflection.html) | - -#### Returns - -`string` - -#### Defined in - -[packages/typedoc-plugin-markdown/src/theme/context/partials/page.packagesIndex.ts:10](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/page.packagesIndex.ts#L10) - -*** - -### pageTitle() - -```ts -function pageTitle(this): string -``` - -#### Parameters - -| Parameter | Type | -| --------- | --------------------------------------------------------------------- | -| `this` | [`MarkdownThemeContext`](../../../../classes/MarkdownThemeContext.md) | - -#### Returns - -`string` - -#### Defined in - -[packages/typedoc-plugin-markdown/src/theme/context/partials/page.pageTitle.ts:7](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/page.pageTitle.ts#L7) - -## Container Partials - -### body() - -```ts -function body( - this, - model, - options): string -``` - -#### Parameters - -| Parameter | Type | -| ---------------------- | ---------------------------------------------------------------------------------------- | -| `this` | [`MarkdownThemeContext`](../../../../classes/MarkdownThemeContext.md) | -| `model` | [`ContainerReflection`](https://typedoc.org/api/classes/Models.ContainerReflection.html) | -| `options` | `object` | -| `options.headingLevel` | `number` | - -#### Returns - -`string` - -#### Defined in - -[packages/typedoc-plugin-markdown/src/theme/context/partials/container.body.ts:11](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/container.body.ts#L11) - -*** - -### categories() - -```ts -function categories( - this, - model, - options): string -``` - -Renders a collection of reflection categories. - -#### Parameters - -| Parameter | Type | -| ---------------------- | --------------------------------------------------------------------------------------- | -| `this` | [`MarkdownThemeContext`](../../../../classes/MarkdownThemeContext.md) | -| `model` | [`ReflectionCategory`](https://typedoc.org/api/types/Models.ReflectionCategory.html)\[] | -| `options` | `object` | -| `options.headingLevel` | `number` | - -#### Returns - -`string` - -#### Defined in - -[packages/typedoc-plugin-markdown/src/theme/context/partials/container.categories.ts:10](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/container.categories.ts#L10) - -*** - -### groups() - -```ts -function groups( - this, - model, - options): string -``` - -Renders a collection of reflection groups. - -#### Parameters - -| Parameter | Type | -| ---------------------- | ----------------------------------------------------------------------------------- | -| `this` | [`MarkdownThemeContext`](../../../../classes/MarkdownThemeContext.md) | -| `model` | [`ReflectionGroup`](https://typedoc.org/api/classes/Models.ReflectionGroup.html)\[] | -| `options` | `object` | -| `options.headingLevel` | `number` | - -#### Returns - -`string` - -#### Defined in - -[packages/typedoc-plugin-markdown/src/theme/context/partials/container.groups.ts:14](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/container.groups.ts#L14) - -*** - -### members() - -```ts -function members( - this, - model, - options): string -``` - -Renders a collection of members. - -#### Parameters - -| Parameter | Type | -| ---------------------- | ----------------------------------------------------------------------------------------------- | -| `this` | [`MarkdownThemeContext`](../../../../classes/MarkdownThemeContext.md) | -| `model` | [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html)\[] | -| `options` | `object` | -| `options.headingLevel` | `number` | - -#### Returns - -`string` - -#### Defined in - -[packages/typedoc-plugin-markdown/src/theme/context/partials/container.members.ts:10](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/container.members.ts#L10) - -## Member Partials - -### accessor() - -```ts -function accessor( - this, - model, - options): string -``` - -Renders an accessor member. - -#### Parameters - -| Parameter | Type | -| ---------------------- | -------------------------------------------------------------------------------------------- | -| `this` | [`MarkdownThemeContext`](../../../../classes/MarkdownThemeContext.md) | -| `model` | [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html) | -| `options` | `object` | -| `options.headingLevel` | `number` | - -#### Returns - -`string` - -#### Defined in - -[packages/typedoc-plugin-markdown/src/theme/context/partials/member.accessor.ts:10](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/member.accessor.ts#L10) - -*** - -### constructor() - -```ts -function constructor( - this, - model, - options): string -``` - -Renders an constructor member. - -#### Parameters - -| Parameter | Type | -| ---------------------- | -------------------------------------------------------------------------------------------- | -| `this` | [`MarkdownThemeContext`](../../../../classes/MarkdownThemeContext.md) | -| `model` | [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html) | -| `options` | `object` | -| `options.headingLevel` | `number` | - -#### Returns - -`string` - -#### Defined in - -[packages/typedoc-plugin-markdown/src/theme/context/partials/member.constructors.ts:11](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/member.constructors.ts#L11) - -*** - -### memberContainer() - -```ts -function memberContainer( - this, - model, - options): string -``` - -#### Parameters - -| Parameter | Type | -| ---------------------- | -------------------------------------------------------------------------------------------- | -| `this` | [`MarkdownThemeContext`](../../../../classes/MarkdownThemeContext.md) | -| `model` | [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html) | -| `options` | `object` | -| `options.headingLevel` | `number` | -| `options.nested`? | `boolean` | - -#### Returns - -`string` - -#### Defined in - -[packages/typedoc-plugin-markdown/src/theme/context/partials/member.container.ts:8](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/member.container.ts#L8) - -*** - -### declaration() - -```ts -function declaration( - this, - model, - options): string -``` - -Renders a standard declaration member. - -#### Parameters - -| Parameter | Type | -| ---------------------- | -------------------------------------------------------------------------------------------- | -| `this` | [`MarkdownThemeContext`](../../../../classes/MarkdownThemeContext.md) | -| `model` | [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html) | -| `options` | `object` | -| `options.headingLevel` | `number` | -| `options.nested`? | `boolean` | - -#### Returns - -`string` - -#### Defined in - -[packages/typedoc-plugin-markdown/src/theme/context/partials/member.declaration.ts:16](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/member.declaration.ts#L16) - -*** - -### declarationTitle() - -```ts -function declarationTitle(this, model): string -``` - -Comments for declaration - -#### Parameters - -| Parameter | Type | -| --------- | -------------------------------------------------------------------------------------------- | -| `this` | [`MarkdownThemeContext`](../../../../classes/MarkdownThemeContext.md) | -| `model` | [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html) | - -#### Returns - -`string` - -#### Defined in - -[packages/typedoc-plugin-markdown/src/theme/context/partials/member.declarationTitle.ts:11](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/member.declarationTitle.ts#L11) - -*** - -### documents() - -```ts -function documents( - this, - model, - options): string -``` - -#### Parameters - -| Parameter | Type | -| ---------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `this` | [`MarkdownThemeContext`](../../../../classes/MarkdownThemeContext.md) | -| `model` | [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html) \| [`ContainerReflection`](https://typedoc.org/api/classes/Models.ContainerReflection.html) \| [`ProjectReflection`](https://typedoc.org/api/classes/Models.ProjectReflection.html) | -| `options` | `object` | -| `options.headingLevel` | `number` | - -#### Returns - -`string` - -#### Defined in - -[packages/typedoc-plugin-markdown/src/theme/context/partials/member.documents.ts:13](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/member.documents.ts#L13) - -*** - -### enumMembersTable() - -```ts -function enumMembersTable(this, model): string -``` - -Renders enum members as a table. - -#### Parameters - -| Parameter | Type | -| --------- | ----------------------------------------------------------------------------------------------- | -| `this` | [`MarkdownThemeContext`](../../../../classes/MarkdownThemeContext.md) | -| `model` | [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html)\[] | - -#### Returns - -`string` - -#### Defined in - -[packages/typedoc-plugin-markdown/src/theme/context/partials/member.enumMembersTable.ts:11](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/member.enumMembersTable.ts#L11) - -*** - -### hierarchy() - -```ts -function hierarchy( - this, - model, - options): string -``` - -#### Parameters - -| Parameter | Type | -| ---------------------- | ------------------------------------------------------------------------------------------ | -| `this` | [`MarkdownThemeContext`](../../../../classes/MarkdownThemeContext.md) | -| `model` | [`DeclarationHierarchy`](https://typedoc.org/api/classes/Models.DeclarationHierarchy.html) | -| `options` | `object` | -| `options.headingLevel` | `number` | - -#### Returns - -`string` - -#### Defined in - -[packages/typedoc-plugin-markdown/src/theme/context/partials/member.hierarchy.ts:8](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/member.hierarchy.ts#L8) - -*** - -### indexSignature() - -```ts -function indexSignature(this, model): string -``` - -Renders an index signature block - -#### Parameters - -| Parameter | Type | -| --------- | ---------------------------------------------------------------------------------------- | -| `this` | [`MarkdownThemeContext`](../../../../classes/MarkdownThemeContext.md) | -| `model` | [`SignatureReflection`](https://typedoc.org/api/classes/Models.SignatureReflection.html) | - -#### Returns - -`string` - -#### Defined in - -[packages/typedoc-plugin-markdown/src/theme/context/partials/member.indexSignature.ts:10](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/member.indexSignature.ts#L10) - -*** - -### inheritance() - -```ts -function inheritance( - this, - model, - options): string -``` - -Renders an inheritance section. - -#### Parameters - -| Parameter | Type | -| ---------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `this` | [`MarkdownThemeContext`](../../../../classes/MarkdownThemeContext.md) | -| `model` | [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html) \| [`SignatureReflection`](https://typedoc.org/api/classes/Models.SignatureReflection.html) | -| `options` | `object` | -| `options.headingLevel` | `number` | - -#### Returns - -`string` - -#### Defined in - -[packages/typedoc-plugin-markdown/src/theme/context/partials/member.inheritance.ts:10](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/member.inheritance.ts#L10) - -*** - -### memberTitle() - -```ts -function memberTitle(this, model): string -``` - -Renders the main member title. - -#### Parameters - -| Parameter | Type | -| --------- | -------------------------------------------------------------------------------------------- | -| `this` | [`MarkdownThemeContext`](../../../../classes/MarkdownThemeContext.md) | -| `model` | [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html) | - -#### Returns - -`string` - -#### Defined in - -[packages/typedoc-plugin-markdown/src/theme/context/partials/member.memberTitle.ts:11](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/member.memberTitle.ts#L11) - -*** - -### memberWithGroups() - -```ts -function memberWithGroups( - this, - model, - options): string -``` - -Renders a top-level member that contains group and child members such as Classes, Interfaces and Enums. - -#### Parameters - -| Parameter | Type | -| ---------------------- | -------------------------------------------------------------------------------------------- | -| `this` | [`MarkdownThemeContext`](../../../../classes/MarkdownThemeContext.md) | -| `model` | [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html) | -| `options` | `object` | -| `options.headingLevel` | `number` | - -#### Returns - -`string` - -#### Defined in - -[packages/typedoc-plugin-markdown/src/theme/context/partials/member.memberWithGroups.ts:10](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/member.memberWithGroups.ts#L10) - -*** - -### parametersList() - -```ts -function parametersList(this, model): string -``` - -#### Parameters - -| Parameter | Type | -| --------- | ------------------------------------------------------------------------------------------- | -| `this` | [`MarkdownThemeContext`](../../../../classes/MarkdownThemeContext.md) | -| `model` | [`ParameterReflection`](https://typedoc.org/api/classes/Models.ParameterReflection.html)\[] | - -#### Returns - -`string` - -#### Defined in - -[packages/typedoc-plugin-markdown/src/theme/context/partials/member.parametersList.ts:9](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/member.parametersList.ts#L9) - -*** - -### parametersTable() - -```ts -function parametersTable(this, model): string -``` - -#### Parameters - -| Parameter | Type | -| --------- | ------------------------------------------------------------------------------------------- | -| `this` | [`MarkdownThemeContext`](../../../../classes/MarkdownThemeContext.md) | -| `model` | [`ParameterReflection`](https://typedoc.org/api/classes/Models.ParameterReflection.html)\[] | - -#### Returns - -`string` - -#### Defined in - -[packages/typedoc-plugin-markdown/src/theme/context/partials/member.parametersTable.ts:9](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/member.parametersTable.ts#L9) - -*** - -### propertiesTable() - -```ts -function propertiesTable( - this, - model, - options?): string -``` - -Renders a collection of properties in a table. - -There is no association list partial for properties as these are handled as a standard list of members. - -#### Parameters - -| Parameter | Type | -| ----------------------- | ----------------------------------------------------------------------------------------------- | -| `this` | [`MarkdownThemeContext`](../../../../classes/MarkdownThemeContext.md) | -| `model` | [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html)\[] | -| `options`? | `object` | -| `options.isEventProps`? | `boolean` | - -#### Returns - -`string` - -#### Defined in - -[packages/typedoc-plugin-markdown/src/theme/context/partials/member.propertiesTable.ts:15](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/member.propertiesTable.ts#L15) - -*** - -### referenceMember() - -```ts -function referenceMember(this, model): string -``` - -Renders an reference member. - -#### Parameters - -| Parameter | Type | -| --------- | ---------------------------------------------------------------------------------------- | -| `this` | [`MarkdownThemeContext`](../../../../classes/MarkdownThemeContext.md) | -| `model` | [`ReferenceReflection`](https://typedoc.org/api/classes/Models.ReferenceReflection.html) | - -#### Returns - -`string` - -#### Defined in - -[packages/typedoc-plugin-markdown/src/theme/context/partials/member.reference.ts:10](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/member.reference.ts#L10) - -*** - -### reflectionIndex() - -```ts -function reflectionIndex( - this, - model, - options): string -``` - -#### Parameters - -| Parameter | Type | -| ---------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `this` | [`MarkdownThemeContext`](../../../../classes/MarkdownThemeContext.md) | -| `model` | [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html) \| [`ProjectReflection`](https://typedoc.org/api/classes/Models.ProjectReflection.html) | -| `options` | `object` | -| `options.headingLevel` | `number` | - -#### Returns - -`string` - -#### Defined in - -[packages/typedoc-plugin-markdown/src/theme/context/partials/member.reflectionIndex.ts:13](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/member.reflectionIndex.ts#L13) - -*** - -### signature() - -```ts -function signature( - this, - model, - options): string -``` - -Renders a signature member. - -#### Parameters - -| Parameter | Type | -| ----------------------------- | ---------------------------------------------------------------------------------------- | -| `this` | [`MarkdownThemeContext`](../../../../classes/MarkdownThemeContext.md) | -| `model` | [`SignatureReflection`](https://typedoc.org/api/classes/Models.SignatureReflection.html) | -| `options` | `object` | -| `options.headingLevel` | `number` | -| `options.nested`? | `boolean` | -| `options.accessor`? | `string` | -| `options.multipleSignatures`? | `boolean` | - -#### Returns - -`string` - -#### Defined in - -[packages/typedoc-plugin-markdown/src/theme/context/partials/member.signature.ts:10](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/member.signature.ts#L10) - -*** - -### signatureParameters() - -```ts -function signatureParameters(this, model): string -``` - -#### Parameters - -| Parameter | Type | -| --------- | ------------------------------------------------------------------------------------------- | -| `this` | [`MarkdownThemeContext`](../../../../classes/MarkdownThemeContext.md) | -| `model` | [`ParameterReflection`](https://typedoc.org/api/classes/Models.ParameterReflection.html)\[] | - -#### Returns - -`string` - -#### Defined in - -[packages/typedoc-plugin-markdown/src/theme/context/partials/member.signatureParameters.ts:8](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/member.signatureParameters.ts#L8) - -*** - -### signatureReturns() - -```ts -function signatureReturns( - this, - model, - options): string -``` - -#### Parameters - -| Parameter | Type | -| ---------------------- | ---------------------------------------------------------------------------------------- | -| `this` | [`MarkdownThemeContext`](../../../../classes/MarkdownThemeContext.md) | -| `model` | [`SignatureReflection`](https://typedoc.org/api/classes/Models.SignatureReflection.html) | -| `options` | `object` | -| `options.headingLevel` | `number` | - -#### Returns - -`string` - -#### Defined in - -[packages/typedoc-plugin-markdown/src/theme/context/partials/member.signatureReturns.ts:13](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/member.signatureReturns.ts#L13) - -*** - -### signatureTitle() - -```ts -function signatureTitle( - this, - model, - options?): string -``` - -#### Parameters - -| Parameter | Type | -| ---------------------- | ---------------------------------------------------------------------------------------- | -| `this` | [`MarkdownThemeContext`](../../../../classes/MarkdownThemeContext.md) | -| `model` | [`SignatureReflection`](https://typedoc.org/api/classes/Models.SignatureReflection.html) | -| `options`? | `object` | -| `options.accessor`? | `string` | -| `options.includeType`? | `boolean` | - -#### Returns - -`string` - -#### Defined in - -[packages/typedoc-plugin-markdown/src/theme/context/partials/member.signatureTitle.ts:9](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/member.signatureTitle.ts#L9) - -*** - -### signatures() - -```ts -function signatures( - this, - model, - options): string -``` - -Renders a signature collection. - -#### Parameters - -| Parameter | Type | -| ---------------------- | -------------------------------------------------------------------------------------------- | -| `this` | [`MarkdownThemeContext`](../../../../classes/MarkdownThemeContext.md) | -| `model` | [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html) | -| `options` | `object` | -| `options.headingLevel` | `number` | -| `options.nested`? | `boolean` | - -#### Returns - -`string` - -#### Defined in - -[packages/typedoc-plugin-markdown/src/theme/context/partials/member.signatures.ts:11](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/member.signatures.ts#L11) - -*** - -### sources() - -```ts -function sources( - this, - model, - options): string -``` - -#### Parameters - -| Parameter | Type | -| ---------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `this` | [`MarkdownThemeContext`](../../../../classes/MarkdownThemeContext.md) | -| `model` | [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html) \| [`SignatureReflection`](https://typedoc.org/api/classes/Models.SignatureReflection.html) | -| `options` | `object` | -| `options.headingLevel` | `number` | - -#### Returns - -`string` - -#### Defined in - -[packages/typedoc-plugin-markdown/src/theme/context/partials/member.sources.ts:9](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/member.sources.ts#L9) - -*** - -### member() - -```ts -function member( - this, - model, - options): string -``` - -#### Parameters - -| Parameter | Type | -| ---------------------- | -------------------------------------------------------------------------------------------- | -| `this` | [`MarkdownThemeContext`](../../../../classes/MarkdownThemeContext.md) | -| `model` | [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html) | -| `options` | `object` | -| `options.headingLevel` | `number` | -| `options.nested`? | `boolean` | - -#### Returns - -`string` - -#### Defined in - -[packages/typedoc-plugin-markdown/src/theme/context/partials/member.ts:11](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/member.ts#L11) - -*** - -### typeAndParent() - -```ts -function typeAndParent(this, model): string -``` - -#### Parameters - -| Parameter | Type | -| --------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | -| `this` | [`MarkdownThemeContext`](../../../../classes/MarkdownThemeContext.md) | -| `model` | [`ReferenceType`](https://typedoc.org/api/classes/Models.ReferenceType.html) \| [`ArrayType`](https://typedoc.org/api/types/Models.ArrayType.html) | - -#### Returns - -`string` - -#### Defined in - -[packages/typedoc-plugin-markdown/src/theme/context/partials/member.typeAndParent.ts:8](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/member.typeAndParent.ts#L8) - -*** - -### typeArguments() - -```ts -function typeArguments( - this, - model, - options?): string -``` - -#### Parameters - -| Parameter | Type | -| ----------------------- | --------------------------------------------------------------------- | -| `this` | [`MarkdownThemeContext`](../../../../classes/MarkdownThemeContext.md) | -| `model` | [`SomeType`](https://typedoc.org/api/classes/Models.SomeType.html)\[] | -| `options`? | `object` | -| `options.foreCollpase`? | `boolean` | - -#### Returns - -`string` - -#### Defined in - -[packages/typedoc-plugin-markdown/src/theme/context/partials/member.typeArguments.ts:7](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/member.typeArguments.ts#L7) - -*** - -### typeDeclaration() - -```ts -function typeDeclaration( - this, - model, - options): string -``` - -#### Parameters - -| Parameter | Type | -| ---------------------- | ----------------------------------------------------------------------------------------------- | -| `this` | [`MarkdownThemeContext`](../../../../classes/MarkdownThemeContext.md) | -| `model` | [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html)\[] | -| `options` | `object` | -| `options.headingLevel` | `number` | - -#### Returns - -`string` - -#### Defined in - -[packages/typedoc-plugin-markdown/src/theme/context/partials/member.typeDeclaration.ts:7](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/member.typeDeclaration.ts#L7) - -*** - -### typeDeclarationList() - -```ts -function typeDeclarationList( - this, - model, - headingLevel): string -``` - -#### Parameters - -| Parameter | Type | -| -------------- | ----------------------------------------------------------------------------------------------- | -| `this` | [`MarkdownThemeContext`](../../../../classes/MarkdownThemeContext.md) | -| `model` | [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html)\[] | -| `headingLevel` | `number` | - -#### Returns - -`string` - -#### Defined in - -[packages/typedoc-plugin-markdown/src/theme/context/partials/member.typeDeclarationList.ts:7](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/member.typeDeclarationList.ts#L7) - -*** - -### typeDeclarationTable() - -```ts -function typeDeclarationTable(this, model): string -``` - -#### Parameters - -| Parameter | Type | -| --------- | ----------------------------------------------------------------------------------------------- | -| `this` | [`MarkdownThemeContext`](../../../../classes/MarkdownThemeContext.md) | -| `model` | [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html)\[] | - -#### Returns - -`string` - -#### Defined in - -[packages/typedoc-plugin-markdown/src/theme/context/partials/member.typeDeclarationTable.ts:9](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/member.typeDeclarationTable.ts#L9) - -*** - -### typeParametersList() - -```ts -function typeParametersList(this, model): string -``` - -#### Parameters - -| Parameter | Type | -| --------- | --------------------------------------------------------------------------------------------------- | -| `this` | [`MarkdownThemeContext`](../../../../classes/MarkdownThemeContext.md) | -| `model` | [`TypeParameterReflection`](https://typedoc.org/api/classes/Models.TypeParameterReflection.html)\[] | - -#### Returns - -`string` - -#### Defined in - -[packages/typedoc-plugin-markdown/src/theme/context/partials/member.typeParametersList.ts:8](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/member.typeParametersList.ts#L8) - -*** - -### typeParametersTable() - -```ts -function typeParametersTable(this, model): string -``` - -#### Parameters - -| Parameter | Type | -| --------- | --------------------------------------------------------------------------------------------------- | -| `this` | [`MarkdownThemeContext`](../../../../classes/MarkdownThemeContext.md) | -| `model` | [`TypeParameterReflection`](https://typedoc.org/api/classes/Models.TypeParameterReflection.html)\[] | - -#### Returns - -`string` - -#### Defined in - -[packages/typedoc-plugin-markdown/src/theme/context/partials/member.typeParametersTable.ts:8](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/member.typeParametersTable.ts#L8) - -## Comment Partials - -### comment() - -```ts -function comment( - this, - model, - options): string -``` - -#### Parameters - -| Parameter | Type | -| ------------------------ | --------------------------------------------------------------------- | -| `this` | [`MarkdownThemeContext`](../../../../classes/MarkdownThemeContext.md) | -| `model` | [`Comment`](https://typedoc.org/api/types/Models.Comment.html) | -| `options` | `object` | -| `options.headingLevel`? | `number` | -| `options.showSummary`? | `boolean` | -| `options.showTags`? | `boolean` | -| `options.isTableColumn`? | `boolean` | - -#### Returns - -`string` - -#### Defined in - -[packages/typedoc-plugin-markdown/src/theme/context/partials/comments.comment.ts:9](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/comments.comment.ts#L9) - -*** - -### commentParts() - -```ts -function commentParts(this, model): string -``` - -#### Parameters - -| Parameter | Type | -| --------- | --------------------------------------------------------------------------------------- | -| `this` | [`MarkdownThemeContext`](../../../../classes/MarkdownThemeContext.md) | -| `model` | [`CommentDisplayPart`](https://typedoc.org/api/types/Models.CommentDisplayPart.html)\[] | - -#### Returns - -`string` - -#### Defined in - -[packages/typedoc-plugin-markdown/src/theme/context/partials/comments.commentParts.ts:9](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/comments.commentParts.ts#L9) - -## Type Partials - -### arrayType() - -```ts -function arrayType(this, model): string -``` - -#### Parameters - -| Parameter | Type | -| --------- | --------------------------------------------------------------------- | -| `this` | [`MarkdownThemeContext`](../../../../classes/MarkdownThemeContext.md) | -| `model` | [`ArrayType`](https://typedoc.org/api/types/Models.ArrayType.html) | - -#### Returns - -`string` - -#### Defined in - -[packages/typedoc-plugin-markdown/src/theme/context/partials/type.array.ts:7](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/type.array.ts#L7) - -*** - -### conditionalType() - -```ts -function conditionalType(this, model): string -``` - -#### Parameters - -| Parameter | Type | -| --------- | ------------------------------------------------------------------------------ | -| `this` | [`MarkdownThemeContext`](../../../../classes/MarkdownThemeContext.md) | -| `model` | [`ConditionalType`](https://typedoc.org/api/types/Models.ConditionalType.html) | - -#### Returns - -`string` - -#### Defined in - -[packages/typedoc-plugin-markdown/src/theme/context/partials/type.conditional.ts:8](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/type.conditional.ts#L8) - -*** - -### indexAccessType() - -```ts -function indexAccessType(this, model): string -``` - -#### Parameters - -| Parameter | Type | -| --------- | ---------------------------------------------------------------------------------- | -| `this` | [`MarkdownThemeContext`](../../../../classes/MarkdownThemeContext.md) | -| `model` | [`IndexedAccessType`](https://typedoc.org/api/types/Models.IndexedAccessType.html) | - -#### Returns - -`string` - -#### Defined in - -[packages/typedoc-plugin-markdown/src/theme/context/partials/type.index-access.ts:7](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/type.index-access.ts#L7) - -*** - -### inferredType() - -```ts -function inferredType(this, model): string -``` - -#### Parameters - -| Parameter | Type | -| --------- | ------------------------------------------------------------------------ | -| `this` | [`MarkdownThemeContext`](../../../../classes/MarkdownThemeContext.md) | -| `model` | [`InferredType`](https://typedoc.org/api/types/Models.InferredType.html) | - -#### Returns - -`string` - -#### Defined in - -[packages/typedoc-plugin-markdown/src/theme/context/partials/type.inferred.ts:8](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/type.inferred.ts#L8) - -*** - -### intersectionType() - -```ts -function intersectionType(this, model): string -``` - -#### Parameters - -| Parameter | Type | -| --------- | -------------------------------------------------------------------------------- | -| `this` | [`MarkdownThemeContext`](../../../../classes/MarkdownThemeContext.md) | -| `model` | [`IntersectionType`](https://typedoc.org/api/types/Models.IntersectionType.html) | - -#### Returns - -`string` - -#### Defined in - -[packages/typedoc-plugin-markdown/src/theme/context/partials/type.intersection.ts:7](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/type.intersection.ts#L7) - -*** - -### intrinsicType() - -```ts -function intrinsicType(this, model): string -``` - -#### Parameters - -| Parameter | Type | -| --------- | -------------------------------------------------------------------------- | -| `this` | [`MarkdownThemeContext`](../../../../classes/MarkdownThemeContext.md) | -| `model` | [`IntrinsicType`](https://typedoc.org/api/types/Models.IntrinsicType.html) | - -#### Returns - -`string` - -#### Defined in - -[packages/typedoc-plugin-markdown/src/theme/context/partials/type.intrinsic.ts:8](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/type.intrinsic.ts#L8) - -*** - -### literalType() - -```ts -function literalType(this, model): string -``` - -#### Parameters - -| Parameter | Type | -| --------- | ---------------------------------------------------------------------- | -| `this` | [`MarkdownThemeContext`](../../../../classes/MarkdownThemeContext.md) | -| `model` | [`LiteralType`](https://typedoc.org/api/types/Models.LiteralType.html) | - -#### Returns - -`string` - -#### Defined in - -[packages/typedoc-plugin-markdown/src/theme/context/partials/type.literal.ts:7](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/type.literal.ts#L7) - -*** - -### namedTupleType() - -```ts -function namedTupleType(this, model): string -``` - -#### Parameters - -| Parameter | Type | -| --------- | -------------------------------------------------------------------------------- | -| `this` | [`MarkdownThemeContext`](../../../../classes/MarkdownThemeContext.md) | -| `model` | [`NamedTupleMember`](https://typedoc.org/api/types/Models.NamedTupleMember.html) | - -#### Returns - -`string` - -#### Defined in - -[packages/typedoc-plugin-markdown/src/theme/context/partials/type.named-tuple.ts:7](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/type.named-tuple.ts#L7) - -*** - -### queryType() - -```ts -function queryType(this, model): string -``` - -#### Parameters - -| Parameter | Type | -| --------- | --------------------------------------------------------------------- | -| `this` | [`MarkdownThemeContext`](../../../../classes/MarkdownThemeContext.md) | -| `model` | [`QueryType`](https://typedoc.org/api/types/Models.QueryType.html) | - -#### Returns - -`string` - -#### Defined in - -[packages/typedoc-plugin-markdown/src/theme/context/partials/type.query.ts:8](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/type.query.ts#L8) - -*** - -### referenceType() - -```ts -function referenceType(this, model): string -``` - -#### Parameters - -| Parameter | Type | -| --------- | ---------------------------------------------------------------------------- | -| `this` | [`MarkdownThemeContext`](../../../../classes/MarkdownThemeContext.md) | -| `model` | [`ReferenceType`](https://typedoc.org/api/classes/Models.ReferenceType.html) | - -#### Returns - -`string` - -#### Defined in - -[packages/typedoc-plugin-markdown/src/theme/context/partials/type.reference.ts:8](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/type.reference.ts#L8) - -*** - -### declarationType() - -```ts -function declarationType(this, model): string -``` - -#### Parameters - -| Parameter | Type | -| --------- | -------------------------------------------------------------------------------------------- | -| `this` | [`MarkdownThemeContext`](../../../../classes/MarkdownThemeContext.md) | -| `model` | [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html) | - -#### Returns - -`string` - -#### Defined in - -[packages/typedoc-plugin-markdown/src/theme/context/partials/type.reflection.declaration.ts:8](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/type.reflection.declaration.ts#L8) - -*** - -### functionType() - -```ts -function functionType( - this, - model, - options?): string -``` - -#### Parameters - -| Parameter | Type | -| ----------------------------- | ------------------------------------------------------------------------------------------- | -| `this` | [`MarkdownThemeContext`](../../../../classes/MarkdownThemeContext.md) | -| `model` | [`SignatureReflection`](https://typedoc.org/api/classes/Models.SignatureReflection.html)\[] | -| `options`? | `object` | -| `options.forceParameterType`? | `boolean` | - -#### Returns - -`string` - -#### Defined in - -[packages/typedoc-plugin-markdown/src/theme/context/partials/type.reflection.function.ts:8](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/type.reflection.function.ts#L8) - -*** - -### reflectionType() - -```ts -function reflectionType( - this, - model, - options?): string -``` - -#### Parameters - -| Parameter | Type | -| ----------------------- | ------------------------------------------------------------------------------ | -| `this` | [`MarkdownThemeContext`](../../../../classes/MarkdownThemeContext.md) | -| `model` | [`ReflectionType`](https://typedoc.org/api/classes/Models.ReflectionType.html) | -| `options`? | `object` | -| `options.foreCollpase`? | `boolean` | - -#### Returns - -`string` - -#### Defined in - -[packages/typedoc-plugin-markdown/src/theme/context/partials/type.reflection.ts:8](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/type.reflection.ts#L8) - -*** - -### someType() - -```ts -function someType(this, model?): string -``` - -Takes a generic Type and returns the appropriate partial for it. - -#### Parameters - -| Parameter | Type | -| --------- | --------------------------------------------------------------------- | -| `this` | [`MarkdownThemeContext`](../../../../classes/MarkdownThemeContext.md) | -| `model`? | [`SomeType`](https://typedoc.org/api/classes/Models.SomeType.html) | - -#### Returns - -`string` - -#### Defined in - -[packages/typedoc-plugin-markdown/src/theme/context/partials/type.some.ts:26](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/type.some.ts#L26) - -*** - -### tupleType() - -```ts -function tupleType(this, model): string -``` - -#### Parameters - -| Parameter | Type | -| --------- | --------------------------------------------------------------------- | -| `this` | [`MarkdownThemeContext`](../../../../classes/MarkdownThemeContext.md) | -| `model` | [`TupleType`](https://typedoc.org/api/classes/Models.TupleType.html) | - -#### Returns - -`string` - -#### Defined in - -[packages/typedoc-plugin-markdown/src/theme/context/partials/type.tuple.ts:7](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/type.tuple.ts#L7) - -*** - -### typeOperatorType() - -```ts -function typeOperatorType(this, model): string -``` - -#### Parameters - -| Parameter | Type | -| --------- | ------------------------------------------------------------------------------ | -| `this` | [`MarkdownThemeContext`](../../../../classes/MarkdownThemeContext.md) | -| `model` | [`TypeOperatorType`](https://typedoc.org/api/interfaces/TypeOperatorType.html) | - -#### Returns - -`string` - -#### Defined in - -[packages/typedoc-plugin-markdown/src/theme/context/partials/type.type-operator.ts:7](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/type.type-operator.ts#L7) - -*** - -### unionType() - -```ts -function unionType(this, model): string -``` - -#### Parameters - -| Parameter | Type | -| --------- | --------------------------------------------------------------------- | -| `this` | [`MarkdownThemeContext`](../../../../classes/MarkdownThemeContext.md) | -| `model` | [`UnionType`](https://typedoc.org/api/types/Models.UnionType.html) | - -#### Returns - -`string` - -#### Defined in - -[packages/typedoc-plugin-markdown/src/theme/context/partials/type.union.ts:7](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/type.union.ts#L7) - -*** - -### unknownType() - -```ts -function unknownType(this, model): string -``` - -#### Parameters - -| Parameter | Type | -| --------- | ---------------------------------------------------------------------- | -| `this` | [`MarkdownThemeContext`](../../../../classes/MarkdownThemeContext.md) | -| `model` | [`UnknownType`](https://typedoc.org/api/types/Models.UnknownType.html) | - -#### Returns - -`string` - -#### Defined in - -[packages/typedoc-plugin-markdown/src/theme/context/partials/type.unknown.ts:8](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/type.unknown.ts#L8) - -## Other - -### isFile() - -```ts -function isFile(file): boolean -``` - -#### Parameters - -| Parameter | Type | -| --------- | -------- | -| `file` | `string` | - -#### Returns - -`boolean` - -#### Defined in - -[packages/typedoc-plugin-markdown/src/theme/context/partials/comments.commentParts.ts:67](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/comments.commentParts.ts#L67) diff --git a/packages/typedoc-plugin-markdown/developer-docs/theme/namespaces/context/namespaces/templates/README.md b/packages/typedoc-plugin-markdown/developer-docs/theme/namespaces/context/namespaces/templates/README.md deleted file mode 100644 index 3cd45b879..000000000 --- a/packages/typedoc-plugin-markdown/developer-docs/theme/namespaces/context/namespaces/templates/README.md +++ /dev/null @@ -1,112 +0,0 @@ -[typedoc-plugin-markdown v4.0.3](../../../../../README.md) / [theme](../../../../README.md) / [context](../../README.md) / templates - -# Namespace: templates - -Then `templates` namespace holds the main templates for the theme and are mapped to single pages and configured in the MarkdownTheme. - -All templates return a string that is passed back to the renderer. Internally templates call partials and helpers. - -## Table of Contents - -* [document()](#document) -* [project()](#project) -* [readme()](#readme) -* [reflection()](#reflection) - -## document() - -```ts -function document(this, page): string -``` - -Template that maps to a project document. - -### Parameters - -| Parameter | Type | -| --------- | --------------------------------------------------------------------------------------------------------------- | -| `this` | [`MarkdownThemeContext`](../../../../classes/MarkdownThemeContext.md) | -| `page` | [`MarkdownPageEvent`](../../../../../app/namespaces/events/classes/MarkdownPageEvent.md)\<`DocumentReflection`> | - -### Returns - -`string` - -### Defined in - -[packages/typedoc-plugin-markdown/src/theme/context/templates/document.ts:8](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/templates/document.ts#L8) - -*** - -## project() - -```ts -function project(this, page): string -``` - -Template that maps to the root project reflection. This will be the index page / documentation root page. - -### Parameters - -| Parameter | Type | -| --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `this` | [`MarkdownThemeContext`](../../../../classes/MarkdownThemeContext.md) | -| `page` | [`MarkdownPageEvent`](../../../../../app/namespaces/events/classes/MarkdownPageEvent.md)\<[`ProjectReflection`](https://typedoc.org/api/classes/Models.ProjectReflection.html)> | - -### Returns - -`string` - -### Defined in - -[packages/typedoc-plugin-markdown/src/theme/context/templates/project.ts:14](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/templates/project.ts#L14) - -*** - -## readme() - -```ts -function readme(this, page): string -``` - -Template that specifically maps to the resolved readme file. This template is not used when 'readme' is set to 'none'. - -### Parameters - -| Parameter | Type | -| --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `this` | [`MarkdownThemeContext`](../../../../classes/MarkdownThemeContext.md) | -| `page` | [`MarkdownPageEvent`](../../../../../app/namespaces/events/classes/MarkdownPageEvent.md)\<[`ProjectReflection`](https://typedoc.org/api/classes/Models.ProjectReflection.html)> | - -### Returns - -`string` - -### Defined in - -[packages/typedoc-plugin-markdown/src/theme/context/templates/read-me.ts:8](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/templates/read-me.ts#L8) - -*** - -## reflection() - -```ts -function reflection(this, page): string -``` - -Template that maps to individual reflection models. - -### Parameters - -| Parameter | Type | -| --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `this` | [`MarkdownThemeContext`](../../../../classes/MarkdownThemeContext.md) | -| `page` | [`MarkdownPageEvent`](../../../../../app/namespaces/events/classes/MarkdownPageEvent.md)\<[`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html)> | - -### Returns - -`string` - -### Defined in - -[packages/typedoc-plugin-markdown/src/theme/context/templates/reflection.ts:9](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/templates/reflection.ts#L9) diff --git a/packages/typedoc-plugin-markdown/developer-docs/theme/namespaces/core/README.md b/packages/typedoc-plugin-markdown/developer-docs/theme/namespaces/core/README.md deleted file mode 100644 index 45fe9ee96..000000000 --- a/packages/typedoc-plugin-markdown/developer-docs/theme/namespaces/core/README.md +++ /dev/null @@ -1,18 +0,0 @@ -[typedoc-plugin-markdown v4.0.3](../../../README.md) / [theme](../../README.md) / core - -# Namespace: core - -Support for the MarkdownTheme core class building URLs and navigation. - -## Table of Contents - -* [Index](#index) - -## Index - -### Classes - -| Class | Description | -| ------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -| [NavigationBuilder](classes/NavigationBuilder.md) | - | -| [UrlBuilder](classes/UrlBuilder.md) | Map the models of the given project to the desired output files. Based on TypeDoc DefaultTheme.getUrls() | diff --git a/packages/typedoc-plugin-markdown/developer-docs/theme/namespaces/core/classes/NavigationBuilder.md b/packages/typedoc-plugin-markdown/developer-docs/theme/namespaces/core/classes/NavigationBuilder.md deleted file mode 100644 index bf501316f..000000000 --- a/packages/typedoc-plugin-markdown/developer-docs/theme/namespaces/core/classes/NavigationBuilder.md +++ /dev/null @@ -1,72 +0,0 @@ -[typedoc-plugin-markdown v4.0.3](../../../../README.md) / [theme](../../../README.md) / [core](../README.md) / NavigationBuilder - -# Class: NavigationBuilder - -## Table of Contents - -* [Constructors](#constructors) -* [Methods](#methods) -* [Properties](#properties) - -## Constructors - -### new NavigationBuilder() - -```ts -new NavigationBuilder(theme, project): NavigationBuilder -``` - -#### Parameters - -| Parameter | Type | -| --------- | ------------------------------------------------------------------------------------ | -| `theme` | [`MarkdownTheme`](../../../classes/MarkdownTheme.md) | -| `project` | [`ProjectReflection`](https://typedoc.org/api/classes/Models.ProjectReflection.html) | - -#### Returns - -[`NavigationBuilder`](NavigationBuilder.md) - -#### Defined in - -[packages/typedoc-plugin-markdown/src/theme/core/navigation-builder.ts:25](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/core/navigation-builder.ts#L25) - -## Methods - -### getNavigation() - -```ts -getNavigation(): NavigationItem[] -``` - -#### Returns - -[`NavigationItem`](../../types/interfaces/NavigationItem.md)\[] - -#### Defined in - -[packages/typedoc-plugin-markdown/src/theme/core/navigation-builder.ts:40](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/core/navigation-builder.ts#L40) - -## Properties - -### theme - -```ts -theme: MarkdownTheme; -``` - -#### Defined in - -[packages/typedoc-plugin-markdown/src/theme/core/navigation-builder.ts:26](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/core/navigation-builder.ts#L26) - -*** - -### project - -```ts -project: ProjectReflection; -``` - -#### Defined in - -[packages/typedoc-plugin-markdown/src/theme/core/navigation-builder.ts:27](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/core/navigation-builder.ts#L27) diff --git a/packages/typedoc-plugin-markdown/developer-docs/theme/namespaces/core/classes/UrlBuilder.md b/packages/typedoc-plugin-markdown/developer-docs/theme/namespaces/core/classes/UrlBuilder.md deleted file mode 100644 index a907d8f60..000000000 --- a/packages/typedoc-plugin-markdown/developer-docs/theme/namespaces/core/classes/UrlBuilder.md +++ /dev/null @@ -1,102 +0,0 @@ -[typedoc-plugin-markdown v4.0.3](../../../../README.md) / [theme](../../../README.md) / [core](../README.md) / UrlBuilder - -# Class: UrlBuilder - -Map the models of the given project to the desired output files. -Based on TypeDoc DefaultTheme.getUrls() - -## Table of Contents - -* [Param](#param) -* [Constructors](#constructors) -* [Methods](#methods) -* [Properties](#properties) - -## Param - -The project whose urls should be generated. - -## Constructors - -### new UrlBuilder() - -```ts -new UrlBuilder(theme, project): UrlBuilder -``` - -#### Parameters - -| Parameter | Type | -| --------- | ------------------------------------------------------------------------------------ | -| `theme` | [`MarkdownTheme`](../../../classes/MarkdownTheme.md) | -| `project` | [`ProjectReflection`](https://typedoc.org/api/classes/Models.ProjectReflection.html) | - -#### Returns - -[`UrlBuilder`](UrlBuilder.md) - -#### Defined in - -[packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts:40](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts#L40) - -## Methods - -### getUrls() - -```ts -getUrls(): UrlMapping[] -``` - -#### Returns - -[`UrlMapping`](../../types/interfaces/UrlMapping.md)\<[`Reflection`](https://typedoc.org/api/classes/Models.Reflection.html)>\[] - -#### Defined in - -[packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts:65](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts#L65) - -*** - -### getFlattenedUrl() - -```ts -getFlattenedUrl(reflection): string -``` - -#### Parameters - -| Parameter | Type | -| ------------ | -------------------------------------------------------------------------------------------- | -| `reflection` | [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html) | - -#### Returns - -`string` - -#### Defined in - -[packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts:401](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts#L401) - -## Properties - -### theme - -```ts -theme: MarkdownTheme; -``` - -#### Defined in - -[packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts:41](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts#L41) - -*** - -### project - -```ts -project: ProjectReflection; -``` - -#### Defined in - -[packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts:42](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts#L42) diff --git a/packages/typedoc-plugin-markdown/developer-docs/theme/namespaces/types/README.md b/packages/typedoc-plugin-markdown/developer-docs/theme/namespaces/types/README.md deleted file mode 100644 index 416f8a5c6..000000000 --- a/packages/typedoc-plugin-markdown/developer-docs/theme/namespaces/types/README.md +++ /dev/null @@ -1,25 +0,0 @@ -[typedoc-plugin-markdown v4.0.3](../../../README.md) / [theme](../../README.md) / types - -# Namespace: types - -## Table of Contents - -* [Index](#index) - -## Index - -### Interfaces - -| Interface | Description | -| ------------------------------------------------ | -------------------------------------------------------------------- | -| [PackageMetaData](interfaces/PackageMetaData.md) | The model used to define the package metadata when in packages mode. | -| [UrlMapping](interfaces/UrlMapping.md) | The model used to define the URL mapping structure. | -| [NavigationItem](interfaces/NavigationItem.md) | The model used to define the navigation structure. | -| [TemplateMapping](interfaces/TemplateMapping.md) | - | -| [UrlOption](interfaces/UrlOption.md) | - | - -### Type Aliases - -| Type alias | Description | -| ------------------------------------------------ | ----------- | -| [RenderTemplate](type-aliases/RenderTemplate.md) | - | diff --git a/packages/typedoc-plugin-markdown/developer-docs/theme/namespaces/types/interfaces/NavigationItem.md b/packages/typedoc-plugin-markdown/developer-docs/theme/namespaces/types/interfaces/NavigationItem.md deleted file mode 100644 index 9e5128d7f..000000000 --- a/packages/typedoc-plugin-markdown/developer-docs/theme/namespaces/types/interfaces/NavigationItem.md +++ /dev/null @@ -1,57 +0,0 @@ -[typedoc-plugin-markdown v4.0.3](../../../../README.md) / [theme](../../../README.md) / [types](../README.md) / NavigationItem - -# Interface: NavigationItem - -The model used to define the navigation structure. - -## Table of Contents - -* [Properties](#properties) - -## Properties - -### title - -```ts -title: string; -``` - -#### Defined in - -[packages/typedoc-plugin-markdown/src/theme/types.ts:29](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/types.ts#L29) - -*** - -### path? - -```ts -optional path: null | string; -``` - -#### Defined in - -[packages/typedoc-plugin-markdown/src/theme/types.ts:30](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/types.ts#L30) - -*** - -### kind? - -```ts -optional kind: ReflectionKind; -``` - -#### Defined in - -[packages/typedoc-plugin-markdown/src/theme/types.ts:31](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/types.ts#L31) - -*** - -### children? - -```ts -optional children: NavigationItem[]; -``` - -#### Defined in - -[packages/typedoc-plugin-markdown/src/theme/types.ts:32](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/types.ts#L32) diff --git a/packages/typedoc-plugin-markdown/developer-docs/theme/namespaces/types/interfaces/PackageMetaData.md b/packages/typedoc-plugin-markdown/developer-docs/theme/namespaces/types/interfaces/PackageMetaData.md deleted file mode 100644 index 220924aed..000000000 --- a/packages/typedoc-plugin-markdown/developer-docs/theme/namespaces/types/interfaces/PackageMetaData.md +++ /dev/null @@ -1,33 +0,0 @@ -[typedoc-plugin-markdown v4.0.3](../../../../README.md) / [theme](../../../README.md) / [types](../README.md) / PackageMetaData - -# Interface: PackageMetaData - -The model used to define the package metadata when in packages mode. - -## Table of Contents - -* [Properties](#properties) - -## Properties - -### description - -```ts -description: string; -``` - -#### Defined in - -[packages/typedoc-plugin-markdown/src/theme/types.ts:10](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/types.ts#L10) - -*** - -### options - -```ts -options: Options; -``` - -#### Defined in - -[packages/typedoc-plugin-markdown/src/theme/types.ts:11](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/types.ts#L11) diff --git a/packages/typedoc-plugin-markdown/developer-docs/theme/namespaces/types/interfaces/TemplateMapping.md b/packages/typedoc-plugin-markdown/developer-docs/theme/namespaces/types/interfaces/TemplateMapping.md deleted file mode 100644 index d8172b571..000000000 --- a/packages/typedoc-plugin-markdown/developer-docs/theme/namespaces/types/interfaces/TemplateMapping.md +++ /dev/null @@ -1,43 +0,0 @@ -[typedoc-plugin-markdown v4.0.3](../../../../README.md) / [theme](../../../README.md) / [types](../README.md) / TemplateMapping - -# Interface: TemplateMapping - -## Table of Contents - -* [Properties](#properties) - -## Properties - -### directory - -```ts -directory: null | string; -``` - -#### Defined in - -[packages/typedoc-plugin-markdown/src/theme/types.ts:38](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/types.ts#L38) - -*** - -### template - -```ts -template: any; -``` - -#### Defined in - -[packages/typedoc-plugin-markdown/src/theme/types.ts:39](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/types.ts#L39) - -*** - -### kind - -```ts -kind: ReflectionKind; -``` - -#### Defined in - -[packages/typedoc-plugin-markdown/src/theme/types.ts:40](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/types.ts#L40) diff --git a/packages/typedoc-plugin-markdown/developer-docs/theme/namespaces/types/interfaces/UrlMapping.md b/packages/typedoc-plugin-markdown/developer-docs/theme/namespaces/types/interfaces/UrlMapping.md deleted file mode 100644 index f1073d39a..000000000 --- a/packages/typedoc-plugin-markdown/developer-docs/theme/namespaces/types/interfaces/UrlMapping.md +++ /dev/null @@ -1,62 +0,0 @@ -[typedoc-plugin-markdown v4.0.3](../../../../README.md) / [theme](../../../README.md) / [types](../README.md) / UrlMapping - -# Interface: UrlMapping\ - -The model used to define the URL mapping structure. - -## Table of Contents - -* [Type Parameters](#type-parameters) -* [Properties](#properties) - -## Type Parameters - -| Type Parameter | -| -------------- | -| `Model` | - -## Properties - -### url - -```ts -url: string; -``` - -#### Defined in - -[packages/typedoc-plugin-markdown/src/theme/types.ts:19](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/types.ts#L19) - -*** - -### model - -```ts -model: Model; -``` - -#### Defined in - -[packages/typedoc-plugin-markdown/src/theme/types.ts:20](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/types.ts#L20) - -*** - -### template() - -```ts -template: (data) => string; -``` - -#### Parameters - -| Parameter | Type | -| --------- | ----------------------------------------------------------------------------------------------- | -| `data` | [`MarkdownPageEvent`](../../../../app/namespaces/events/classes/MarkdownPageEvent.md)\<`Model`> | - -#### Returns - -`string` - -#### Defined in - -[packages/typedoc-plugin-markdown/src/theme/types.ts:21](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/types.ts#L21) diff --git a/packages/typedoc-plugin-markdown/developer-docs/theme/namespaces/types/interfaces/UrlOption.md b/packages/typedoc-plugin-markdown/developer-docs/theme/namespaces/types/interfaces/UrlOption.md deleted file mode 100644 index db01bfb42..000000000 --- a/packages/typedoc-plugin-markdown/developer-docs/theme/namespaces/types/interfaces/UrlOption.md +++ /dev/null @@ -1,79 +0,0 @@ -[typedoc-plugin-markdown v4.0.3](../../../../README.md) / [theme](../../../README.md) / [types](../README.md) / UrlOption - -# Interface: UrlOption - -## Table of Contents - -* [Properties](#properties) - -## Properties - -### parentUrl? - -```ts -optional parentUrl: string; -``` - -#### Defined in - -[packages/typedoc-plugin-markdown/src/theme/types.ts:44](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/types.ts#L44) - -*** - -### directory? - -```ts -optional directory: null | string; -``` - -#### Defined in - -[packages/typedoc-plugin-markdown/src/theme/types.ts:45](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/types.ts#L45) - -*** - -### forceDirectory? - -```ts -optional forceDirectory: boolean; -``` - -#### Defined in - -[packages/typedoc-plugin-markdown/src/theme/types.ts:46](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/types.ts#L46) - -*** - -### outputFileStrategy? - -```ts -optional outputFileStrategy: OutputFileStrategy; -``` - -#### Defined in - -[packages/typedoc-plugin-markdown/src/theme/types.ts:47](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/types.ts#L47) - -*** - -### entryModule? - -```ts -optional entryModule: string; -``` - -#### Defined in - -[packages/typedoc-plugin-markdown/src/theme/types.ts:48](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/types.ts#L48) - -*** - -### entryFileName? - -```ts -optional entryFileName: string; -``` - -#### Defined in - -[packages/typedoc-plugin-markdown/src/theme/types.ts:49](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/types.ts#L49) diff --git a/packages/typedoc-plugin-markdown/developer-docs/theme/namespaces/types/type-aliases/RenderTemplate.md b/packages/typedoc-plugin-markdown/developer-docs/theme/namespaces/types/type-aliases/RenderTemplate.md deleted file mode 100644 index 39ce6322b..000000000 --- a/packages/typedoc-plugin-markdown/developer-docs/theme/namespaces/types/type-aliases/RenderTemplate.md +++ /dev/null @@ -1,27 +0,0 @@ -[typedoc-plugin-markdown v4.0.3](../../../../README.md) / [theme](../../../README.md) / [types](../README.md) / RenderTemplate - -# Type Alias: RenderTemplate()\ - -```ts -type RenderTemplate: (data) => string; -``` - -## Type Parameters - -| Type Parameter | -| -------------- | -| `T` | - -## Parameters - -| Parameter | Type | -| --------- | ---- | -| `data` | `T` | - -## Returns - -`string` - -## Defined in - -[packages/typedoc-plugin-markdown/src/theme/types.ts:35](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/types.ts#L35) diff --git a/packages/typedoc-plugin-markdown/internal-docs/Adding-Options.md b/packages/typedoc-plugin-markdown/internal-docs/Adding-Options.md deleted file mode 100644 index c833dd785..000000000 --- a/packages/typedoc-plugin-markdown/internal-docs/Adding-Options.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -title: Adding Options -description: How to add options ---- - -# How to add options diff --git a/packages/typedoc-plugin-markdown/internal-docs/machine-setup.md b/packages/typedoc-plugin-markdown/internal-docs/machine-setup.md new file mode 100644 index 000000000..1b3390a20 --- /dev/null +++ b/packages/typedoc-plugin-markdown/internal-docs/machine-setup.md @@ -0,0 +1,44 @@ +--- +title: Machine Setup +description: Get ready to start developing. +--- + +# Machine Setup + +This is a simple monorepo managed by [npm workspaces](https://docs.npmjs.com/cli/v7/using-npm/workspaces). + +**1. Fork and clone the repository** + +Start by forking the repository to your own GitHub account. Then, clone the repository to your local machine. Please replace `` with your actual GitHub username. + +```bash +git clone git@github.com:/typedoc-plugin-markdown.git +``` + +**2. Install dependencies** + +Navigate to the repository root and install the necessary dependencies: + +```bash +cd typedoc-plugin-markdown + +npm install +``` + +**3. Build the packages and run tests** + +Finally, you can build all the packages and run the tests to ensure everything is set up correctly. + +Build all packages in the workspace: + +```bash +npm run build +``` + +Test all packages in the workspace: + +```bash +npm run test +``` + +If the project builds and the tests run successfully you are ready to start contributing to the project. diff --git a/packages/typedoc-plugin-markdown/package.json b/packages/typedoc-plugin-markdown/package.json index de552a320..d7b08b0ba 100644 --- a/packages/typedoc-plugin-markdown/package.json +++ b/packages/typedoc-plugin-markdown/package.json @@ -21,7 +21,8 @@ "schema": "ts-node ./.scripts/schema/generate-schema.ts", "docs": "npm run build && typedoc --options ./.docs/typedoc.json", "docs:html": "typedoc --options ./.docs/typedoc.html.json", - "docs:dev": "npm run build && typedoc" + "docs:dev": "npm run build && typedoc", + "playground": "npm run build && typedoc --options ./playground/typedoc.json" }, "author": "Thomas Grey", "license": "MIT", diff --git a/packages/typedoc-plugin-markdown/playground/src/person.ts b/packages/typedoc-plugin-markdown/playground/src/person.ts new file mode 100644 index 000000000..6c149d900 --- /dev/null +++ b/packages/typedoc-plugin-markdown/playground/src/person.ts @@ -0,0 +1,40 @@ +class Person { + // Class properties + private name: string; + private age: number; + + // Constructor to initialize the properties + constructor(name: string, age: number) { + this.name = name; + this.age = age; + } + + // Method to get the person's name + public getName(): string { + return this.name; + } + + // Method to set the person's name + public setName(name: string): void { + this.name = name; + } + + // Method to get the person's age + public getAge(): number { + return this.age; + } + + // Method to set the person's age + public setAge(age: number): void { + if (age > 0) { + this.age = age; + } else { + console.log('Age must be a positive number.'); + } + } + + // Method to greet + public greet(): string { + return `Hello, my name is ${this.name} and I am ${this.age} years old.`; + } +} diff --git a/packages/typedoc-plugin-markdown/playground/tsconfig.json b/packages/typedoc-plugin-markdown/playground/tsconfig.json new file mode 100644 index 000000000..a5ce66ef7 --- /dev/null +++ b/packages/typedoc-plugin-markdown/playground/tsconfig.json @@ -0,0 +1,14 @@ +{ + "compilerOptions": { + "experimentalDecorators": true, + "esModuleInterop": true, + "lib": ["es2020", "dom"], + "module": "commonjs", + "moduleResolution": "node", + "noImplicitAny": false, + "noUnusedLocals": false, + "noUnusedParameters": false, + "strictNullChecks": false, + "target": "es2020" + } +} diff --git a/packages/typedoc-plugin-markdown/playground/typedoc.json b/packages/typedoc-plugin-markdown/playground/typedoc.json new file mode 100644 index 000000000..4ae2b7e56 --- /dev/null +++ b/packages/typedoc-plugin-markdown/playground/typedoc.json @@ -0,0 +1,7 @@ +{ + "entryPoints": ["./src/*"], + "tsconfig": "./tsconfig.json", + "out": "./docs", + "readme": "none", + "plugin": ["typedoc-plugin-markdown"] +} diff --git a/packages/typedoc-plugin-markdown/src/app/events/markdown-renderer-event.ts b/packages/typedoc-plugin-markdown/src/app/events/markdown-renderer-event.ts index 0f23a74bd..ae09070a3 100644 --- a/packages/typedoc-plugin-markdown/src/app/events/markdown-renderer-event.ts +++ b/packages/typedoc-plugin-markdown/src/app/events/markdown-renderer-event.ts @@ -6,6 +6,8 @@ import { Event, ProjectReflection, Reflection } from 'typedoc'; /** * An event emitted at the beginning and end of the rendering process. * + * @example + * * ```ts * app.renderer.on(MarkdownRendererEvent.BEGIN, (event) => { * console.log(`Render Starting for ${event.project.name}!`); diff --git a/packages/typedoc-plugin-markdown/src/app/types/markdown-renderer-hooks.ts b/packages/typedoc-plugin-markdown/src/app/types/markdown-renderer-hooks.ts index e470398f9..cc7ebfafb 100644 --- a/packages/typedoc-plugin-markdown/src/app/types/markdown-renderer-hooks.ts +++ b/packages/typedoc-plugin-markdown/src/app/types/markdown-renderer-hooks.ts @@ -42,6 +42,27 @@ export interface MarkdownRendererHooks { */ ['index.page.begin']: [MarkdownThemeContext]; + /** + * Applied before the main markdown content is rendered on the index page. + * + * @group Hooks + */ + ['index.content.begin']: [MarkdownThemeContext]; + + /** + * Applied at the start of the markdown output on the packages root page. + * + * @group Hooks + */ + ['packages.page.begin']: [MarkdownThemeContext]; + + /** + * Applied before the main markdown content is rendered on the packages root page. + * + * @group Hooks + */ + ['packages.content.begin']: [MarkdownThemeContext]; + /** * Applied at the end of the markdown output on the index page. * diff --git a/packages/typedoc-plugin-markdown/src/index.ts b/packages/typedoc-plugin-markdown/src/index.ts index 76c805c06..d0055fb33 100644 --- a/packages/typedoc-plugin-markdown/src/index.ts +++ b/packages/typedoc-plugin-markdown/src/index.ts @@ -1,5 +1,5 @@ +import { initialize } from 'app'; import { Application } from 'typedoc'; -import { initialize } from './app'; /** * Plugin load diff --git a/packages/typedoc-plugin-markdown/src/libs/utils/format-markdown.ts b/packages/typedoc-plugin-markdown/src/libs/utils/format-markdown.ts index 617d6ae95..bfe56f0a0 100644 --- a/packages/typedoc-plugin-markdown/src/libs/utils/format-markdown.ts +++ b/packages/typedoc-plugin-markdown/src/libs/utils/format-markdown.ts @@ -1,3 +1,3 @@ export function formatMarkdown(str: string) { - return str.replace(/[\r\n]{3,}/g, '\n\n').replace(/^\s+|\s+$/g, '') + '\n'; + return str?.replace(/[\r\n]{3,}/g, '\n\n').replace(/^\s+|\s+$/g, '') + '\n'; } diff --git a/packages/typedoc-plugin-markdown/src/libs/utils/remove-line-breaks.ts b/packages/typedoc-plugin-markdown/src/libs/utils/remove-line-breaks.ts index b4f3af518..d7be912e1 100644 --- a/packages/typedoc-plugin-markdown/src/libs/utils/remove-line-breaks.ts +++ b/packages/typedoc-plugin-markdown/src/libs/utils/remove-line-breaks.ts @@ -1,3 +1,3 @@ export function removeLineBreaks(str: string) { - return str.replace(/\n/g, ' ').replace(/ {2,}/g, ' '); + return str?.replace(/\n/g, ' ').replace(/ {2,}/g, ' '); } diff --git a/packages/typedoc-plugin-markdown/src/options/constants.ts b/packages/typedoc-plugin-markdown/src/options/constants.ts index 30f1000b3..ba3caf4b6 100644 --- a/packages/typedoc-plugin-markdown/src/options/constants.ts +++ b/packages/typedoc-plugin-markdown/src/options/constants.ts @@ -6,6 +6,9 @@ import { ReflectionKind } from 'typedoc'; +/** + * Default values for `membersWithOwnFile` option. + */ export const ALLOWED_OWN_FILE_MEMBERS = [ ReflectionKind[ReflectionKind.Enum], ReflectionKind[ReflectionKind.Variable], @@ -15,6 +18,9 @@ export const ALLOWED_OWN_FILE_MEMBERS = [ ReflectionKind[ReflectionKind.TypeAlias], ]; +/** + * Default values for `textContentMappings` option. + */ export const TEXT_CONTENT_MAPPINGS = { 'header.title': '{projectName} {version}', 'header.docs': 'Docs', diff --git a/packages/typedoc-plugin-markdown/src/theme/context/helpers/get-flattened-declarations.ts b/packages/typedoc-plugin-markdown/src/theme/context/helpers/get-flattened-declarations.ts index 5af71b7ec..d2de067b6 100644 --- a/packages/typedoc-plugin-markdown/src/theme/context/helpers/get-flattened-declarations.ts +++ b/packages/typedoc-plugin-markdown/src/theme/context/helpers/get-flattened-declarations.ts @@ -7,6 +7,7 @@ export function getFlattenedDeclarations( const getFlattenedDeclarations = (current: DeclarationReflection) => { return (current.type as any)?.declaration?.children?.reduce( (acc: DeclarationReflection[], child: DeclarationReflection) => { + (child as any).originalName = child.name; const childObj = { ...child, name: `${current.name}.${child.name}`, @@ -22,6 +23,7 @@ export function getFlattenedDeclarations( acc: DeclarationReflection[], ) => { const shouldFlatten = (current.type as any)?.declaration?.children; + const isAccessor = current.kind === ReflectionKind.Accessor; if (options?.includeSignatures) { diff --git a/packages/typedoc-plugin-markdown/src/theme/context/helpers/get-group-index-table.ts b/packages/typedoc-plugin-markdown/src/theme/context/helpers/get-group-index-table.ts index c93be000e..52d081a47 100644 --- a/packages/typedoc-plugin-markdown/src/theme/context/helpers/get-group-index-table.ts +++ b/packages/typedoc-plugin-markdown/src/theme/context/helpers/get-group-index-table.ts @@ -16,10 +16,13 @@ export function getGroupIndexTable( 'tableColumnSettings', ).leftAlignHeaders; - const headers = [ - kind ? ReflectionKind.singularString(kind) : this.i18n.theme_member(), - ]; + const childKindStrings = children.map((child) => + ReflectionKind.singularString(child.kind), + ); + + const headers = [[...new Set(childKindStrings)].join(', ')]; headers.push(this.i18n.theme_description()); + const rows: string[][] = []; children.forEach((child) => { const row: string[] = []; diff --git a/packages/typedoc-plugin-markdown/src/theme/context/partials/member.declarationTitle.ts b/packages/typedoc-plugin-markdown/src/theme/context/partials/member.declarationTitle.ts index bb17dd59c..8478a806f 100644 --- a/packages/typedoc-plugin-markdown/src/theme/context/partials/member.declarationTitle.ts +++ b/packages/typedoc-plugin-markdown/src/theme/context/partials/member.declarationTitle.ts @@ -51,9 +51,12 @@ export function declarationTitle( } const nameParts = model.name.split('.'); - const declarationName = model.escapedName?.includes('.') - ? model.name - : nameParts[nameParts.length - 1]; + + const declarationName = + Boolean(model.escapedName) && nameParts.length > 1 + ? nameParts[nameParts.length - 1] + : model.name; + name.push( /[\\`]/.test(declarationName) ? escapeChars(declarationName) @@ -78,7 +81,11 @@ export function declarationTitle( md.push(this.partials.someType(declarationType)); } - if (model.defaultValue && model.defaultValue !== model.name) { + if ( + model.defaultValue && + model.defaultValue !== '...' && + model.defaultValue !== model.name + ) { md.push(` = \`${model.defaultValue}\``); } diff --git a/packages/typedoc-plugin-markdown/src/theme/context/partials/member.enumMembersTable.ts b/packages/typedoc-plugin-markdown/src/theme/context/partials/member.enumMembersTable.ts index 9284811a0..324ae71bb 100644 --- a/packages/typedoc-plugin-markdown/src/theme/context/partials/member.enumMembersTable.ts +++ b/packages/typedoc-plugin-markdown/src/theme/context/partials/member.enumMembersTable.ts @@ -38,6 +38,7 @@ export function enumMembersTable( model.forEach((property: DeclarationReflection) => { const propertyType = this.helpers.getDeclarationType(property); + const row: string[] = []; const nameColumn: string[] = []; diff --git a/packages/typedoc-plugin-markdown/src/theme/context/partials/member.parametersTable.ts b/packages/typedoc-plugin-markdown/src/theme/context/partials/member.parametersTable.ts index d2d261fab..4ad7e751d 100644 --- a/packages/typedoc-plugin-markdown/src/theme/context/partials/member.parametersTable.ts +++ b/packages/typedoc-plugin-markdown/src/theme/context/partials/member.parametersTable.ts @@ -81,7 +81,7 @@ export function parametersTable( const displayType = parameter.type instanceof ReflectionType ? this.partials.reflectionType(parameter.type, { - foreCollpase: true, + forceCollapse: true, }) : this.partials.someType(parameter.type); row.push(removeLineBreaks(displayType)); diff --git a/packages/typedoc-plugin-markdown/src/theme/context/partials/member.typeArguments.ts b/packages/typedoc-plugin-markdown/src/theme/context/partials/member.typeArguments.ts index 1f6981dd0..dc36c140d 100644 --- a/packages/typedoc-plugin-markdown/src/theme/context/partials/member.typeArguments.ts +++ b/packages/typedoc-plugin-markdown/src/theme/context/partials/member.typeArguments.ts @@ -7,13 +7,13 @@ import { ReflectionType, SomeType } from 'typedoc'; export function typeArguments( this: MarkdownThemeContext, model: SomeType[], - options?: { foreCollpase?: boolean }, + options?: { forceCollapse?: boolean }, ): string { return `\\<${model .map((typeArgument) => typeArgument instanceof ReflectionType ? this.partials.reflectionType(typeArgument, { - foreCollpase: options?.foreCollpase, + forceCollapse: options?.forceCollapse, }) : this.partials.someType(typeArgument), ) diff --git a/packages/typedoc-plugin-markdown/src/theme/context/partials/member.typeDeclaration.ts b/packages/typedoc-plugin-markdown/src/theme/context/partials/member.typeDeclaration.ts index 31044ecad..9b1eb7afd 100644 --- a/packages/typedoc-plugin-markdown/src/theme/context/partials/member.typeDeclaration.ts +++ b/packages/typedoc-plugin-markdown/src/theme/context/partials/member.typeDeclaration.ts @@ -19,7 +19,7 @@ export function typeDeclaration( ) { md.push(this.partials.typeDeclarationTable(model)); } else { - md.push(this.partials.typeDeclarationList(model, options.headingLevel)); + md.push(this.partials.typeDeclarationList(model, options)); } return md.join('\n\n'); diff --git a/packages/typedoc-plugin-markdown/src/theme/context/partials/member.typeDeclarationList.ts b/packages/typedoc-plugin-markdown/src/theme/context/partials/member.typeDeclarationList.ts index e0fb311a0..a8ec77cae 100644 --- a/packages/typedoc-plugin-markdown/src/theme/context/partials/member.typeDeclarationList.ts +++ b/packages/typedoc-plugin-markdown/src/theme/context/partials/member.typeDeclarationList.ts @@ -7,14 +7,14 @@ import { DeclarationReflection } from 'typedoc'; export function typeDeclarationList( this: MarkdownThemeContext, model: DeclarationReflection[], - headingLevel: number, + options: { headingLevel: number }, ): string { const md: string[] = []; const declarations = this.helpers.getFlattenedDeclarations(model); declarations?.forEach((declaration: DeclarationReflection) => { md.push( this.partials.memberContainer(declaration, { - headingLevel: headingLevel + 1, + headingLevel: options.headingLevel + 1, nested: true, }), ); diff --git a/packages/typedoc-plugin-markdown/src/theme/context/partials/member.typeDeclarationTable.ts b/packages/typedoc-plugin-markdown/src/theme/context/partials/member.typeDeclarationTable.ts index dc8f0a956..7f26b5366 100644 --- a/packages/typedoc-plugin-markdown/src/theme/context/partials/member.typeDeclarationTable.ts +++ b/packages/typedoc-plugin-markdown/src/theme/context/partials/member.typeDeclarationTable.ts @@ -23,8 +23,9 @@ export function typeDeclarationTable( includeSignatures: true, }); - const hasDefaultValues = declarations.some((declaration) => - Boolean(declaration.defaultValue), + const hasDefaultValues = declarations.some( + (declaration) => + Boolean(declaration.defaultValue) && declaration.defaultValue !== '...', ); const hasComments = declarations.some((declaration) => @@ -36,7 +37,7 @@ export function typeDeclarationTable( headers.push(this.i18n.theme_type()); if (hasDefaultValues) { - headers.push(this.i18n.theme_value()); + headers.push(this.i18n.theme_default_value()); } if (hasComments) { @@ -58,7 +59,11 @@ export function typeDeclarationTable( if (hasDefaultValues) { row.push( - escapeChars(!declaration.defaultValue ? '-' : declaration.defaultValue), + escapeChars( + !declaration.defaultValue || declaration.defaultValue === '...' + ? '-' + : declaration.defaultValue, + ), ); } diff --git a/packages/typedoc-plugin-markdown/src/theme/context/partials/page.header.ts b/packages/typedoc-plugin-markdown/src/theme/context/partials/page.header.ts index 7048fec94..c06c7db76 100644 --- a/packages/typedoc-plugin-markdown/src/theme/context/partials/page.header.ts +++ b/packages/typedoc-plugin-markdown/src/theme/context/partials/page.header.ts @@ -19,6 +19,7 @@ export function header(this: MarkdownThemeContext): string { const isPackages = this.options.getValue('entryPointStrategy') === EntryPointStrategy.Packages; + if (isPackages) { const packageItem = findPackage(this.page.model as ProjectReflection); if (packageItem) { diff --git a/packages/typedoc-plugin-markdown/src/theme/context/partials/page.pageTitle.ts b/packages/typedoc-plugin-markdown/src/theme/context/partials/page.pageTitle.ts index 5cba4198e..f2435bea9 100644 --- a/packages/typedoc-plugin-markdown/src/theme/context/partials/page.pageTitle.ts +++ b/packages/typedoc-plugin-markdown/src/theme/context/partials/page.pageTitle.ts @@ -16,10 +16,13 @@ export function pageTitle(this: MarkdownThemeContext): string { const name = this.partials.memberTitle(page.model as DeclarationReflection); const kind = this.internationalization.kindSingularString(page.model.kind); - const textContent = - page.model.kind === ReflectionKind.Module - ? name - : textContentMappings['title.memberPage']; + + const textContent = [ + ReflectionKind.Module, + ReflectionKind.Namespace, + ].includes(page.model.kind) + ? name + : textContentMappings['title.memberPage']; return textContent.replace('{name}', name).replace('{kind}', kind); } diff --git a/packages/typedoc-plugin-markdown/src/theme/context/partials/type.reflection.ts b/packages/typedoc-plugin-markdown/src/theme/context/partials/type.reflection.ts index 7e988fa14..f65647d21 100644 --- a/packages/typedoc-plugin-markdown/src/theme/context/partials/type.reflection.ts +++ b/packages/typedoc-plugin-markdown/src/theme/context/partials/type.reflection.ts @@ -8,7 +8,7 @@ import { ReflectionType } from 'typedoc'; export function reflectionType( this: MarkdownThemeContext, model: ReflectionType, - options?: { foreCollpase?: boolean }, + options?: { forceCollapse?: boolean }, ): string { const root = model instanceof ReflectionType ? model.declaration : model; if (root.signatures) { @@ -16,7 +16,7 @@ export function reflectionType( } const expandObjects = - !options?.foreCollpase && + !options?.forceCollapse && (this.options.getValue('expandObjects') as boolean); return expandObjects diff --git a/packages/typedoc-plugin-markdown/src/theme/context/resources.ts b/packages/typedoc-plugin-markdown/src/theme/context/resources.ts index b5ee7f8ad..fc87d04fc 100644 --- a/packages/typedoc-plugin-markdown/src/theme/context/resources.ts +++ b/packages/typedoc-plugin-markdown/src/theme/context/resources.ts @@ -347,7 +347,7 @@ There is no association list partial for properties as these are handled as a st /** @ignore **/ typeArguments: ( model: SomeType[], - options?: { foreCollpase?: boolean | undefined } | undefined, + options?: { forceCollapse?: boolean | undefined } | undefined, ) => partials.typeArguments.apply(context, [model, options]) as string, /** * @@ -365,12 +365,9 @@ There is no association list partial for properties as these are handled as a st /** @ignore **/ typeDeclarationList: ( model: DeclarationReflection[], - headingLevel: number, + options: { headingLevel: number }, ) => - partials.typeDeclarationList.apply(context, [ - model, - headingLevel, - ]) as string, + partials.typeDeclarationList.apply(context, [model, options]) as string, /** * * @category Member Partials @@ -516,7 +513,7 @@ There is no association list partial for properties as these are handled as a st /** @ignore **/ reflectionType: ( model: ReflectionType, - options?: { foreCollpase?: boolean | undefined } | undefined, + options?: { forceCollapse?: boolean | undefined } | undefined, ) => partials.reflectionType.apply(context, [model, options]) as string, /** * Takes a generic Type and returns the appropriate partial for it. diff --git a/packages/typedoc-plugin-markdown/src/theme/context/templates/project.ts b/packages/typedoc-plugin-markdown/src/theme/context/templates/project.ts index a5d924ed7..3051c031d 100644 --- a/packages/typedoc-plugin-markdown/src/theme/context/templates/project.ts +++ b/packages/typedoc-plugin-markdown/src/theme/context/templates/project.ts @@ -17,9 +17,19 @@ export function project( ) { const md: string[] = []; + const isPackages = + this.page.project.url === this.page.url && + this.options.getValue('entryPointStrategy') === + EntryPointStrategy.Packages && + this.options.getValue('entryPoints')?.length; + const textContentMappings = this.options.getValue('textContentMappings'); - md.push(this.hook('index.page.begin').join('\n')); + if (isPackages) { + md.push(this.hook('packages.page.begin').join('\n')); + } else { + md.push(this.hook('index.page.begin').join('\n')); + } if (!this.options.getValue('hidePageHeader')) { md.push(this.partials.header()); @@ -40,7 +50,11 @@ export function project( md.push(heading(1, this.partials.pageTitle())); } - md.push(this.hook('content.begin').join('\n')); + if (isPackages) { + md.push(this.hook('packages.content.begin').join('\n')); + } else { + md.push(this.hook('index.content.begin').join('\n')); + } if (page.model.comment) { md.push(this.partials.comment(page.model.comment, { headingLevel: 2 })); @@ -78,12 +92,6 @@ export function project( ); } - const isPackages = - this.page.project.url === this.page.url && - this.options.getValue('entryPointStrategy') === - EntryPointStrategy.Packages && - this.options.getValue('entryPoints')?.length; - if (isPackages) { md.push(this.partials.packagesIndex(page.model)); } else { diff --git a/packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts b/packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts index ed6224a6a..03e5ffc97 100644 --- a/packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts +++ b/packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts @@ -51,7 +51,7 @@ export class MarkdownTheme extends Theme { try { return formatMarkdown(template(page)); } catch (e) { - this.application.logger.error(`Error rendering page ${page.url}.`); + this.application.logger.error(`Error rendering page ${page.url}. ${e}`); throw new Error(e); } } diff --git a/packages/typedoc-plugin-markdown/test/fixtures/config.ts b/packages/typedoc-plugin-markdown/test/fixtures/config.ts index d446359d8..0560bd7e0 100644 --- a/packages/typedoc-plugin-markdown/test/fixtures/config.ts +++ b/packages/typedoc-plugin-markdown/test/fixtures/config.ts @@ -151,6 +151,8 @@ const config: Record = { parametersFormat: 'htmlTable', propertiesFormat: 'htmlTable', typeDeclarationFormat: 'htmlTable', + useCodeBlocks: false, + expandObjects: true, tableColumnSettings: { hideDefaults: true, hideInherited: true, diff --git a/packages/typedoc-plugin-markdown/test/fixtures/src/comments/index.ts b/packages/typedoc-plugin-markdown/test/fixtures/src/comments/index.ts index 1a732fd1e..3802383ae 100644 --- a/packages/typedoc-plugin-markdown/test/fixtures/src/comments/index.ts +++ b/packages/typedoc-plugin-markdown/test/fixtures/src/comments/index.ts @@ -223,7 +223,6 @@ export type TypeDeclarationTable = { * to generate the binary output for input validation. */ declaration2: boolean; - declaration3: 'declaration3'; declaration4: 100; }; diff --git a/packages/typedoc-plugin-markdown/test/fixtures/src/groups/has-categories.ts b/packages/typedoc-plugin-markdown/test/fixtures/src/groups/has-categories.ts index 1b8038111..756a4eab4 100644 --- a/packages/typedoc-plugin-markdown/test/fixtures/src/groups/has-categories.ts +++ b/packages/typedoc-plugin-markdown/test/fixtures/src/groups/has-categories.ts @@ -37,5 +37,11 @@ export enum CategoryBEnum1 {} */ export enum CategoryBEnum2 {} +/** + * @category Category C + */ +export interface CategoryCInterface1 {} +export interface CategoryCInterface2 {} + export interface UnCategorizedInterace {} export enum UnCategorizedEnum {} diff --git a/packages/typedoc-plugin-markdown/test/specs/__snapshots__/comments.spec.ts.snap b/packages/typedoc-plugin-markdown/test/specs/__snapshots__/comments.spec.ts.snap index 60150be6b..ef1d0426f 100644 --- a/packages/typedoc-plugin-markdown/test/specs/__snapshots__/comments.spec.ts.snap +++ b/packages/typedoc-plugin-markdown/test/specs/__snapshots__/comments.spec.ts.snap @@ -368,7 +368,6 @@ exports[`Comments should get tables for type declarations: (Output File Strategy | ------ | ------ | ------ | ------ | | \`declaration1\` | \`boolean\` | The subroutine recursively parsed the hexadecimal data. to generate the binary output for input validation. | [index.ts:1](http://source-url) | | \`declaration2\` | \`boolean\` | The subroutine recursively parsed the hexadecimal data. to generate the binary output for input validation. | [index.ts:1](http://source-url) | -| \`declaration3\` | \`"declaration3"\` | - | [index.ts:1](http://source-url) | | \`declaration4\` | \`100\` | - | [index.ts:1](http://source-url) | ## Source @@ -384,7 +383,7 @@ exports[`Comments should get tables for type declarations: (Output File Strategy ## Type declaration -| Member | Type | Value | Source | +| Member | Type | Default value | Source | | ------ | ------ | ------ | ------ | | \`declaration1\` | \`string\` | 'declaration3' | [index.ts:1](http://source-url) | | \`declaration2\` | \`number\` | 100 | [index.ts:1](http://source-url) | @@ -398,7 +397,7 @@ exports[`Comments should get tables for type declarations: (Output File Strategy exports[`Comments should get tables for type declarations: (Output File Strategy "members") (Option Group "2") 1`] = ` "# Type Alias: TypeDeclarationTable -> **TypeDeclarationTable**: \`object\` +> **TypeDeclarationTable**: \\{\`declaration1\`: \`boolean\`;\`declaration2\`: \`boolean\`;\`declaration4\`: \`100\`; \\} ## Type declaration @@ -443,23 +442,6 @@ to generate the binary output for input validation. -\`declaration3\` - - - - -\`"declaration3"\` - - - - -‐ - - - - - - \`declaration4\` @@ -485,12 +467,12 @@ to generate the binary output for input validation. exports[`Comments should get tables for type declarations: (Output File Strategy "members") (Option Group "2") 2`] = ` "# Variable: TypeDeclarationTable -> **TypeDeclarationTable**: \`object\` +> **TypeDeclarationTable**: \\{\`declaration1\`: \`'declaration3'\`;\`declaration2\`: \`100\`; \\} ## Type declaration - +
MemberTypeValue
MemberTypeDefault value
diff --git a/packages/typedoc-plugin-markdown/test/specs/__snapshots__/customization.spec.ts.snap b/packages/typedoc-plugin-markdown/test/specs/__snapshots__/customization.spec.ts.snap index fcab877d4..5ea5edf29 100644 --- a/packages/typedoc-plugin-markdown/test/specs/__snapshots__/customization.spec.ts.snap +++ b/packages/typedoc-plugin-markdown/test/specs/__snapshots__/customization.spec.ts.snap @@ -14,8 +14,6 @@ exports[`Customization should insert content from hooks and apply custom theme i # typedoc-stubs -> \`content.begin\` hook - Module commments **Experimental** \`my-package\` is under active development. diff --git a/packages/typedoc-plugin-markdown/test/specs/__snapshots__/groups.spec.ts.snap b/packages/typedoc-plugin-markdown/test/specs/__snapshots__/groups.spec.ts.snap index 7f50af311..10ba08b6e 100644 --- a/packages/typedoc-plugin-markdown/test/specs/__snapshots__/groups.spec.ts.snap +++ b/packages/typedoc-plugin-markdown/test/specs/__snapshots__/groups.spec.ts.snap @@ -386,8 +386,16 @@ A module that contains categories #### CategoryBInterface2 +### Category C + +#### CategoryCInterface1 + ### Other +#### CategoryCInterface2 + +*** + #### UnCategorizedInterace " `; @@ -451,6 +459,12 @@ A module that contains categories ### CategoryBInterface2 +## Category C + + + +### CategoryCInterface1 + ## Other @@ -459,6 +473,12 @@ A module that contains categories *** + + +### CategoryCInterface2 + +*** + ### UnCategorizedInterace @@ -506,8 +526,13 @@ A module that contains categories - [CategoryBInterface1](interfaces/CategoryBInterface1.md) - [CategoryBInterface2](interfaces/CategoryBInterface2.md) +#### Category C + +- [CategoryCInterface1](interfaces/CategoryCInterface1.md) + #### Other +- [CategoryCInterface2](interfaces/CategoryCInterface2.md) - [UnCategorizedInterace](interfaces/UnCategorizedInterace.md) " `; @@ -527,7 +552,7 @@ A module that contains categories ### Category A -| Member | Description | +| Enumeration, Interface | Description | | :------ | :------ | | [CategoryAEnum1](enumerations/CategoryAEnum1.md) | - | | [CategoryAEnum2](enumerations/CategoryAEnum2.md) | - | @@ -536,18 +561,25 @@ A module that contains categories ### Category B -| Member | Description | +| Enumeration, Interface | Description | | :------ | :------ | | [CategoryBEnum1](enumerations/CategoryBEnum1.md) | - | | [CategoryBEnum2](enumerations/CategoryBEnum2.md) | - | | [CategoryBInterface1](interfaces/CategoryBInterface1.md) | - | | [CategoryBInterface2](interfaces/CategoryBInterface2.md) | - | +### Category C + +| Interface | Description | +| :------ | :------ | +| [CategoryCInterface1](interfaces/CategoryCInterface1.md) | - | + ### Other -| Member | Description | +| Enumeration, Interface | Description | | :------ | :------ | | [UnCategorizedEnum](enumerations/UnCategorizedEnum.md) | - | +| [CategoryCInterface2](interfaces/CategoryCInterface2.md) | - | | [UnCategorizedInterace](interfaces/UnCategorizedInterace.md) | - | " `; @@ -718,7 +750,7 @@ exports[`Groups should compile module index for a namespace: (Output File Strate [typedoc-stubs](../../../modules.md) / [has-namespaces](../../index.md) / \\_Namespace\\_A\\_ -# Namespace: \\_Namespace\\_A\\_ +# \\_Namespace\\_A\\_ ## Index @@ -739,7 +771,7 @@ exports[`Groups should compile module index for a namespace: (Output File Strate [typedoc-stubs](../../../index.md) / [has-namespaces](../../index.md) / \\_Namespace\\_A\\_ -# Namespace: \\_Namespace\\_A\\_ +# \\_Namespace\\_A\\_ ## Index @@ -764,7 +796,7 @@ exports[`Groups should compile module index for a namespace: (Output File Strate [typedoc-stubs](../../../modules.md) / [has-namespaces](../../index.md) / \\_Namespace\\_A\\_ -# Namespace: \\_Namespace\\_A\\_ +# \\_Namespace\\_A\\_ ## Index @@ -785,7 +817,7 @@ exports[`Groups should compile module index for a namespace: (Output File Strate [typedoc-stubs](../../../index.md) / [has-namespaces](../../index.md) / \\_Namespace\\_A\\_ -# Namespace: \\_Namespace\\_A\\_ +# \\_Namespace\\_A\\_ ## Index diff --git a/packages/typedoc-plugin-markdown/test/specs/__snapshots__/navigation.spec.ts.snap b/packages/typedoc-plugin-markdown/test/specs/__snapshots__/navigation.spec.ts.snap index f98dd9793..5587fc4c2 100644 --- a/packages/typedoc-plugin-markdown/test/specs/__snapshots__/navigation.spec.ts.snap +++ b/packages/typedoc-plugin-markdown/test/specs/__snapshots__/navigation.spec.ts.snap @@ -3344,6 +3344,16 @@ exports[`Navigation should gets Navigation Json for multiple entry points: (Outp "kind": 256, "path": "has-categories/interfaces/CategoryBInterface2.md" }, + { + "title": "CategoryCInterface1", + "kind": 256, + "path": "has-categories/interfaces/CategoryCInterface1.md" + }, + { + "title": "CategoryCInterface2", + "kind": 256, + "path": "has-categories/interfaces/CategoryCInterface2.md" + }, { "title": "UnCategorizedInterace", "kind": 256, @@ -3667,6 +3677,16 @@ exports[`Navigation should gets Navigation Json for multiple entry points: (Outp } ] }, + { + "title": "Category C", + "children": [ + { + "title": "CategoryCInterface1", + "kind": 256, + "url": "has-categories/interfaces/CategoryCInterface1.md" + } + ] + }, { "title": "Other", "children": [ @@ -3675,6 +3695,11 @@ exports[`Navigation should gets Navigation Json for multiple entry points: (Outp "kind": 8, "url": "has-categories/enumerations/UnCategorizedEnum.md" }, + { + "title": "CategoryCInterface2", + "kind": 256, + "url": "has-categories/interfaces/CategoryCInterface2.md" + }, { "title": "UnCategorizedInterace", "kind": 256, diff --git a/packages/typedoc-plugin-markdown/test/specs/__snapshots__/objects-and-params.spec.ts.snap b/packages/typedoc-plugin-markdown/test/specs/__snapshots__/objects-and-params.spec.ts.snap index e7fa977f8..9ed8cdb02 100644 --- a/packages/typedoc-plugin-markdown/test/specs/__snapshots__/objects-and-params.spec.ts.snap +++ b/packages/typedoc-plugin-markdown/test/specs/__snapshots__/objects-and-params.spec.ts.snap @@ -745,7 +745,7 @@ Comments for someFunction exports[`Objects And Params should compile object with symbol: (Output File Strategy "members") (Option Group "1") 1`] = ` "# Variable: objectWithSymbol -> \`const\` **objectWithSymbol**: \\{\`[sym]\`: \`'value'\`; \\} = \`...\` +> \`const\` **objectWithSymbol**: \\{\`[sym]\`: \`'value'\`; \\} Comments variable with symbol @@ -765,7 +765,7 @@ exports[`Objects And Params should compile object with symbol: (Output File Stra \`\`\`ts const objectWithSymbol: { [sym]: 'value'; - } = ...; +}; \`\`\` Comments variable with symbol @@ -807,7 +807,7 @@ Comments for UnionType exports[`Objects And Params should compile variable assigned to an object literal: (Output File Strategy "members") (Option Group "1") 1`] = ` "# Variable: objectLiteralVariable -> \`const\` **objectLiteralVariable**: \\{\`valueA\`: \`100\`;\`valueB\`: \`true\`;\`valueX\`: \`...\`;\`valueY\`: \`...\`; \\} = \`...\` +> \`const\` **objectLiteralVariable**: \\{\`valueA\`: \`100\`;\`valueB\`: \`true\`;\`valueX\`: \`...\`;\`valueY\`: \`...\`; \\} Comments for objectLiteralVariable @@ -823,15 +823,15 @@ Comments for objectLiteralVariable ### valueX -> **valueX**: \\{\`valueA\`: \`...\`;\`valueY\`: \`...\`;\`valueZ\`: \`'foo'\`; \\} = \`...\` +> **valueX**: \\{\`valueA\`: \`...\`;\`valueY\`: \`...\`;\`valueZ\`: \`'foo'\`; \\} ### valueX.valueA -> **valueA**: \`number\`[] = \`...\` +> **valueA**: \`number\`[] ### valueX.valueY() -> **valueY**: (\`z\`: \`string\`) => \\{\`a\`: \`'test'\`;\`b\`: \`z\`;\`c\`: \`...\`; \\} = \`...\` +> **valueY**: (\`z\`: \`string\`) => \\{\`a\`: \`'test'\`;\`b\`: \`z\`;\`c\`: \`...\`; \\} #### Parameters @@ -851,7 +851,7 @@ Comments for objectLiteralVariable ##### c -> **c**: \\{\`a\`: \`1\`;\`b\`: \`2\`; \\} = \`...\` +> **c**: \\{\`a\`: \`1\`;\`b\`: \`2\`; \\} ##### c.a @@ -867,7 +867,7 @@ Comments for objectLiteralVariable ### valueY() -> **valueY**: (\`unionParam\`: \`"a"\` \\| \`"b"\`, \`_undercoreParam_\`: \`string\`) => \`string\` = \`...\` +> **valueY**: (\`unionParam\`: \`"a"\` \\| \`"b"\`, \`_undercoreParam_\`: \`string\`) => \`string\` #### Parameters @@ -890,7 +890,7 @@ const objectLiteralVariable: { valueB: true; valueX: ...; valueY: ...; - } = ...; +}; \`\`\` Comments for objectLiteralVariable @@ -916,13 +916,13 @@ valueX: { valueA: ...; valueY: ...; valueZ: 'foo'; - } = ...; +}; \`\`\` ### valueX.valueA \`\`\`ts -valueA: number[] = ...; +valueA: number[]; \`\`\` ### valueX.valueY() @@ -932,7 +932,7 @@ valueY: (z: string) => { a: 'test'; b: z; c: ...; - } = ...; +}; \`\`\` #### Parameters @@ -969,7 +969,7 @@ b: string = z; c: { a: 1; b: 2; - } = ...; +}; \`\`\` ##### c.a @@ -993,7 +993,7 @@ valueZ: string = 'foo'; ### valueY() \`\`\`ts -valueY: (unionParam: "a" | "b", _undercoreParam_: string) => string = ...; +valueY: (unionParam: "a" | "b", _undercoreParam_: string) => string; \`\`\` #### Parameters diff --git a/packages/typedoc-plugin-markdown/test/specs/__snapshots__/reflection.class.spec.ts.snap b/packages/typedoc-plugin-markdown/test/specs/__snapshots__/reflection.class.spec.ts.snap index f25fef929..71f500c79 100644 --- a/packages/typedoc-plugin-markdown/test/specs/__snapshots__/reflection.class.spec.ts.snap +++ b/packages/typedoc-plugin-markdown/test/specs/__snapshots__/reflection.class.spec.ts.snap @@ -371,11 +371,11 @@ Comments for ClassWithComplexProps ### objecLiteralProp -> **objecLiteralProp**: \`object\` = \`...\` +> **objecLiteralProp**: \`object\` #### someFunction() -> **someFunction**: (\`a\`) => \`string\` = \`...\` +> **someFunction**: (\`a\`) => \`string\` Comments for someFunction diff --git a/packages/typedoc-plugin-markdown/test/specs/__snapshots__/reflection.function.spec.ts.snap b/packages/typedoc-plugin-markdown/test/specs/__snapshots__/reflection.function.spec.ts.snap index d7f961897..1d07df6fb 100644 --- a/packages/typedoc-plugin-markdown/test/specs/__snapshots__/reflection.function.spec.ts.snap +++ b/packages/typedoc-plugin-markdown/test/specs/__snapshots__/reflection.function.spec.ts.snap @@ -234,7 +234,7 @@ Comments for function Return comments -| Member | Type | Value | +| Member | Type | Default value | | :------ | :------ | :------ | | \`x\` | \`number\` | 1 | | \`y\` | \`number\` | 2 | diff --git a/packages/typedoc-plugin-markdown/test/specs/__snapshots__/reflection.variable.spec.ts.snap b/packages/typedoc-plugin-markdown/test/specs/__snapshots__/reflection.variable.spec.ts.snap index 59813b047..fc6a98236 100644 --- a/packages/typedoc-plugin-markdown/test/specs/__snapshots__/reflection.variable.spec.ts.snap +++ b/packages/typedoc-plugin-markdown/test/specs/__snapshots__/reflection.variable.spec.ts.snap @@ -3,7 +3,7 @@ exports[`Variable Reflection should compile object with symbol: (Output File Strategy "members") (Option Group "1") 1`] = ` "# Variable: objectWithSymbol -> \`const\` **objectWithSymbol**: \`object\` = \`...\` +> \`const\` **objectWithSymbol**: \`object\` Comments variable with symbol @@ -25,14 +25,14 @@ exports[`Variable Reflection should compile object with symbol: (Output File Str "# Variable: objectWithSymbol \`\`\`ts -const objectWithSymbol: object = ...; +const objectWithSymbol: object; \`\`\` Comments variable with symbol ## Type declaration -| Member | Type | Value | Description | +| Member | Type | Default value | Description | | :------ | :------ | :------ | :------ | | \`[sym]\` | \`string\` | 'value' | Comments for symbol | @@ -45,7 +45,7 @@ Comments variable with symbol exports[`Variable Reflection should compile type operator variable: (Output File Strategy "members") (Option Group "1") 1`] = ` "# Variable: typeOperatorVariable -> \`const\` **typeOperatorVariable**: unique \`symbol\` = \`...\` +> \`const\` **typeOperatorVariable**: unique \`symbol\` Comments for typeOperatorVariable @@ -59,7 +59,7 @@ exports[`Variable Reflection should compile type operator variable: (Output File "# Variable: typeOperatorVariable \`\`\`ts -const typeOperatorVariable: unique symbol = ...; +const typeOperatorVariable: unique symbol; \`\`\` Comments for typeOperatorVariable @@ -101,7 +101,7 @@ A simple string variable exports[`Variable Reflection should compile variable assigned to an object literal: (Output File Strategy "members") (Option Group "1") 1`] = ` "# Variable: objectLiteralVariable -> \`const\` **objectLiteralVariable**: \`object\` = \`...\` +> \`const\` **objectLiteralVariable**: \`object\` Comments for objectLiteralVariable @@ -117,15 +117,15 @@ Comments for objectLiteralVariable ### valueX -> **valueX**: \`object\` = \`...\` +> **valueX**: \`object\` ### valueX.valueA -> **valueA**: \`number\`[] = \`...\` +> **valueA**: \`number\`[] ### valueX.valueY() -> **valueY**: (\`z\`) => \`object\` = \`...\` +> **valueY**: (\`z\`) => \`object\` #### Parameters @@ -145,7 +145,7 @@ Comments for objectLiteralVariable ##### c -> **c**: \`object\` = \`...\` +> **c**: \`object\` ##### c.a @@ -161,7 +161,7 @@ Comments for objectLiteralVariable ### valueY() -> **valueY**: (\`unionParam\`, \`_undercoreParam_\`) => \`string\` = \`...\` +> **valueY**: (\`unionParam\`, \`_undercoreParam_\`) => \`string\` #### Parameters @@ -183,22 +183,22 @@ exports[`Variable Reflection should compile variable assigned to an object liter "# Variable: objectLiteralVariable \`\`\`ts -const objectLiteralVariable: object = ...; +const objectLiteralVariable: object; \`\`\` Comments for objectLiteralVariable ## Type declaration -| Member | Type | Value | +| Member | Type | Default value | | :------ | :------ | :------ | | \`valueA\` | \`number\` | 100 | | \`valueB\` | \`boolean\` | true | -| \`valueX\` | \`object\` | ... | -| \`valueX.valueA\` | \`number\`[] | ... | -| \`valueX.valueY\` | (\`z\`: \`string\`) => \`object\` | ... | +| \`valueX\` | \`object\` | - | +| \`valueX.valueA\` | \`number\`[] | - | +| \`valueX.valueY\` | (\`z\`: \`string\`) => \`object\` | - | | \`valueX.valueZ\` | \`string\` | 'foo' | -| \`valueY\` | (\`unionParam\`: \`"a"\` \\| \`"b"\`, \`_undercoreParam_\`: \`string\`) => \`string\` | ... | +| \`valueY\` | (\`unionParam\`: \`"a"\` \\| \`"b"\`, \`_undercoreParam_\`: \`string\`) => \`string\` | - | ## Source diff --git a/packages/typedoc-plugin-markdown/test/specs/__snapshots__/urls.spec.ts.snap b/packages/typedoc-plugin-markdown/test/specs/__snapshots__/urls.spec.ts.snap index 0d0c0cf30..85072f844 100644 --- a/packages/typedoc-plugin-markdown/test/specs/__snapshots__/urls.spec.ts.snap +++ b/packages/typedoc-plugin-markdown/test/specs/__snapshots__/urls.spec.ts.snap @@ -471,6 +471,8 @@ exports[`Urls should gets Urls for multiple entry points: outputFileStrategy: me "has-categories/interfaces/CategoryAInterface2.md", "has-categories/interfaces/CategoryBInterface1.md", "has-categories/interfaces/CategoryBInterface2.md", + "has-categories/interfaces/CategoryCInterface1.md", + "has-categories/interfaces/CategoryCInterface2.md", "has-categories/interfaces/UnCategorizedInterace.md", "has-custom-groups/index.md", "has-custom-groups/variables/variabelA.md", @@ -532,6 +534,8 @@ exports[`Urls should gets Urls for multiple entry points: outputFileStrategy: me "has-categories/interfaces/CategoryAInterface2.md", "has-categories/interfaces/CategoryBInterface1.md", "has-categories/interfaces/CategoryBInterface2.md", + "has-categories/interfaces/CategoryCInterface1.md", + "has-categories/interfaces/CategoryCInterface2.md", "has-categories/interfaces/UnCategorizedInterace.md", "has-custom-groups/index.md", "has-namespaces/classes/ClassB.md", diff --git a/packages/typedoc-plugin-markdown/typedoc.html.json b/packages/typedoc-plugin-markdown/typedoc.html.json index 63bbe519b..7ac009595 100644 --- a/packages/typedoc-plugin-markdown/typedoc.html.json +++ b/packages/typedoc-plugin-markdown/typedoc.html.json @@ -17,7 +17,6 @@ "name": "API", "readme": "none", "sort": ["required-first", "source-order"], - "includeVersion": false, "categoryOrder": [ "Application", "Theme", diff --git a/packages/typedoc-plugin-markdown/typedoc.json b/packages/typedoc-plugin-markdown/typedoc.json index f443a7028..d65f33d1d 100644 --- a/packages/typedoc-plugin-markdown/typedoc.json +++ b/packages/typedoc-plugin-markdown/typedoc.json @@ -5,112 +5,5 @@ "./src/internationalization", "./src/theme", "./src/libs" - ], - - "sortEntryPoints": false, - "sort": ["source-order"], - "excludeReferences": true, - "plugin": [ - "typedoc-plugin-markdown", - "typedoc-plugin-remark", - "./.docs/plugins/typedoc-default-values.js" - ], - "remarkPlugins": [ - [ - "remark-toc", - { - "heading": "Table of Contents", - "tight": true, - "maxDepth": 2, - "skip": "Enumeration Members|Type declaration|Defined in|Parameters|Remarks|See|Returns" - } - ] - ], - "groupOrder": [ - "Functions", - "Namespaces", - "Enumerations", - "Classes", - "Interfaces", - "*" - ], - "hidePageHeader": true, - "readme": "DEVELOP.md", - "out": "./developer-docs", - "useCodeBlocks": true, - "indexFormat": "table", - "expandParameters": false, - "hideGroupHeadings": true, - "parametersFormat": "table", - "enumMembersFormat": "table", - "outputFileStrategy": "members", - "membersWithOwnFile": ["Class", "Interface", "TypeAlias", "Enum"], - "includeVersion": true, - "mergeReadme": true, - "categorizeByGroup": false, - "categoryOrder": [ - "Application", - "Theme", - "Options", - "Page Partials", - "Container Partials", - "Member Partials", - "Comment Partials", - "Type Partials", - "*" - ], - "projectDocuments": "./internal-docs/Adding-Options.md", - "excludeExternals": true, - "typeDeclarationFormat": "list", - "tableColumnSettings": { - "hideSources": true - }, - "externalSymbolLinkMappings": { - "typedoc": { - "ArrayType": "https://typedoc.org/api/types/Models.ArrayType.html", - "Application": "https://typedoc.org/api/classes/Application.html", - "Comment": "https://typedoc.org/api/types/Models.Comment.html", - "CommentDisplayPart": "https://typedoc.org/api/types/Models.CommentDisplayPart.html", - "ConditionalType": "https://typedoc.org/api/types/Models.ConditionalType.html", - "ContainerReflection": "https://typedoc.org/api/classes/Models.ContainerReflection.html", - "DeclarationHierarchy": "https://typedoc.org/api/classes/Models.DeclarationHierarchy.html", - "DeclarationReflection": "https://typedoc.org/api/classes/Models.DeclarationReflection.html", - "DefaultThemeRenderContext": "https://typedoc.org/api/classes/DefaultThemeRenderContext.html", - "Event": "https://typedoc.org/api/classes/Event.html", - "EventHooks": "https://typedoc.org/api/classes/EventHooks.html", - "IndexedAccessType": "https://typedoc.org/api/types/Models.IndexedAccessType.html", - "InferredType": "https://typedoc.org/api/types/Models.InferredType.html", - "IntersectionType": "https://typedoc.org/api/types/Models.IntersectionType.html", - "IntrinsicType": "https://typedoc.org/api/types/Models.IntrinsicType.html", - "LiteralType": "https://typedoc.org/api/types/Models.LiteralType.html", - "NamedTupleMember": "https://typedoc.org/api/types/Models.NamedTupleMember.html", - "ManuallyValidatedOption": "https://typedoc.org/api/types/Configuration.ManuallyValidatedOption.html", - "Options": "https://typedoc.org/api/classes/Configuration.Options.html", - "PageEvent": "https://typedoc.org/api/classes/PageEvent.html", - "ParameterReflection": "https://typedoc.org/api/classes/Models.ParameterReflection.html", - "ProjectReflection": "https://typedoc.org/api/classes/Models.ProjectReflection.html", - "ReferenceReflection": "https://typedoc.org/api/classes/Models.ReferenceReflection.html", - "ReferenceType": "https://typedoc.org/api/classes/Models.ReferenceType.html", - "Renderer": "https://typedoc.org/api/classes/Renderer.html", - "RendererEvent": "https://typedoc.org/api/classes/RendererEvent.html", - "RenderTemplate": "https://typedoc.org/api/types/RenderTemplate.html", - "Reflection": "https://typedoc.org/api/classes/Models.Reflection.html", - "ReflectionCategory": "https://typedoc.org/api/types/Models.ReflectionCategory.html", - "ReflectionFlags": "https://typedoc.org/api/classes/Models.ReflectionFlags.html", - "ReflectionGroup": "https://typedoc.org/api/classes/Models.ReflectionGroup.html", - "ReflectionKind": "https://typedoc.org/api/enums/Models.ReflectionKind-1.html", - "ReflectionType": "https://typedoc.org/api/classes/Models.ReflectionType.html", - "SignatureReflection": "https://typedoc.org/api/classes/Models.SignatureReflection.html", - "SomeType": "https://typedoc.org/api/classes/Models.SomeType.html", - "TypeParameterReflection": "https://typedoc.org/api/classes/Models.TypeParameterReflection.html", - "Theme": "https://typedoc.org/api/classes/Theme.html", - "TypeDocOptions": "https://typedoc.org/api/interfaces/TypeDocOptions.html", - "TypeOperatorType": "https://typedoc.org/api/interfaces/TypeOperatorType.html", - "TupleType": "https://typedoc.org/api/classes/Models.TupleType.html", - "QueryType": "https://typedoc.org/api/types/Models.QueryType.html", - "UnknownType": "https://typedoc.org/api/types/Models.UnknownType.html", - "UnionType": "https://typedoc.org/api/types/Models.UnionType.html", - "UrlMapping": "https://typedoc.org/api/classes/UrlMapping.html" - } - } + ] } diff --git a/packages/typedoc-plugin-remark/src/defs/typedoc.d.ts b/packages/typedoc-plugin-remark/src/_typedoc.d.ts similarity index 73% rename from packages/typedoc-plugin-remark/src/defs/typedoc.d.ts rename to packages/typedoc-plugin-remark/src/_typedoc.d.ts index b8886a02a..3c6bbdd86 100644 --- a/packages/typedoc-plugin-remark/src/defs/typedoc.d.ts +++ b/packages/typedoc-plugin-remark/src/_typedoc.d.ts @@ -1,7 +1,7 @@ // THIS FILE IS AUTO GENERATED FROM THE OPTIONS CONFIG. DO NOT EDIT DIRECTLY. import { ManuallyValidatedOption } from 'typedoc'; -import { RemarkPlugins } from '../options/option-types'; -import { RemarkStringifyOptions } from '../options/option-types'; +import { RemarkPlugins } from './options/types'; +import { RemarkStringifyOptions } from './options/types'; declare module 'typedoc' { export interface TypeDocOptionMap { remarkPlugins: ManuallyValidatedOption; diff --git a/packages/typedoc-plugin-remark/src/options/types.ts b/packages/typedoc-plugin-remark/src/options/types.ts new file mode 100644 index 000000000..86b528750 --- /dev/null +++ b/packages/typedoc-plugin-remark/src/options/types.ts @@ -0,0 +1,34 @@ +/** + * Describes the options declared by the plugin. + * + * @privateRemarks + * + * THIS FILE IS AUTO GENERATED FROM THE OPTIONS CONFIG. DO NOT EDIT DIRECTLY + * + * @module + */ +export interface PluginOptions { + /** + * An array of remark plugin names. + */ + remarkPlugins: RemarkPlugins; + + /** + * Custom options for the remark-stringify plugin. + */ + remarkStringifyOptions: RemarkStringifyOptions; +} + +/** + * + * + * @category Options + */ +export interface RemarkPlugins {} + +/** + * + * + * @category Options + */ +export interface RemarkStringifyOptions {} diff --git a/packages/typedoc-vitepress-theme/src/defs/typedoc.d.ts b/packages/typedoc-vitepress-theme/src/_typedoc.d.ts similarity index 84% rename from packages/typedoc-vitepress-theme/src/defs/typedoc.d.ts rename to packages/typedoc-vitepress-theme/src/_typedoc.d.ts index 0793a496e..245f640a4 100644 --- a/packages/typedoc-vitepress-theme/src/defs/typedoc.d.ts +++ b/packages/typedoc-vitepress-theme/src/_typedoc.d.ts @@ -1,6 +1,6 @@ // THIS FILE IS AUTO GENERATED FROM THE OPTIONS CONFIG. DO NOT EDIT DIRECTLY. import { ManuallyValidatedOption } from 'typedoc'; -import { Sidebar } from '../options/option-types'; +import { Sidebar } from './options/types'; declare module 'typedoc' { export interface TypeDocOptionMap { docsRoot: string; diff --git a/packages/typedoc-vitepress-theme/src/options/types.ts b/packages/typedoc-vitepress-theme/src/options/types.ts new file mode 100644 index 000000000..5049543e0 --- /dev/null +++ b/packages/typedoc-vitepress-theme/src/options/types.ts @@ -0,0 +1,32 @@ +/** + * Describes the options declared by the plugin. + * + * @privateRemarks + * + * THIS FILE IS AUTO GENERATED FROM THE OPTIONS CONFIG. DO NOT EDIT DIRECTLY + * + * @module + */ +export interface PluginOptions { + /** + * The path to the VitePress project root. + */ + docsRoot: string; + + /** + * Configures the autogenerated VitePress sidebar. + */ + sidebar: Sidebar; +} + +/** + * + * + * @category Options + */ +export interface Sidebar { + autoConfiguration: boolean; + format: string; + pretty: boolean; + collapsed: boolean; +} diff --git a/typedoc.base.json b/typedoc.base.json deleted file mode 100644 index 0967ef424..000000000 --- a/typedoc.base.json +++ /dev/null @@ -1 +0,0 @@ -{} diff --git a/typedoc.html.json b/typedoc.html.json deleted file mode 100644 index 78d719ac3..000000000 --- a/typedoc.html.json +++ /dev/null @@ -1,13 +0,0 @@ -{ - "$schema": "https://typedoc-plugin-markdown.org/schema.json", - "name": "packages-example", - "out": "./devdocs-html", - "json": "devdocs-json.json", - "readme": "none", - "entryPoints": [ - "./packages/typedoc-plugin-markdown", - "./packages/typedoc-plugin-frontmatter" - ], - "entryPointStrategy": "packages", - "projectDocuments": ["./TEST.md"] -} diff --git a/typedoc.json b/typedoc.json index d278656d9..ef5140469 100644 --- a/typedoc.json +++ b/typedoc.json @@ -1,42 +1,86 @@ { "$schema": "https://typedoc-plugin-markdown.org/schema.json", "name": "Developer Documentation", - "out": "./devdocs", - "readme": "none", + "out": "./developer-docs", "entryPoints": [ "./packages/typedoc-plugin-markdown", "./packages/typedoc-plugin-frontmatter" ], - "entryPointStrategy": "packages", "plugin": [ "./packages/typedoc-plugin-markdown/dist", - "typedoc-plugin-remark", - "./packages/typedoc-plugin-markdown/.docs/plugins/typedoc-default-values.js" + "./devtools/typedoc-plugins/typedoc.docs.mjs", + "./devtools/typedoc-plugins/typedoc-default-values.js" ], + "entryPointStrategy": "packages", + "readme": "none", + "excludePrivate": false, + "packageOptions": { + "includeVersion": true, + "excludePrivate": false, + "readme": "none", + "sortEntryPoints": false, + "sort": "source-order" + }, "indexFormat": "table", "outputFileStrategy": "members", - "excludePrivate": false, "textContentMappings": { - "breadcrumbs.home": "Home" + "breadcrumbs.home": "Packages Index" }, + "expandObjects": true, "hidePageHeader": true, - "packageOptions": { - "includeVersion": true, - "excludePrivate": false - }, - "projectDocuments": ["./CONTRIBUTING.md"], "mergeReadme": true, "membersWithOwnFile": ["Class", "Interface", "TypeAlias", "Enum"], - "remarkPlugins": [ - [ - "remark-toc", - { - "heading": "Table of Contents", - "tight": true, - "maxDepth": 2, - "skip": "Enumeration Members|Type declaration|Defined in|Parameters|Remarks|See|Returns" - } - ] - ], - "hideGroupHeadings": true + "parametersFormat": "table", + "enumMembersFormat": "table", + "typeDeclarationFormat": "table", + "tableColumnSettings": { "hideSources": true }, + "externalSymbolLinkMappings": { + "typedoc": { + "ArrayType": "https://typedoc.org/api/types/Models.ArrayType.html", + "Application": "https://typedoc.org/api/classes/Application.html", + "Comment": "https://typedoc.org/api/types/Models.Comment.html", + "CommentDisplayPart": "https://typedoc.org/api/types/Models.CommentDisplayPart.html", + "ConditionalType": "https://typedoc.org/api/types/Models.ConditionalType.html", + "ContainerReflection": "https://typedoc.org/api/classes/Models.ContainerReflection.html", + "DeclarationHierarchy": "https://typedoc.org/api/classes/Models.DeclarationHierarchy.html", + "DeclarationOption": "https://typedoc.org/api/classes/Models.DeclarationOption.html", + "DeclarationReflection": "https://typedoc.org/api/classes/Models.DeclarationReflection.html", + "DefaultThemeRenderContext": "https://typedoc.org/api/classes/DefaultThemeRenderContext.html", + "Event": "https://typedoc.org/api/classes/Event.html", + "EventHooks": "https://typedoc.org/api/classes/EventHooks.html", + "IndexedAccessType": "https://typedoc.org/api/types/Models.IndexedAccessType.html", + "InferredType": "https://typedoc.org/api/types/Models.InferredType.html", + "IntersectionType": "https://typedoc.org/api/types/Models.IntersectionType.html", + "IntrinsicType": "https://typedoc.org/api/types/Models.IntrinsicType.html", + "LiteralType": "https://typedoc.org/api/types/Models.LiteralType.html", + "NamedTupleMember": "https://typedoc.org/api/types/Models.NamedTupleMember.html", + "ManuallyValidatedOption": "https://typedoc.org/api/types/Configuration.ManuallyValidatedOption.html", + "Options": "https://typedoc.org/api/classes/Configuration.Options.html", + "PageEvent": "https://typedoc.org/api/classes/PageEvent.html", + "ParameterReflection": "https://typedoc.org/api/classes/Models.ParameterReflection.html", + "ProjectReflection": "https://typedoc.org/api/classes/Models.ProjectReflection.html", + "ReferenceReflection": "https://typedoc.org/api/classes/Models.ReferenceReflection.html", + "ReferenceType": "https://typedoc.org/api/classes/Models.ReferenceType.html", + "Renderer": "https://typedoc.org/api/classes/Renderer.html", + "RendererEvent": "https://typedoc.org/api/classes/RendererEvent.html", + "RenderTemplate": "https://typedoc.org/api/types/RenderTemplate.html", + "Reflection": "https://typedoc.org/api/classes/Models.Reflection.html", + "ReflectionCategory": "https://typedoc.org/api/types/Models.ReflectionCategory.html", + "ReflectionFlags": "https://typedoc.org/api/classes/Models.ReflectionFlags.html", + "ReflectionGroup": "https://typedoc.org/api/classes/Models.ReflectionGroup.html", + "ReflectionKind": "https://typedoc.org/api/enums/Models.ReflectionKind-1.html", + "ReflectionType": "https://typedoc.org/api/classes/Models.ReflectionType.html", + "SignatureReflection": "https://typedoc.org/api/classes/Models.SignatureReflection.html", + "SomeType": "https://typedoc.org/api/classes/Models.SomeType.html", + "TypeParameterReflection": "https://typedoc.org/api/classes/Models.TypeParameterReflection.html", + "Theme": "https://typedoc.org/api/classes/Theme.html", + "TypeDocOptions": "https://typedoc.org/api/interfaces/TypeDocOptions.html", + "TypeOperatorType": "https://typedoc.org/api/interfaces/TypeOperatorType.html", + "TupleType": "https://typedoc.org/api/classes/Models.TupleType.html", + "QueryType": "https://typedoc.org/api/types/Models.QueryType.html", + "UnknownType": "https://typedoc.org/api/types/Models.UnknownType.html", + "UnionType": "https://typedoc.org/api/types/Models.UnionType.html", + "UrlMapping": "https://typedoc.org/api/classes/UrlMapping.html" + } + } }