diff --git a/devguide/README.md b/devguide/README.md index 21d363f3d..d5c253a86 100644 --- a/devguide/README.md +++ b/devguide/README.md @@ -1,67 +1,19 @@ # Developer Guide -## Contents +## Documents -* [Monorepo Overview](#monorepo-overview) -* [Machine Setup](#machine-setup) - -## Monorepo Overview - -This is a simple monorepo managed by [npm workspaces](https://docs.npmjs.com/cli/v7/using-npm/workspaces). - -Please view individual packages for further insights: - -* [typedoc-plugin-markdown](typedoc-plugin-markdown/README.md) is the core package and is the package that is used to generate the markdown documentation. -* [typedoc-plugin-frontmatter](typedoc-plugin-frontmatter/README.md) and [typedoc-plugin-remark](typedoc-plugin-remark/README.md) provide metadata or adjust the output. -* [typedoc-github-wiki-theme](typedoc-github-wiki-theme/README.md), [typedoc-gitlab-wiki-theme](typedoc-gitlab-wiki-theme/README.md), - [typedoc-vitepress-theme](typedoc-vitepress-theme/README.md) and [docusaurus-plugin-typedoc](docusaurus-plugin-typedoc/README.md) target specific implementations. - -## Machine Setup - -**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. +| Document | Description | +| ------ | ------ | +| [Getting Started](documents/Getting-Started.md) | How to start developing locally. | ## Packages -| Name | Description | -| ------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | -| [docusaurus-plugin-typedoc](docusaurus-plugin-typedoc/README.md) | A Docusaurus plugin to integrate TypeDoc ( + typedoc-plugin-markdown ) into a Docusaurus project. | -| [typedoc-github-wiki-theme](typedoc-github-wiki-theme/README.md) | A TypeDoc ( + typedoc-plugin-markdown ) theme that generates Markdown compatible with Github Wiki. | -| [typedoc-gitlab-wiki-theme](typedoc-gitlab-wiki-theme/README.md) | A TypeDoc ( + typedoc-plugin-markdown ) theme that generates Markdown compatible with Gitlab Wiki. | -| [typedoc-plugin-frontmatter](typedoc-plugin-frontmatter/README.md) | A plugin for TypeDoc ( + typedoc-plugin-markdown ) that prepends configurable frontmatter to page content. | -| [typedoc-plugin-markdown](typedoc-plugin-markdown/README.md) | A plugin for TypeDoc that enables TypeScript API documentation to be generated in Markdown. | -| [typedoc-plugin-remark](typedoc-plugin-remark/README.md) | A plugin for TypeDoc ( + typedoc-plugin-markdown ) that enables additional markdown transformations with remark plugins. | -| [typedoc-vitepress-theme](typedoc-vitepress-theme/README.md) | A TypeDoc ( + typedoc-plugin-markdown ) theme that generates Markdown compatible with VitePress. | +| Package | Description | +| ------ | ------ | +| [typedoc-plugin-markdown](typedoc-plugin-markdown/README.md) | A plugin for TypeDoc that enables TypeScript API documentation to be generated in Markdown. | +| [typedoc-plugin-frontmatter](typedoc-plugin-frontmatter/README.md) | A plugin for TypeDoc ( + typedoc-plugin-markdown ) that prepends configurable frontmatter to page content. | +| [typedoc-plugin-remark](typedoc-plugin-remark/README.md) | A plugin for TypeDoc ( + typedoc-plugin-markdown ) that enables additional markdown transformations with remark plugins. | +| [typedoc-github-wiki-theme](typedoc-github-wiki-theme/README.md) | A TypeDoc ( + typedoc-plugin-markdown ) theme that generates Markdown compatible with Github Wiki. | +| [typedoc-gitlab-wiki-theme](typedoc-gitlab-wiki-theme/README.md) | A TypeDoc ( + typedoc-plugin-markdown ) theme that generates Markdown compatible with Gitlab Wiki. | +| [typedoc-vitepress-theme](typedoc-vitepress-theme/README.md) | A TypeDoc ( + typedoc-plugin-markdown ) theme that generates Markdown compatible with VitePress. | +| [docusaurus-plugin-typedoc](docusaurus-plugin-typedoc/README.md) | A Docusaurus plugin to integrate TypeDoc ( + typedoc-plugin-markdown ) into a Docusaurus project. | diff --git a/devguide/documents/Getting-Started.md b/devguide/documents/Getting-Started.md new file mode 100644 index 000000000..ddd36b57b --- /dev/null +++ b/devguide/documents/Getting-Started.md @@ -0,0 +1,53 @@ +[Developer Guide](../README.md) / Getting Started + +# Getting Started + +## 1. Machine Setup + +**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 +``` + +## 2. Contributing to packages + +If the project builds and the tests run successfully you are ready to start contributing to the project. + +This is a simple monorepo managed by [npm workspaces](https://docs.npmjs.com/cli/v7/using-npm/workspaces). + +[typedoc-plugin-markdown](../typedoc-plugin-markdown/README.md) is the core package and is the package that is used to generate the Markdown documentation. + +Child packages all depend on the core package and provide further functionality: + +- [typedoc-plugin-frontmatter](../typedoc-plugin-frontmatter/README.md) and [typedoc-plugin-remark](../typedoc-plugin-remark/README.md) provide metadata or adjust the output. +- [typedoc-github-wiki-theme](../typedoc-github-wiki-theme/README.md), [typedoc-gitlab-wiki-theme](../typedoc-gitlab-wiki-theme/README.md), + [typedoc-vitepress-theme](../typedoc-vitepress-theme/README.md) and [docusaurus-plugin-typedoc](../docusaurus-plugin-typedoc/README.md) target specific implementations. diff --git a/devguide/docusaurus-plugin-typedoc/README.md b/devguide/docusaurus-plugin-typedoc/README.md index c715f03e2..e2df2fc01 100644 --- a/devguide/docusaurus-plugin-typedoc/README.md +++ b/devguide/docusaurus-plugin-typedoc/README.md @@ -4,20 +4,16 @@ "docusaurus-plugin-typedoc" is a Docusaurus plugin that bootstraps TypeDoc within the Docusaurus eco-system. -## Contents +Package features include: -* [What Does the Package Do?](#what-does-the-package-do) - -## What Does the Package Do? - -* Presets relevant options of typedoc-plugin-markdown. -* Bootstraps TypeDoc from the Docusaurus CLI. -* Generates a sidebar file with configurable structure. +- Presets relevant options of typedoc-plugin-markdown. +- Bootstraps TypeDoc from the Docusaurus CLI. +- Generates a sidebar file with configurable structure. ## Modules -| Module | Description | -| ---------------------------- | ----------------------------------------------- | -| [index](index/README.md) | - | +| Module | Description | +| ------ | ------ | +| [core](core/README.md) | - | | [options](options/README.md) | All plugin types are exported from this module. | -| [types](types/README.md) | All plugin types are exported from this module. | +| [types](types/README.md) | All plugin types are exported from this module. | diff --git a/devguide/docusaurus-plugin-typedoc/core/README.md b/devguide/docusaurus-plugin-typedoc/core/README.md new file mode 100644 index 000000000..27c2cd301 --- /dev/null +++ b/devguide/docusaurus-plugin-typedoc/core/README.md @@ -0,0 +1,28 @@ +[Developer Guide](../../README.md) / [docusaurus-plugin-typedoc](../README.md) / core + +# core + +## Interfaces + +| Interface | Description | +| ------ | ------ | +| [PluginOptions](interfaces/PluginOptions.md) | Describes the options declared by the plugin. | + +## Functions + +### default() + +> **default**(`context`, `opts`): `Promise`\<\{ `name`: `string`; `extendCli`: `void`; \}\> + +**Defined in**: [docusaurus-plugin-typedoc/src/plugins/docusaurus.ts:8](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/docusaurus-plugin-typedoc/src/plugins/docusaurus.ts#L8) + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `context` | `any` | +| `opts` | `Partial`\<[`PluginOptions`](interfaces/PluginOptions.md)\> | + +#### Returns + +`Promise`\<\{ `name`: `string`; `extendCli`: `void`; \}\> diff --git a/devguide/docusaurus-plugin-typedoc/index/interfaces/PluginOptions.md b/devguide/docusaurus-plugin-typedoc/core/interfaces/PluginOptions.md similarity index 66% rename from devguide/docusaurus-plugin-typedoc/index/interfaces/PluginOptions.md rename to devguide/docusaurus-plugin-typedoc/core/interfaces/PluginOptions.md index 737a9e520..650ba0348 100644 --- a/devguide/docusaurus-plugin-typedoc/index/interfaces/PluginOptions.md +++ b/devguide/docusaurus-plugin-typedoc/core/interfaces/PluginOptions.md @@ -1,73 +1,14 @@ -[Developer Guide](../../../README.md) / [docusaurus-plugin-typedoc](../../README.md) / [index](../README.md) / PluginOptions +[Developer Guide](../../../README.md) / [docusaurus-plugin-typedoc](../../README.md) / [core](../README.md) / PluginOptions # Interface: PluginOptions -Describes the options declared by the plugin. +**Defined in**: [docusaurus-plugin-typedoc/src/models.ts:4](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/docusaurus-plugin-typedoc/src/models.ts#L4) -## Contents - -* [Extends](#extends) -* [Properties](#properties) - * [id](#id) - * [out](#out) - * [docusaurusConfigOptions](#docusaurusconfigoptions) - * [sidebar](#sidebar) - * [anchorPrefix](#anchorprefix) - * [blockTagsPreserveOrder](#blocktagspreserveorder) - * [classPropertiesFormat](#classpropertiesformat) - * [entryFileName](#entryfilename) - * [entryModule](#entrymodule) - * [enumMembersFormat](#enummembersformat) - * [~~excludeGroups~~](#excludegroups) - * [excludeScopesInPaths](#excludescopesinpaths) - * [expandObjects](#expandobjects) - * [expandParameters](#expandparameters) - * [fileExtension](#fileextension) - * [flattenOutputFiles](#flattenoutputfiles) - * [formatWithPrettier](#formatwithprettier) - * [hideBreadcrumbs](#hidebreadcrumbs) - * [hideGroupHeadings](#hidegroupheadings) - * [hidePageHeader](#hidepageheader) - * [hidePageTitle](#hidepagetitle) - * [indexFormat](#indexformat) - * [interfacePropertiesFormat](#interfacepropertiesformat) - * [membersWithOwnFile](#memberswithownfile) - * [mergeReadme](#mergereadme) - * [modulesFileName](#modulesfilename) - * [~~navigationModel~~](#navigationmodel) - * [~~excludeGroups~~](#excludegroups-1) - * [~~excludeCategories~~](#excludecategories) - * [~~excludeFolders~~](#excludefolders) - * [outputFileStrategy](#outputfilestrategy) - * [pageTitleTemplates](#pagetitletemplates) - * [index](#index) - * [member](#member) - * [module](#module) - * [parametersFormat](#parametersformat) - * [preserveAnchorCasing](#preserveanchorcasing) - * [prettierConfigFile](#prettierconfigfile) - * [propertiesFormat](#propertiesformat) - * [propertyMembersFormat](#propertymembersformat) - * [publicPath](#publicpath) - * [sanitizeComments](#sanitizecomments) - * [tableColumnSettings](#tablecolumnsettings) - * [hideDefaults](#hidedefaults) - * [hideInherited](#hideinherited) - * [hideModifiers](#hidemodifiers) - * [hideOverrides](#hideoverrides) - * [hideSources](#hidesources) - * [hideValues](#hidevalues) - * [leftAlignHeaders](#leftalignheaders) - * [textContentMappings](#textcontentmappings) - * [typeDeclarationFormat](#typedeclarationformat) - * [typeDeclarationVisibility](#typedeclarationvisibility) - * [useCodeBlocks](#usecodeblocks) - * [useHTMLAnchors](#usehtmlanchors) - * [useHTMLEncodedBrackets](#usehtmlencodedbrackets) +Describes the options declared by the plugin. ## Extends -* [`PluginOptions`](../../../typedoc-plugin-markdown/types/interfaces/PluginOptions.md).[`PluginOptions`](../../types/interfaces/PluginOptions.md) +- [`PluginOptions`](../../../typedoc-plugin-markdown/types/interfaces/PluginOptions.md).[`PluginOptions`](../../types/interfaces/PluginOptions.md) ## Properties @@ -75,9 +16,7 @@ Describes the options declared by the plugin. > **id**: `string` -#### Defined in - -[docusaurus-plugin-typedoc/src/models.ts:7](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/docusaurus-plugin-typedoc/src/models.ts#L7) +**Defined in**: [docusaurus-plugin-typedoc/src/models.ts:7](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/docusaurus-plugin-typedoc/src/models.ts#L7) *** @@ -85,9 +24,7 @@ Describes the options declared by the plugin. > **out**: `string` -#### Defined in - -[docusaurus-plugin-typedoc/src/models.ts:8](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/docusaurus-plugin-typedoc/src/models.ts#L8) +**Defined in**: [docusaurus-plugin-typedoc/src/models.ts:8](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/docusaurus-plugin-typedoc/src/models.ts#L8) *** @@ -95,53 +32,49 @@ Describes the options declared by the plugin. > **docusaurusConfigOptions**: `string` +**Defined in**: [docusaurus-plugin-typedoc/src/types/options.ts:11](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/docusaurus-plugin-typedoc/src/types/options.ts#L11) + docusaurus.config options - should not be used if running as a docusaurus plugin. #### Inherited from [`PluginOptions`](../../types/interfaces/PluginOptions.md).[`docusaurusConfigOptions`](../../types/interfaces/PluginOptions.md#docusaurusconfigoptions) -#### Defined in - -[docusaurus-plugin-typedoc/src/types/options.ts:11](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/docusaurus-plugin-typedoc/src/types/options.ts#L11) - *** ### sidebar > **sidebar**: [`Sidebar`](../../types/interfaces/Sidebar.md) +**Defined in**: [docusaurus-plugin-typedoc/src/types/options.ts:16](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/docusaurus-plugin-typedoc/src/types/options.ts#L16) + Configures the autogenerated Docusaurus sidebar. #### Inherited from [`PluginOptions`](../../types/interfaces/PluginOptions.md).[`sidebar`](../../types/interfaces/PluginOptions.md#sidebar) -#### Defined in - -[docusaurus-plugin-typedoc/src/types/options.ts:16](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/docusaurus-plugin-typedoc/src/types/options.ts#L16) - *** ### anchorPrefix > **anchorPrefix**: `string` +**Defined in**: typedoc-plugin-markdown/dist/types/options.d.ts:8 + Custom anchor prefix when anchoring to in-page symbols. #### Inherited from [`PluginOptions`](../../../typedoc-plugin-markdown/types/interfaces/PluginOptions.md).[`anchorPrefix`](../../../typedoc-plugin-markdown/types/interfaces/PluginOptions.md#anchorprefix) -#### Defined in - -typedoc-plugin-markdown/dist/types/options.d.ts:8 - *** ### blockTagsPreserveOrder -> **blockTagsPreserveOrder**: `string`\[] +> **blockTagsPreserveOrder**: `string`[] + +**Defined in**: typedoc-plugin-markdown/dist/types/options.d.ts:12 Specifies comment block tags that should preserve their position. @@ -149,15 +82,13 @@ Specifies comment block tags that should preserve their position. [`PluginOptions`](../../../typedoc-plugin-markdown/types/interfaces/PluginOptions.md).[`blockTagsPreserveOrder`](../../../typedoc-plugin-markdown/types/interfaces/PluginOptions.md#blocktagspreserveorder) -#### Defined in - -typedoc-plugin-markdown/dist/types/options.d.ts:12 - *** ### classPropertiesFormat -> **classPropertiesFormat**: `"table"` | `"list"` | `"htmlTable"` +> **classPropertiesFormat**: `"table"` \| `"list"` \| `"htmlTable"` + +**Defined in**: typedoc-plugin-markdown/dist/types/options.d.ts:16 Sets the format of property groups for classes. @@ -165,47 +96,41 @@ Sets the format of property groups for classes. [`PluginOptions`](../../../typedoc-plugin-markdown/types/interfaces/PluginOptions.md).[`classPropertiesFormat`](../../../typedoc-plugin-markdown/types/interfaces/PluginOptions.md#classpropertiesformat) -#### Defined in - -typedoc-plugin-markdown/dist/types/options.d.ts:16 - *** ### entryFileName > **entryFileName**: `string` +**Defined in**: typedoc-plugin-markdown/dist/types/options.d.ts:20 + The file name of the entry page. #### Inherited from [`PluginOptions`](../../../typedoc-plugin-markdown/types/interfaces/PluginOptions.md).[`entryFileName`](../../../typedoc-plugin-markdown/types/interfaces/PluginOptions.md#entryfilename) -#### Defined in - -typedoc-plugin-markdown/dist/types/options.d.ts:20 - *** ### entryModule > **entryModule**: `string` +**Defined in**: typedoc-plugin-markdown/dist/types/options.d.ts:24 + The name of a module that should act as the root page for the documentation. #### Inherited from [`PluginOptions`](../../../typedoc-plugin-markdown/types/interfaces/PluginOptions.md).[`entryModule`](../../../typedoc-plugin-markdown/types/interfaces/PluginOptions.md#entrymodule) -#### Defined in - -typedoc-plugin-markdown/dist/types/options.d.ts:24 - *** ### enumMembersFormat -> **enumMembersFormat**: `"table"` | `"list"` | `"htmlTable"` +> **enumMembersFormat**: `"table"` \| `"list"` \| `"htmlTable"` + +**Defined in**: typedoc-plugin-markdown/dist/types/options.d.ts:28 Sets the format of enumeration members. @@ -213,16 +138,14 @@ Sets the format of enumeration members. [`PluginOptions`](../../../typedoc-plugin-markdown/types/interfaces/PluginOptions.md).[`enumMembersFormat`](../../../typedoc-plugin-markdown/types/interfaces/PluginOptions.md#enummembersformat) -#### Defined in - -typedoc-plugin-markdown/dist/types/options.d.ts:28 - *** ### ~~excludeGroups~~ > **excludeGroups**: `boolean` +**Defined in**: typedoc-plugin-markdown/dist/types/options.d.ts:32 + #### Deprecated This option has been renamed hideGroupHeadings to better reflect its purpose. @@ -231,175 +154,153 @@ This option has been renamed hideGroupHeadings to better reflect its purpose. [`PluginOptions`](../../../typedoc-plugin-markdown/types/interfaces/PluginOptions.md).[`excludeGroups`](../../../typedoc-plugin-markdown/types/interfaces/PluginOptions.md#excludegroups) -#### Defined in - -typedoc-plugin-markdown/dist/types/options.d.ts:32 - *** ### excludeScopesInPaths > **excludeScopesInPaths**: `boolean` +**Defined in**: typedoc-plugin-markdown/dist/types/options.d.ts:36 + Exclude writing @ scope directories in paths. #### Inherited from [`PluginOptions`](../../../typedoc-plugin-markdown/types/interfaces/PluginOptions.md).[`excludeScopesInPaths`](../../../typedoc-plugin-markdown/types/interfaces/PluginOptions.md#excludescopesinpaths) -#### Defined in - -typedoc-plugin-markdown/dist/types/options.d.ts:36 - *** ### expandObjects > **expandObjects**: `boolean` +**Defined in**: typedoc-plugin-markdown/dist/types/options.d.ts:40 + Expand objects inside declarations. #### Inherited from [`PluginOptions`](../../../typedoc-plugin-markdown/types/interfaces/PluginOptions.md).[`expandObjects`](../../../typedoc-plugin-markdown/types/interfaces/PluginOptions.md#expandobjects) -#### Defined in - -typedoc-plugin-markdown/dist/types/options.d.ts:40 - *** ### expandParameters > **expandParameters**: `boolean` +**Defined in**: typedoc-plugin-markdown/dist/types/options.d.ts:44 + Expand parameters in signature parentheses to display type information. #### Inherited from [`PluginOptions`](../../../typedoc-plugin-markdown/types/interfaces/PluginOptions.md).[`expandParameters`](../../../typedoc-plugin-markdown/types/interfaces/PluginOptions.md#expandparameters) -#### Defined in - -typedoc-plugin-markdown/dist/types/options.d.ts:44 - *** ### fileExtension > **fileExtension**: `string` +**Defined in**: typedoc-plugin-markdown/dist/types/options.d.ts:48 + Specify the file extension for generated output files. #### Inherited from [`PluginOptions`](../../../typedoc-plugin-markdown/types/interfaces/PluginOptions.md).[`fileExtension`](../../../typedoc-plugin-markdown/types/interfaces/PluginOptions.md#fileextension) -#### Defined in - -typedoc-plugin-markdown/dist/types/options.d.ts:48 - *** ### flattenOutputFiles > **flattenOutputFiles**: `boolean` +**Defined in**: typedoc-plugin-markdown/dist/types/options.d.ts:52 + Flatten output files to a single directory. #### Inherited from [`PluginOptions`](../../../typedoc-plugin-markdown/types/interfaces/PluginOptions.md).[`flattenOutputFiles`](../../../typedoc-plugin-markdown/types/interfaces/PluginOptions.md#flattenoutputfiles) -#### Defined in - -typedoc-plugin-markdown/dist/types/options.d.ts:52 - *** ### formatWithPrettier > **formatWithPrettier**: `boolean` +**Defined in**: typedoc-plugin-markdown/dist/types/options.d.ts:56 + Apply additional output formatting with Prettier. #### Inherited from [`PluginOptions`](../../../typedoc-plugin-markdown/types/interfaces/PluginOptions.md).[`formatWithPrettier`](../../../typedoc-plugin-markdown/types/interfaces/PluginOptions.md#formatwithprettier) -#### Defined in - -typedoc-plugin-markdown/dist/types/options.d.ts:56 - *** ### hideBreadcrumbs > **hideBreadcrumbs**: `boolean` +**Defined in**: typedoc-plugin-markdown/dist/types/options.d.ts:60 + Do not print breadcrumbs. #### Inherited from [`PluginOptions`](../../../typedoc-plugin-markdown/types/interfaces/PluginOptions.md).[`hideBreadcrumbs`](../../../typedoc-plugin-markdown/types/interfaces/PluginOptions.md#hidebreadcrumbs) -#### Defined in - -typedoc-plugin-markdown/dist/types/options.d.ts:60 - *** ### hideGroupHeadings > **hideGroupHeadings**: `boolean` +**Defined in**: typedoc-plugin-markdown/dist/types/options.d.ts:64 + Excludes grouping by kind so all members are rendered at the same level. #### Inherited from [`PluginOptions`](../../../typedoc-plugin-markdown/types/interfaces/PluginOptions.md).[`hideGroupHeadings`](../../../typedoc-plugin-markdown/types/interfaces/PluginOptions.md#hidegroupheadings) -#### Defined in - -typedoc-plugin-markdown/dist/types/options.d.ts:64 - *** ### hidePageHeader > **hidePageHeader**: `boolean` +**Defined in**: typedoc-plugin-markdown/dist/types/options.d.ts:68 + Do not print page header. #### Inherited from [`PluginOptions`](../../../typedoc-plugin-markdown/types/interfaces/PluginOptions.md).[`hidePageHeader`](../../../typedoc-plugin-markdown/types/interfaces/PluginOptions.md#hidepageheader) -#### Defined in - -typedoc-plugin-markdown/dist/types/options.d.ts:68 - *** ### hidePageTitle > **hidePageTitle**: `boolean` +**Defined in**: typedoc-plugin-markdown/dist/types/options.d.ts:72 + Do not print page title. #### Inherited from [`PluginOptions`](../../../typedoc-plugin-markdown/types/interfaces/PluginOptions.md).[`hidePageTitle`](../../../typedoc-plugin-markdown/types/interfaces/PluginOptions.md#hidepagetitle) -#### Defined in - -typedoc-plugin-markdown/dist/types/options.d.ts:72 - *** ### indexFormat -> **indexFormat**: `"table"` | `"list"` | `"htmlTable"` +> **indexFormat**: `"table"` \| `"list"` \| `"htmlTable"` + +**Defined in**: typedoc-plugin-markdown/dist/types/options.d.ts:76 Sets the format of index items. @@ -407,15 +308,13 @@ Sets the format of index items. [`PluginOptions`](../../../typedoc-plugin-markdown/types/interfaces/PluginOptions.md).[`indexFormat`](../../../typedoc-plugin-markdown/types/interfaces/PluginOptions.md#indexformat) -#### Defined in - -typedoc-plugin-markdown/dist/types/options.d.ts:76 - *** ### interfacePropertiesFormat -> **interfacePropertiesFormat**: `"table"` | `"list"` | `"htmlTable"` +> **interfacePropertiesFormat**: `"table"` \| `"list"` \| `"htmlTable"` + +**Defined in**: typedoc-plugin-markdown/dist/types/options.d.ts:80 Sets the format of property groups for interfaces. @@ -423,15 +322,13 @@ Sets the format of property groups for interfaces. [`PluginOptions`](../../../typedoc-plugin-markdown/types/interfaces/PluginOptions.md).[`interfacePropertiesFormat`](../../../typedoc-plugin-markdown/types/interfaces/PluginOptions.md#interfacepropertiesformat) -#### Defined in - -typedoc-plugin-markdown/dist/types/options.d.ts:80 - *** ### membersWithOwnFile -> **membersWithOwnFile**: (`"Enum"` | `"Variable"` | `"Function"` | `"Class"` | `"Interface"` | `"TypeAlias"`)\[] +> **membersWithOwnFile**: (`"Enum"` \| `"Variable"` \| `"Function"` \| `"Class"` \| `"Interface"` \| `"TypeAlias"`)[] + +**Defined in**: typedoc-plugin-markdown/dist/types/options.d.ts:84 Determines which members are exported to their own file. @@ -439,48 +336,42 @@ Determines which members are exported to their own file. [`PluginOptions`](../../../typedoc-plugin-markdown/types/interfaces/PluginOptions.md).[`membersWithOwnFile`](../../../typedoc-plugin-markdown/types/interfaces/PluginOptions.md#memberswithownfile) -#### Defined in - -typedoc-plugin-markdown/dist/types/options.d.ts:84 - *** ### mergeReadme > **mergeReadme**: `boolean` +**Defined in**: typedoc-plugin-markdown/dist/types/options.d.ts:88 + Appends the documentation index page to the readme page. #### Inherited from [`PluginOptions`](../../../typedoc-plugin-markdown/types/interfaces/PluginOptions.md).[`mergeReadme`](../../../typedoc-plugin-markdown/types/interfaces/PluginOptions.md#mergereadme) -#### Defined in - -typedoc-plugin-markdown/dist/types/options.d.ts:88 - *** ### modulesFileName > **modulesFileName**: `string` +**Defined in**: typedoc-plugin-markdown/dist/types/options.d.ts:92 + The file name of the separate modules / index page. #### Inherited from [`PluginOptions`](../../../typedoc-plugin-markdown/types/interfaces/PluginOptions.md).[`modulesFileName`](../../../typedoc-plugin-markdown/types/interfaces/PluginOptions.md#modulesfilename) -#### Defined in - -typedoc-plugin-markdown/dist/types/options.d.ts:92 - *** ### ~~navigationModel~~ > **navigationModel**: `object` +**Defined in**: typedoc-plugin-markdown/dist/types/options.d.ts:96 + #### ~~excludeGroups~~ > **excludeGroups**: `boolean` @@ -501,15 +392,13 @@ This option has been deprecated in favour of TypeDoc `navigation` option. [`PluginOptions`](../../../typedoc-plugin-markdown/types/interfaces/PluginOptions.md).[`navigationModel`](../../../typedoc-plugin-markdown/types/interfaces/PluginOptions.md#navigationmodel) -#### Defined in - -typedoc-plugin-markdown/dist/types/options.d.ts:96 - *** ### outputFileStrategy -> **outputFileStrategy**: `"members"` | `"modules"` +> **outputFileStrategy**: `"members"` \| `"modules"` + +**Defined in**: typedoc-plugin-markdown/dist/types/options.d.ts:104 Determines how output files are generated. @@ -517,43 +406,39 @@ Determines how output files are generated. [`PluginOptions`](../../../typedoc-plugin-markdown/types/interfaces/PluginOptions.md).[`outputFileStrategy`](../../../typedoc-plugin-markdown/types/interfaces/PluginOptions.md#outputfilestrategy) -#### Defined in - -typedoc-plugin-markdown/dist/types/options.d.ts:104 - *** ### pageTitleTemplates > **pageTitleTemplates**: `object` +**Defined in**: typedoc-plugin-markdown/dist/types/options.d.ts:108 + Change specific text placeholders in the template. #### index -> **index**: `string` | (`name`) => `string` +> **index**: `string` \| (`name`) => `string` #### member -> **member**: `string` | (`name`) => `string` +> **member**: `string` \| (`name`) => `string` #### module -> **module**: `string` | (`name`) => `string` +> **module**: `string` \| (`name`) => `string` #### Inherited from [`PluginOptions`](../../../typedoc-plugin-markdown/types/interfaces/PluginOptions.md).[`pageTitleTemplates`](../../../typedoc-plugin-markdown/types/interfaces/PluginOptions.md#pagetitletemplates) -#### Defined in - -typedoc-plugin-markdown/dist/types/options.d.ts:108 - *** ### parametersFormat -> **parametersFormat**: `"table"` | `"list"` | `"htmlTable"` +> **parametersFormat**: `"table"` \| `"list"` \| `"htmlTable"` + +**Defined in**: typedoc-plugin-markdown/dist/types/options.d.ts:126 Sets the format of parameter and type parameter groups. @@ -561,63 +446,57 @@ Sets the format of parameter and type parameter groups. [`PluginOptions`](../../../typedoc-plugin-markdown/types/interfaces/PluginOptions.md).[`parametersFormat`](../../../typedoc-plugin-markdown/types/interfaces/PluginOptions.md#parametersformat) -#### Defined in - -typedoc-plugin-markdown/dist/types/options.d.ts:126 - *** ### preserveAnchorCasing > **preserveAnchorCasing**: `boolean` +**Defined in**: typedoc-plugin-markdown/dist/types/options.d.ts:130 + Preserve anchor casing when generating link to symbols. #### Inherited from [`PluginOptions`](../../../typedoc-plugin-markdown/types/interfaces/PluginOptions.md).[`preserveAnchorCasing`](../../../typedoc-plugin-markdown/types/interfaces/PluginOptions.md#preserveanchorcasing) -#### Defined in - -typedoc-plugin-markdown/dist/types/options.d.ts:130 - *** ### prettierConfigFile > **prettierConfigFile**: `string` +**Defined in**: typedoc-plugin-markdown/dist/types/options.d.ts:134 + Specify a custom Prettier configuration file location. #### Inherited from [`PluginOptions`](../../../typedoc-plugin-markdown/types/interfaces/PluginOptions.md).[`prettierConfigFile`](../../../typedoc-plugin-markdown/types/interfaces/PluginOptions.md#prettierconfigfile) -#### Defined in +*** -typedoc-plugin-markdown/dist/types/options.d.ts:134 +### ~~propertiesFormat~~ -*** +> **propertiesFormat**: `"table"` \| `"list"` \| `"htmlTable"` -### propertiesFormat +**Defined in**: typedoc-plugin-markdown/dist/types/options.d.ts:138 -> **propertiesFormat**: `"table"` | `"list"` | `"htmlTable"` +#### Deprecated -Sets the format of property groups for interfaces and classes. +This option has been deprecated in favour of `--interfacePropertiesFormat` and `--classPropertiesFormat`. #### Inherited from [`PluginOptions`](../../../typedoc-plugin-markdown/types/interfaces/PluginOptions.md).[`propertiesFormat`](../../../typedoc-plugin-markdown/types/interfaces/PluginOptions.md#propertiesformat) -#### Defined in - -typedoc-plugin-markdown/dist/types/options.d.ts:138 - *** ### propertyMembersFormat -> **propertyMembersFormat**: `"table"` | `"list"` | `"htmlTable"` +> **propertyMembersFormat**: `"table"` \| `"list"` \| `"htmlTable"` + +**Defined in**: typedoc-plugin-markdown/dist/types/options.d.ts:142 Sets the format of style for property members for interfaces and classes. @@ -625,48 +504,42 @@ Sets the format of style for property members for interfaces and classes. [`PluginOptions`](../../../typedoc-plugin-markdown/types/interfaces/PluginOptions.md).[`propertyMembersFormat`](../../../typedoc-plugin-markdown/types/interfaces/PluginOptions.md#propertymembersformat) -#### Defined in - -typedoc-plugin-markdown/dist/types/options.d.ts:142 - *** ### publicPath > **publicPath**: `string` +**Defined in**: typedoc-plugin-markdown/dist/types/options.d.ts:146 + Specify the base path for all urls. #### Inherited from [`PluginOptions`](../../../typedoc-plugin-markdown/types/interfaces/PluginOptions.md).[`publicPath`](../../../typedoc-plugin-markdown/types/interfaces/PluginOptions.md#publicpath) -#### Defined in - -typedoc-plugin-markdown/dist/types/options.d.ts:146 - *** ### sanitizeComments > **sanitizeComments**: `boolean` +**Defined in**: typedoc-plugin-markdown/dist/types/options.d.ts:150 + Sanitize HTML and JSX inside JsDoc comments. #### Inherited from [`PluginOptions`](../../../typedoc-plugin-markdown/types/interfaces/PluginOptions.md).[`sanitizeComments`](../../../typedoc-plugin-markdown/types/interfaces/PluginOptions.md#sanitizecomments) -#### Defined in - -typedoc-plugin-markdown/dist/types/options.d.ts:150 - *** ### tableColumnSettings > **tableColumnSettings**: `object` +**Defined in**: typedoc-plugin-markdown/dist/types/options.d.ts:154 + Control how table columns are configured and displayed. #### hideDefaults @@ -701,51 +574,49 @@ Control how table columns are configured and displayed. [`PluginOptions`](../../../typedoc-plugin-markdown/types/interfaces/PluginOptions.md).[`tableColumnSettings`](../../../typedoc-plugin-markdown/types/interfaces/PluginOptions.md#tablecolumnsettings) -#### Defined in - -typedoc-plugin-markdown/dist/types/options.d.ts:154 - *** -### textContentMappings +### ~~textContentMappings~~ > **textContentMappings**: `object` -Change specific text placeholders in the template. +**Defined in**: typedoc-plugin-markdown/dist/types/options.d.ts:166 -##### header.title +##### ~~header.title~~ > **header.title**: `string` -##### breadcrumbs.home +##### ~~breadcrumbs.home~~ > **breadcrumbs.home**: `string` -##### title.indexPage +##### ~~title.indexPage~~ > **title.indexPage**: `string` -##### title.memberPage +##### ~~title.memberPage~~ > **title.memberPage**: `string` -##### title.modulePage +##### ~~title.modulePage~~ > **title.modulePage**: `string` -#### Inherited from +#### Deprecated -[`PluginOptions`](../../../typedoc-plugin-markdown/types/interfaces/PluginOptions.md).[`textContentMappings`](../../../typedoc-plugin-markdown/types/interfaces/PluginOptions.md#textcontentmappings) +This option has been deprecated in favour of `--pageTitleTemplates`. -#### Defined in +#### Inherited from -typedoc-plugin-markdown/dist/types/options.d.ts:166 +[`PluginOptions`](../../../typedoc-plugin-markdown/types/interfaces/PluginOptions.md).[`textContentMappings`](../../../typedoc-plugin-markdown/types/interfaces/PluginOptions.md#textcontentmappings) *** ### typeDeclarationFormat -> **typeDeclarationFormat**: `"table"` | `"list"` | `"htmlTable"` +> **typeDeclarationFormat**: `"table"` \| `"list"` \| `"htmlTable"` + +**Defined in**: typedoc-plugin-markdown/dist/types/options.d.ts:176 Sets the format of style for type declaration members. @@ -753,15 +624,13 @@ Sets the format of style for type declaration members. [`PluginOptions`](../../../typedoc-plugin-markdown/types/interfaces/PluginOptions.md).[`typeDeclarationFormat`](../../../typedoc-plugin-markdown/types/interfaces/PluginOptions.md#typedeclarationformat) -#### Defined in - -typedoc-plugin-markdown/dist/types/options.d.ts:176 - *** ### typeDeclarationVisibility -> **typeDeclarationVisibility**: `"compact"` | `"verbose"` +> **typeDeclarationVisibility**: `"compact"` \| `"verbose"` + +**Defined in**: typedoc-plugin-markdown/dist/types/options.d.ts:180 Set the visibility level for type declaration documentation. @@ -769,54 +638,44 @@ Set the visibility level for type declaration documentation. [`PluginOptions`](../../../typedoc-plugin-markdown/types/interfaces/PluginOptions.md).[`typeDeclarationVisibility`](../../../typedoc-plugin-markdown/types/interfaces/PluginOptions.md#typedeclarationvisibility) -#### Defined in - -typedoc-plugin-markdown/dist/types/options.d.ts:180 - *** ### useCodeBlocks > **useCodeBlocks**: `boolean` +**Defined in**: typedoc-plugin-markdown/dist/types/options.d.ts:184 + Wraps signatures and declarations in code blocks. #### Inherited from [`PluginOptions`](../../../typedoc-plugin-markdown/types/interfaces/PluginOptions.md).[`useCodeBlocks`](../../../typedoc-plugin-markdown/types/interfaces/PluginOptions.md#usecodeblocks) -#### Defined in - -typedoc-plugin-markdown/dist/types/options.d.ts:184 - *** ### useHTMLAnchors > **useHTMLAnchors**: `boolean` -Add HTML named anchors to headings and table rows. +**Defined in**: typedoc-plugin-markdown/dist/types/options.d.ts:188 + +Add HTML anchors to page headings. #### Inherited from [`PluginOptions`](../../../typedoc-plugin-markdown/types/interfaces/PluginOptions.md).[`useHTMLAnchors`](../../../typedoc-plugin-markdown/types/interfaces/PluginOptions.md#usehtmlanchors) -#### Defined in - -typedoc-plugin-markdown/dist/types/options.d.ts:188 - *** ### useHTMLEncodedBrackets > **useHTMLEncodedBrackets**: `boolean` +**Defined in**: typedoc-plugin-markdown/dist/types/options.d.ts:192 + Use HTML encoded entities for angle brackets. #### Inherited from [`PluginOptions`](../../../typedoc-plugin-markdown/types/interfaces/PluginOptions.md).[`useHTMLEncodedBrackets`](../../../typedoc-plugin-markdown/types/interfaces/PluginOptions.md#usehtmlencodedbrackets) - -#### Defined in - -typedoc-plugin-markdown/dist/types/options.d.ts:192 diff --git a/devguide/docusaurus-plugin-typedoc/index/README.md b/devguide/docusaurus-plugin-typedoc/index/README.md deleted file mode 100644 index ba3e3397d..000000000 --- a/devguide/docusaurus-plugin-typedoc/index/README.md +++ /dev/null @@ -1,41 +0,0 @@ -[Developer Guide](../../README.md) / [docusaurus-plugin-typedoc](../README.md) / index - -# index - -## Contents - -* [Index](#index-1) - * [Interfaces](#interfaces) -* [default()](#default) - -## Index - -### Interfaces - -| Interface | Description | -| -------------------------------------------- | --------------------------------------------- | -| [PluginOptions](interfaces/PluginOptions.md) | Describes the options declared by the plugin. | - -## default() - -> **default**(`context`, `opts`): `Promise`\<`object`> - -### Parameters - -| Parameter | Type | -| --------- | ---------------------------------------------------------- | -| `context` | `any` | -| `opts` | `Partial`\<[`PluginOptions`](interfaces/PluginOptions.md)> | - -### Returns - -`Promise`\<`object`> - -| Name | Type | Default value | -| ------------- | -------- | --------------------------- | -| `name` | `string` | 'docusaurus-plugin-typedoc' | -| `extendCli()` | `void` | - | - -### Defined in - -[docusaurus-plugin-typedoc/src/plugins/docusaurus.ts:8](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/docusaurus-plugin-typedoc/src/plugins/docusaurus.ts#L8) diff --git a/devguide/docusaurus-plugin-typedoc/options/README.md b/devguide/docusaurus-plugin-typedoc/options/README.md index f42aa0f28..18ff83a17 100644 --- a/devguide/docusaurus-plugin-typedoc/options/README.md +++ b/devguide/docusaurus-plugin-typedoc/options/README.md @@ -4,11 +4,9 @@ All plugin types are exported from this module. -## Index +## Namespaces -### Namespaces - -| Namespace | Description | -| ------------------------------------------------- | ----------- | -| [declarations](namespaces/declarations/README.md) | - | -| [presets](namespaces/presets/README.md) | - | +| Namespace | Description | +| ------ | ------ | +| [declarations](namespaces/declarations/README.md) | - | +| [presets](namespaces/presets/README.md) | - | diff --git a/devguide/docusaurus-plugin-typedoc/options/namespaces/declarations/README.md b/devguide/docusaurus-plugin-typedoc/options/namespaces/declarations/README.md index 499a457ba..a2cdcf0e3 100644 --- a/devguide/docusaurus-plugin-typedoc/options/namespaces/declarations/README.md +++ b/devguide/docusaurus-plugin-typedoc/options/namespaces/declarations/README.md @@ -2,9 +2,13 @@ # declarations -## sidebar +## Variables -> `const` **sidebar**: `Partial`\<[`DeclarationOption`](https://typedoc.org/api/types/Configuration.DeclarationOption.html)> +### sidebar + +> `const` **sidebar**: `Partial`\<[`DeclarationOption`](https://typedoc.org/api/types/Configuration.DeclarationOption.html)\> + +**Defined in**: [docusaurus-plugin-typedoc/src/options/declarations.ts:29](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/docusaurus-plugin-typedoc/src/options/declarations.ts#L29) **sidebar.autoConfiguration** @@ -16,7 +20,7 @@ Pretty format the sidebar JSON. Please see the [sidebar guide](https:/typedoc-plugin-markdown.org/plugins/docusaurus/sidebar) for additional information on sidebar setup. -### Default Value +#### Initializer ```ts { @@ -25,7 +29,3 @@ Please see the [sidebar guide](https:/typedoc-plugin-markdown.org/plugins/docusa defaultValue: DEFAULT_SIDEBAR_OPTIONS, } ``` - -### Defined in - -[docusaurus-plugin-typedoc/src/options/declarations.ts:29](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/docusaurus-plugin-typedoc/src/options/declarations.ts#L29) diff --git a/devguide/docusaurus-plugin-typedoc/options/namespaces/presets/README.md b/devguide/docusaurus-plugin-typedoc/options/namespaces/presets/README.md index cb2b4bd9c..146cdf16a 100644 --- a/devguide/docusaurus-plugin-typedoc/options/namespaces/presets/README.md +++ b/devguide/docusaurus-plugin-typedoc/options/namespaces/presets/README.md @@ -2,20 +2,20 @@ # presets -## presets +## Variables -> `const` **presets**: `object` +### presets -### Type declaration +> `const` **presets**: `object` -| Name | Type | Default value | Description | -| ----------------- | ----------- | ------------- | ----------- | -| `plugin` | `string`\[] | - | | -| `out` | `string` | './docs/api' | - | -| `hideBreadcrumbs` | `boolean` | true | - | -| `hidePageHeader` | `boolean` | true | - | -| `entryFileName` | `string` | 'index.md' | - | +**Defined in**: [docusaurus-plugin-typedoc/src/options/presets.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/docusaurus-plugin-typedoc/src/options/presets.ts#L1) -### Defined in +#### Type declaration -[docusaurus-plugin-typedoc/src/options/presets.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/docusaurus-plugin-typedoc/src/options/presets.ts#L1) +| Name | Type | Default value | Description | +| ------ | ------ | ------ | ------ | +| `plugin` | `string`[] | - | **Initializer** `['typedoc-plugin-markdown', 'docusaurus-plugin-typedoc']` | +| `out` | `string` | './docs/api' | - | +| `hideBreadcrumbs` | `boolean` | true | - | +| `hidePageHeader` | `boolean` | true | - | +| `entryFileName` | `string` | 'index.md' | - | diff --git a/devguide/docusaurus-plugin-typedoc/types/README.md b/devguide/docusaurus-plugin-typedoc/types/README.md index 4ea2e70c1..3ecec5376 100644 --- a/devguide/docusaurus-plugin-typedoc/types/README.md +++ b/devguide/docusaurus-plugin-typedoc/types/README.md @@ -4,11 +4,9 @@ All plugin types are exported from this module. -## Index +## Interfaces -### Interfaces - -| Interface | Description | -| -------------------------------------------- | --------------------------------------------- | +| Interface | Description | +| ------ | ------ | | [PluginOptions](interfaces/PluginOptions.md) | Describes the options declared by the plugin. | -| [Sidebar](interfaces/Sidebar.md) | - | +| [Sidebar](interfaces/Sidebar.md) | - | diff --git a/devguide/docusaurus-plugin-typedoc/types/interfaces/PluginOptions.md b/devguide/docusaurus-plugin-typedoc/types/interfaces/PluginOptions.md index 5c0638dfd..1e7e99433 100644 --- a/devguide/docusaurus-plugin-typedoc/types/interfaces/PluginOptions.md +++ b/devguide/docusaurus-plugin-typedoc/types/interfaces/PluginOptions.md @@ -2,18 +2,13 @@ # Interface: PluginOptions -Describes the options declared by the plugin. - -## Contents +**Defined in**: [docusaurus-plugin-typedoc/src/types/options.ts:7](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/docusaurus-plugin-typedoc/src/types/options.ts#L7) -* [Extended by](#extended-by) -* [Properties](#properties) - * [docusaurusConfigOptions](#docusaurusconfigoptions) - * [sidebar](#sidebar) +Describes the options declared by the plugin. ## Extended by -* [`PluginOptions`](../../index/interfaces/PluginOptions.md) +- [`PluginOptions`](../../core/interfaces/PluginOptions.md) ## Properties @@ -21,11 +16,9 @@ Describes the options declared by the plugin. > **docusaurusConfigOptions**: `string` -docusaurus.config options - should not be used if running as a docusaurus plugin. - -#### Defined in +**Defined in**: [docusaurus-plugin-typedoc/src/types/options.ts:11](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/docusaurus-plugin-typedoc/src/types/options.ts#L11) -[docusaurus-plugin-typedoc/src/types/options.ts:11](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/docusaurus-plugin-typedoc/src/types/options.ts#L11) +docusaurus.config options - should not be used if running as a docusaurus plugin. *** @@ -33,8 +26,6 @@ docusaurus.config options - should not be used if running as a docusaurus plugin > **sidebar**: [`Sidebar`](Sidebar.md) -Configures the autogenerated Docusaurus sidebar. - -#### Defined in +**Defined in**: [docusaurus-plugin-typedoc/src/types/options.ts:16](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/docusaurus-plugin-typedoc/src/types/options.ts#L16) -[docusaurus-plugin-typedoc/src/types/options.ts:16](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/docusaurus-plugin-typedoc/src/types/options.ts#L16) +Configures the autogenerated Docusaurus sidebar. diff --git a/devguide/docusaurus-plugin-typedoc/types/interfaces/Sidebar.md b/devguide/docusaurus-plugin-typedoc/types/interfaces/Sidebar.md index 313fe4ade..c36bd97d2 100644 --- a/devguide/docusaurus-plugin-typedoc/types/interfaces/Sidebar.md +++ b/devguide/docusaurus-plugin-typedoc/types/interfaces/Sidebar.md @@ -2,15 +2,15 @@ # Interface: Sidebar +**Defined in**: [docusaurus-plugin-typedoc/src/types/options.ts:19](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/docusaurus-plugin-typedoc/src/types/options.ts#L19) + ## Properties ### autoConfiguration > **autoConfiguration**: `boolean` -#### Defined in - -[docusaurus-plugin-typedoc/src/types/options.ts:23](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/docusaurus-plugin-typedoc/src/types/options.ts#L23) +**Defined in**: [docusaurus-plugin-typedoc/src/types/options.ts:20](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/docusaurus-plugin-typedoc/src/types/options.ts#L20) *** @@ -18,6 +18,4 @@ > **pretty**: `boolean` -#### Defined in - -[docusaurus-plugin-typedoc/src/types/options.ts:24](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/docusaurus-plugin-typedoc/src/types/options.ts#L24) +**Defined in**: [docusaurus-plugin-typedoc/src/types/options.ts:21](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/docusaurus-plugin-typedoc/src/types/options.ts#L21) diff --git a/devguide/typedoc-github-wiki-theme/README.md b/devguide/typedoc-github-wiki-theme/README.md index ec9bf4f74..29b03237a 100644 --- a/devguide/typedoc-github-wiki-theme/README.md +++ b/devguide/typedoc-github-wiki-theme/README.md @@ -4,20 +4,16 @@ "typedoc-github-wiki-theme" is a "theme" in the sense that it targets output for GitHub Wiki. -## Contents +Package features include: -* [What Does the Package Do?](#what-does-the-package-do) - -## What Does the Package Do? - -* Exposes some additional options to TypeDoc. -* Presets relevant typedoc-plugin-markdown options. -* Generates a Wiki sidebar md file. +- Exposes some additional options to TypeDoc. +- Presets relevant typedoc-plugin-markdown options. +- Generates a Wiki sidebar md file. ## Modules -| Module | Description | -| ---------------------------- | ------------------------------------------------------ | -| [index](index/README.md) | The plugin entrypoint and bootstrapping of the plugin. | -| [options](options/README.md) | All plugin types are exported from this module. | -| [types](types/README.md) | All plugin types are exported from this module. | +| Module | Description | +| ------ | ------ | +| [core](core/README.md) | The plugin entrypoint and bootstrapping of the plugin. | +| [options](options/README.md) | All plugin types are exported from this module. | +| [types](types/README.md) | All plugin types are exported from this module. | diff --git a/devguide/typedoc-github-wiki-theme/core/README.md b/devguide/typedoc-github-wiki-theme/core/README.md new file mode 100644 index 000000000..d46187ac7 --- /dev/null +++ b/devguide/typedoc-github-wiki-theme/core/README.md @@ -0,0 +1,41 @@ +[Developer Guide](../../README.md) / [typedoc-github-wiki-theme](../README.md) / core + +# core + +The plugin entrypoint and bootstrapping of the plugin. + +## Functions + +### load() + +> **load**(`app`): `void` + +**Defined in**: [index.ts:18](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-github-wiki-theme/src/index.ts#L18) + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `app` | [`MarkdownApplication`](../../typedoc-plugin-markdown/types/interfaces/MarkdownApplication.md) | + +#### Returns + +`void` + +*** + +### formatContents() + +> **formatContents**(`contents`): `string` + +**Defined in**: [index.ts:73](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-github-wiki-theme/src/index.ts#L73) + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `contents` | `string` | + +#### Returns + +`string` diff --git a/devguide/typedoc-github-wiki-theme/index/README.md b/devguide/typedoc-github-wiki-theme/index/README.md deleted file mode 100644 index 407886ed9..000000000 --- a/devguide/typedoc-github-wiki-theme/index/README.md +++ /dev/null @@ -1,48 +0,0 @@ -[Developer Guide](../../README.md) / [typedoc-github-wiki-theme](../README.md) / index - -# index - -The plugin entrypoint and bootstrapping of the plugin. - -## Contents - -* [load()](#load) -* [formatContents()](#formatcontents) - -## load() - -> **load**(`app`): `void` - -### Parameters - -| Parameter | Type | -| --------- | ---------------------------------------------------------------------------------------------- | -| `app` | [`MarkdownApplication`](../../typedoc-plugin-markdown/types/interfaces/MarkdownApplication.md) | - -### Returns - -`void` - -### Defined in - -[index.ts:18](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-github-wiki-theme/src/index.ts#L18) - -*** - -## formatContents() - -> **formatContents**(`contents`): `string` - -### Parameters - -| Parameter | Type | -| ---------- | -------- | -| `contents` | `string` | - -### Returns - -`string` - -### Defined in - -[index.ts:73](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-github-wiki-theme/src/index.ts#L73) diff --git a/devguide/typedoc-github-wiki-theme/options/README.md b/devguide/typedoc-github-wiki-theme/options/README.md index 76c51c91b..2aec6e8f6 100644 --- a/devguide/typedoc-github-wiki-theme/options/README.md +++ b/devguide/typedoc-github-wiki-theme/options/README.md @@ -4,11 +4,9 @@ All plugin types are exported from this module. -## Index +## Namespaces -### Namespaces - -| Namespace | Description | -| ------------------------------------------------- | ----------- | -| [declarations](namespaces/declarations/README.md) | - | -| [presets](namespaces/presets/README.md) | - | +| Namespace | Description | +| ------ | ------ | +| [declarations](namespaces/declarations/README.md) | - | +| [presets](namespaces/presets/README.md) | - | diff --git a/devguide/typedoc-github-wiki-theme/options/namespaces/declarations/README.md b/devguide/typedoc-github-wiki-theme/options/namespaces/declarations/README.md index d593977de..675e0191e 100644 --- a/devguide/typedoc-github-wiki-theme/options/namespaces/declarations/README.md +++ b/devguide/typedoc-github-wiki-theme/options/namespaces/declarations/README.md @@ -2,10 +2,14 @@ # declarations -## sidebar +## Variables + +### sidebar > `const` **sidebar**: `object` +**Defined in**: [options/declarations.ts:14](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-github-wiki-theme/src/options/declarations.ts#L14) + **sidebar.autoConfiguration** Set to `false` to disable sidebar generation. Defaults to true. @@ -14,14 +18,10 @@ Set to `false` to disable sidebar generation. Defaults to true. The heading displayed above the sidebar. -### Type declaration - -| Name | Type | Default value | -| -------------- | --------------- | ----------------------------------------------------- | -| `help` | `string` | 'Configures the autogenerated \`\_sidebar.md file\`.' | -| `type` | `ParameterType` | ParameterType.Mixed | -| `defaultValue` | `any` | DEFAULT\_SIDEBAR\_OPTIONS | - -### Defined in +#### Type declaration -[options/declarations.ts:14](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-github-wiki-theme/src/options/declarations.ts#L14) +| Name | Type | Default value | +| ------ | ------ | ------ | +| `help` | `string` | 'Configures the autogenerated \`\_sidebar.md file\`.' | +| `type` | `ParameterType` | ParameterType.Mixed | +| `defaultValue` | `any` | DEFAULT\_SIDEBAR\_OPTIONS | diff --git a/devguide/typedoc-github-wiki-theme/options/namespaces/presets/README.md b/devguide/typedoc-github-wiki-theme/options/namespaces/presets/README.md index c94dd64f6..8179feac1 100644 --- a/devguide/typedoc-github-wiki-theme/options/namespaces/presets/README.md +++ b/devguide/typedoc-github-wiki-theme/options/namespaces/presets/README.md @@ -2,18 +2,18 @@ # presets -## presets +## Variables -> `const` **presets**: `object` +### presets -### Type declaration +> `const` **presets**: `object` -| Name | Type | Default value | -| -------------------- | --------- | ------------- | -| `entryFileName` | `string` | 'Home.md' | -| `hidePageHeader` | `boolean` | true | -| `flattenOutputFiles` | `boolean` | true | +**Defined in**: [options/presets.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-github-wiki-theme/src/options/presets.ts#L1) -### Defined in +#### Type declaration -[options/presets.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-github-wiki-theme/src/options/presets.ts#L1) +| Name | Type | Default value | +| ------ | ------ | ------ | +| `entryFileName` | `string` | 'Home.md' | +| `hidePageHeader` | `boolean` | true | +| `flattenOutputFiles` | `boolean` | true | diff --git a/devguide/typedoc-github-wiki-theme/types/README.md b/devguide/typedoc-github-wiki-theme/types/README.md index 70d719a54..cd5329bd4 100644 --- a/devguide/typedoc-github-wiki-theme/types/README.md +++ b/devguide/typedoc-github-wiki-theme/types/README.md @@ -4,11 +4,9 @@ All plugin types are exported from this module. -## Index +## Interfaces -### Interfaces - -| Interface | Description | -| -------------------------------------------- | --------------------------------------------- | +| Interface | Description | +| ------ | ------ | | [PluginOptions](interfaces/PluginOptions.md) | Describes the options declared by the plugin. | -| [Sidebar](interfaces/Sidebar.md) | - | +| [Sidebar](interfaces/Sidebar.md) | - | diff --git a/devguide/typedoc-github-wiki-theme/types/interfaces/PluginOptions.md b/devguide/typedoc-github-wiki-theme/types/interfaces/PluginOptions.md index 45d6edeea..969eed7c2 100644 --- a/devguide/typedoc-github-wiki-theme/types/interfaces/PluginOptions.md +++ b/devguide/typedoc-github-wiki-theme/types/interfaces/PluginOptions.md @@ -2,6 +2,8 @@ # Interface: PluginOptions +**Defined in**: [types/options.ts:7](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-github-wiki-theme/src/types/options.ts#L7) + Describes the options declared by the plugin. ## Properties @@ -10,8 +12,6 @@ Describes the options declared by the plugin. > **sidebar**: [`Sidebar`](Sidebar.md) -Configures the autogenerated `_sidebar.md file`. - -#### Defined in +**Defined in**: [types/options.ts:11](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-github-wiki-theme/src/types/options.ts#L11) -[types/options.ts:11](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-github-wiki-theme/src/types/options.ts#L11) +Configures the autogenerated `_sidebar.md file`. diff --git a/devguide/typedoc-github-wiki-theme/types/interfaces/Sidebar.md b/devguide/typedoc-github-wiki-theme/types/interfaces/Sidebar.md index 933f15c26..714ec4469 100644 --- a/devguide/typedoc-github-wiki-theme/types/interfaces/Sidebar.md +++ b/devguide/typedoc-github-wiki-theme/types/interfaces/Sidebar.md @@ -2,15 +2,15 @@ # Interface: Sidebar +**Defined in**: [types/options.ts:14](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-github-wiki-theme/src/types/options.ts#L14) + ## Properties ### autoConfiguration > **autoConfiguration**: `boolean` -#### Defined in - -[types/options.ts:18](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-github-wiki-theme/src/types/options.ts#L18) +**Defined in**: [types/options.ts:15](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-github-wiki-theme/src/types/options.ts#L15) *** @@ -18,6 +18,4 @@ > **heading**: `string` -#### Defined in - -[types/options.ts:19](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-github-wiki-theme/src/types/options.ts#L19) +**Defined in**: [types/options.ts:16](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-github-wiki-theme/src/types/options.ts#L16) diff --git a/devguide/typedoc-gitlab-wiki-theme/README.md b/devguide/typedoc-gitlab-wiki-theme/README.md index 3263f3b61..bb1daf858 100644 --- a/devguide/typedoc-gitlab-wiki-theme/README.md +++ b/devguide/typedoc-gitlab-wiki-theme/README.md @@ -4,20 +4,16 @@ "typedoc-gitlab-wiki-theme" is a "theme" in the sense that it targets output for GitLab Wiki. -## Contents +Package features include: -* [What Does the Package Do?](#what-does-the-package-do) - -## What Does the Package Do? - -* Exposes some additional options to TypeDoc. -* Presets relevant typedoc-plugin-markdown options. -* Generates a Wiki sidebar md file. +- Exposes some additional options to TypeDoc. +- Presets relevant typedoc-plugin-markdown options. +- Generates a Wiki sidebar md file. ## Modules -| Module | Description | -| ---------------------------- | ------------------------------------------------------ | -| [index](index/README.md) | The plugin entrypoint and bootstrapping of the plugin. | -| [options](options/README.md) | All plugin types are exported from this module. | -| [types](types/README.md) | All plugin types are exported from this module. | +| Module | Description | +| ------ | ------ | +| [core](core/README.md) | The plugin entrypoint and bootstrapping of the plugin. | +| [options](options/README.md) | All plugin types are exported from this module. | +| [types](types/README.md) | All plugin types are exported from this module. | diff --git a/devguide/typedoc-gitlab-wiki-theme/core/README.md b/devguide/typedoc-gitlab-wiki-theme/core/README.md new file mode 100644 index 000000000..418a73a24 --- /dev/null +++ b/devguide/typedoc-gitlab-wiki-theme/core/README.md @@ -0,0 +1,23 @@ +[Developer Guide](../../README.md) / [typedoc-gitlab-wiki-theme](../README.md) / core + +# core + +The plugin entrypoint and bootstrapping of the plugin. + +## Functions + +### load() + +> **load**(`app`): `void` + +**Defined in**: [index.ts:18](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-gitlab-wiki-theme/src/index.ts#L18) + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `app` | [`MarkdownApplication`](../../typedoc-plugin-markdown/types/interfaces/MarkdownApplication.md) | + +#### Returns + +`void` diff --git a/devguide/typedoc-gitlab-wiki-theme/index/README.md b/devguide/typedoc-gitlab-wiki-theme/index/README.md deleted file mode 100644 index 1e62ffa7c..000000000 --- a/devguide/typedoc-gitlab-wiki-theme/index/README.md +++ /dev/null @@ -1,23 +0,0 @@ -[Developer Guide](../../README.md) / [typedoc-gitlab-wiki-theme](../README.md) / index - -# index - -The plugin entrypoint and bootstrapping of the plugin. - -## load() - -> **load**(`app`): `void` - -### Parameters - -| Parameter | Type | -| --------- | ---------------------------------------------------------------------------------------------- | -| `app` | [`MarkdownApplication`](../../typedoc-plugin-markdown/types/interfaces/MarkdownApplication.md) | - -### Returns - -`void` - -### Defined in - -[index.ts:18](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-gitlab-wiki-theme/src/index.ts#L18) diff --git a/devguide/typedoc-gitlab-wiki-theme/options/README.md b/devguide/typedoc-gitlab-wiki-theme/options/README.md index 9a0eac408..5b80c74b8 100644 --- a/devguide/typedoc-gitlab-wiki-theme/options/README.md +++ b/devguide/typedoc-gitlab-wiki-theme/options/README.md @@ -4,11 +4,9 @@ All plugin types are exported from this module. -## Index +## Namespaces -### Namespaces - -| Namespace | Description | -| ------------------------------------------------- | ----------- | -| [declarations](namespaces/declarations/README.md) | - | -| [presets](namespaces/presets/README.md) | - | +| Namespace | Description | +| ------ | ------ | +| [declarations](namespaces/declarations/README.md) | - | +| [presets](namespaces/presets/README.md) | - | diff --git a/devguide/typedoc-gitlab-wiki-theme/options/namespaces/declarations/README.md b/devguide/typedoc-gitlab-wiki-theme/options/namespaces/declarations/README.md index 8ae1c991c..3760a471d 100644 --- a/devguide/typedoc-gitlab-wiki-theme/options/namespaces/declarations/README.md +++ b/devguide/typedoc-gitlab-wiki-theme/options/namespaces/declarations/README.md @@ -2,10 +2,14 @@ # declarations -## sidebar +## Variables + +### sidebar > `const` **sidebar**: `object` +**Defined in**: [options/declarations.ts:14](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-gitlab-wiki-theme/src/options/declarations.ts#L14) + **sidebar.autoConfiguration** Set to `false` to disable sidebar generation. Defaults to true. @@ -14,14 +18,10 @@ Set to `false` to disable sidebar generation. Defaults to true. The heading displayed above the sidebar. -### Type declaration - -| Name | Type | Default value | -| -------------- | --------------- | ----------------------------------------------------- | -| `help` | `string` | 'Configures the autogenerated \`\_Sidebar.md file\`.' | -| `type` | `ParameterType` | ParameterType.Mixed | -| `defaultValue` | `any` | DEFAULT\_SIDEBAR\_OPTIONS | - -### Defined in +#### Type declaration -[options/declarations.ts:14](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-gitlab-wiki-theme/src/options/declarations.ts#L14) +| Name | Type | Default value | +| ------ | ------ | ------ | +| `help` | `string` | 'Configures the autogenerated \`\_Sidebar.md file\`.' | +| `type` | `ParameterType` | ParameterType.Mixed | +| `defaultValue` | `any` | DEFAULT\_SIDEBAR\_OPTIONS | diff --git a/devguide/typedoc-gitlab-wiki-theme/options/namespaces/presets/README.md b/devguide/typedoc-gitlab-wiki-theme/options/namespaces/presets/README.md index 86f41baff..59c6bf62b 100644 --- a/devguide/typedoc-gitlab-wiki-theme/options/namespaces/presets/README.md +++ b/devguide/typedoc-gitlab-wiki-theme/options/namespaces/presets/README.md @@ -2,17 +2,17 @@ # presets -## presets +## Variables -> `const` **presets**: `object` +### presets -### Type declaration +> `const` **presets**: `object` -| Name | Type | Default value | -| ---------------- | --------- | ------------- | -| `entryFileName` | `string` | 'home.md' | -| `hidePageHeader` | `boolean` | true | +**Defined in**: [options/presets.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-gitlab-wiki-theme/src/options/presets.ts#L1) -### Defined in +#### Type declaration -[options/presets.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-gitlab-wiki-theme/src/options/presets.ts#L1) +| Name | Type | Default value | +| ------ | ------ | ------ | +| `entryFileName` | `string` | 'home.md' | +| `hidePageHeader` | `boolean` | true | diff --git a/devguide/typedoc-gitlab-wiki-theme/types/README.md b/devguide/typedoc-gitlab-wiki-theme/types/README.md index f870366ce..97ee2c122 100644 --- a/devguide/typedoc-gitlab-wiki-theme/types/README.md +++ b/devguide/typedoc-gitlab-wiki-theme/types/README.md @@ -4,11 +4,9 @@ All plugin types are exported from this module. -## Index +## Interfaces -### Interfaces - -| Interface | Description | -| -------------------------------------------- | --------------------------------------------- | +| Interface | Description | +| ------ | ------ | | [PluginOptions](interfaces/PluginOptions.md) | Describes the options declared by the plugin. | -| [Sidebar](interfaces/Sidebar.md) | - | +| [Sidebar](interfaces/Sidebar.md) | - | diff --git a/devguide/typedoc-gitlab-wiki-theme/types/interfaces/PluginOptions.md b/devguide/typedoc-gitlab-wiki-theme/types/interfaces/PluginOptions.md index f1e92f85b..6cb791983 100644 --- a/devguide/typedoc-gitlab-wiki-theme/types/interfaces/PluginOptions.md +++ b/devguide/typedoc-gitlab-wiki-theme/types/interfaces/PluginOptions.md @@ -2,6 +2,8 @@ # Interface: PluginOptions +**Defined in**: [types/options.ts:7](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-gitlab-wiki-theme/src/types/options.ts#L7) + Describes the options declared by the plugin. ## Properties @@ -10,8 +12,6 @@ Describes the options declared by the plugin. > **sidebar**: [`Sidebar`](Sidebar.md) -Configures the autogenerated `_Sidebar.md file`. - -#### Defined in +**Defined in**: [types/options.ts:11](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-gitlab-wiki-theme/src/types/options.ts#L11) -[types/options.ts:11](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-gitlab-wiki-theme/src/types/options.ts#L11) +Configures the autogenerated `_Sidebar.md file`. diff --git a/devguide/typedoc-gitlab-wiki-theme/types/interfaces/Sidebar.md b/devguide/typedoc-gitlab-wiki-theme/types/interfaces/Sidebar.md index d3f5fa4c4..d5563e686 100644 --- a/devguide/typedoc-gitlab-wiki-theme/types/interfaces/Sidebar.md +++ b/devguide/typedoc-gitlab-wiki-theme/types/interfaces/Sidebar.md @@ -2,15 +2,15 @@ # Interface: Sidebar +**Defined in**: [types/options.ts:14](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-gitlab-wiki-theme/src/types/options.ts#L14) + ## Properties ### autoConfiguration > **autoConfiguration**: `boolean` -#### Defined in - -[types/options.ts:18](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-gitlab-wiki-theme/src/types/options.ts#L18) +**Defined in**: [types/options.ts:15](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-gitlab-wiki-theme/src/types/options.ts#L15) *** @@ -18,6 +18,4 @@ > **heading**: `string` -#### Defined in - -[types/options.ts:19](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-gitlab-wiki-theme/src/types/options.ts#L19) +**Defined in**: [types/options.ts:16](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-gitlab-wiki-theme/src/types/options.ts#L16) diff --git a/devguide/typedoc-plugin-frontmatter/README.md b/devguide/typedoc-plugin-frontmatter/README.md index f4482d3c7..7698f718f 100644 --- a/devguide/typedoc-plugin-frontmatter/README.md +++ b/devguide/typedoc-plugin-frontmatter/README.md @@ -4,20 +4,16 @@ "typedoc-plugin-frontmatter" is a utility package the prepends frontmatter to pages. -## Contents +Package features includes: -* [What Does the Package Do?](#what-does-the-package-do) - -## What Does the Package Do? - -* Exposes some additional options to TypeDoc. -* Prepends a YAML block to pages. +- Exposes some additional options to TypeDoc. +- Prepends a YAML block to pages. ## Modules -| Module | Description | -| ---------------------------- | ------------------------------------------------------------------ | -| [index](index/README.md) | The plugin entrypoint and bootstrapping of the plugin. | +| Module | Description | +| ------ | ------ | +| [core](core/README.md) | The plugin entrypoint and bootstrapping of the plugin. | | [options](options/README.md) | Contains all the option declarations and types used in the plugin. | -| [tags](tags/README.md) | Functionality to map options to tags. | -| [types](types/README.md) | All plugin types are exported from this module. | +| [tags](tags/README.md) | Functionality to map options to tags. | +| [types](types/README.md) | All plugin types are exported from this module. | diff --git a/devguide/typedoc-plugin-frontmatter/core/README.md b/devguide/typedoc-plugin-frontmatter/core/README.md new file mode 100644 index 000000000..8367a632d --- /dev/null +++ b/devguide/typedoc-plugin-frontmatter/core/README.md @@ -0,0 +1,29 @@ +[Developer Guide](../../README.md) / [typedoc-plugin-frontmatter](../README.md) / core + +# core + +The plugin entrypoint and bootstrapping of the plugin. + +## Interfaces + +| Interface | Description | +| ------ | ------ | +| [PluginOptions](interfaces/PluginOptions.md) | Describes the options declared by the plugin. | + +## Functions + +### load() + +> **load**(`app`): `void` + +**Defined in**: [index.ts:20](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-frontmatter/src/index.ts#L20) + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `app` | [`MarkdownApplication`](../../typedoc-plugin-markdown/types/interfaces/MarkdownApplication.md) | + +#### Returns + +`void` diff --git a/devguide/typedoc-plugin-frontmatter/core/interfaces/PluginOptions.md b/devguide/typedoc-plugin-frontmatter/core/interfaces/PluginOptions.md new file mode 100644 index 000000000..b783a132a --- /dev/null +++ b/devguide/typedoc-plugin-frontmatter/core/interfaces/PluginOptions.md @@ -0,0 +1,67 @@ +[Developer Guide](../../../README.md) / [typedoc-plugin-frontmatter](../../README.md) / [core](../README.md) / PluginOptions + +# Interface: PluginOptions + +**Defined in**: [types/options.ts:7](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-frontmatter/src/types/options.ts#L7) + +Describes the options declared by the plugin. + +## Properties + +### frontmatterCommentTags + +> **frontmatterCommentTags**: `string`[] + +**Defined in**: [types/options.ts:11](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-frontmatter/src/types/options.ts#L11) + +Specify which comment block tags should be added to frontmatter. + +*** + +### frontmatterGlobals + +> **frontmatterGlobals**: `Record`\<`string`, `any`\> + +**Defined in**: [types/options.ts:16](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-frontmatter/src/types/options.ts#L16) + +Specify static variables to be added to all frontmatter blocks. + +*** + +### frontmatterNamingConvention + +> **frontmatterNamingConvention**: `"camelCase"` \| `"snakeCase"` + +**Defined in**: [types/options.ts:21](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-frontmatter/src/types/options.ts#L21) + +The naming convention that variables should be output as. + +*** + +### indexFrontmatter + +> **indexFrontmatter**: `Record`\<`string`, `any`\> + +**Defined in**: [types/options.ts:26](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-frontmatter/src/types/options.ts#L26) + +Specify static variables to be added to the index page only. + +*** + +### preserveFrontmatterCommentTags + +> **preserveFrontmatterCommentTags**: `boolean` + +**Defined in**: [types/options.ts:31](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-frontmatter/src/types/options.ts#L31) + +Preserve tags defined in frontmatter block tags in output. + +*** + +### readmeFrontmatter + +> **readmeFrontmatter**: `Record`\<`string`, `any`\> + +**Defined in**: [types/options.ts:36](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-frontmatter/src/types/options.ts#L36) + +Specify static variables to be added to the readme page only. diff --git a/devguide/typedoc-plugin-frontmatter/index/README.md b/devguide/typedoc-plugin-frontmatter/index/README.md deleted file mode 100644 index a0c489761..000000000 --- a/devguide/typedoc-plugin-frontmatter/index/README.md +++ /dev/null @@ -1,23 +0,0 @@ -[Developer Guide](../../README.md) / [typedoc-plugin-frontmatter](../README.md) / index - -# index - -The plugin entrypoint and bootstrapping of the plugin. - -## load() - -> **load**(`app`): `void` - -### Parameters - -| Parameter | Type | -| --------- | ---------------------------------------------------------------------------------------------- | -| `app` | [`MarkdownApplication`](../../typedoc-plugin-markdown/types/interfaces/MarkdownApplication.md) | - -### Returns - -`void` - -### Defined in - -[index.ts:20](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-frontmatter/src/index.ts#L20) diff --git a/devguide/typedoc-plugin-frontmatter/options/README.md b/devguide/typedoc-plugin-frontmatter/options/README.md index 7505fca0e..6dfa09d0c 100644 --- a/devguide/typedoc-plugin-frontmatter/options/README.md +++ b/devguide/typedoc-plugin-frontmatter/options/README.md @@ -4,11 +4,9 @@ Contains all the option declarations and types used in the plugin. -## Index +## Namespaces -### Namespaces - -| Namespace | Description | -| ------------------------------------------------- | ----------- | -| [declarations](namespaces/declarations/README.md) | - | -| [maps](namespaces/maps/README.md) | - | +| Namespace | Description | +| ------ | ------ | +| [declarations](namespaces/declarations/README.md) | Typedoc options declarations. | +| [maps](namespaces/maps/README.md) | Defines option maps TypeDoc parameter Map types. | diff --git a/devguide/typedoc-plugin-frontmatter/options/namespaces/declarations/README.md b/devguide/typedoc-plugin-frontmatter/options/namespaces/declarations/README.md index 9b35cc7e2..09687418f 100644 --- a/devguide/typedoc-plugin-frontmatter/options/namespaces/declarations/README.md +++ b/devguide/typedoc-plugin-frontmatter/options/namespaces/declarations/README.md @@ -2,18 +2,15 @@ # declarations -## Contents +Typedoc options declarations. -* [frontmatterGlobals](#frontmatterglobals) -* [readmeFrontmatter](#readmefrontmatter) -* [indexFrontmatter](#indexfrontmatter) -* [frontmatterCommentTags](#frontmattercommenttags) -* [preserveFrontmatterCommentTags](#preservefrontmattercommenttags) -* [frontmatterNamingConvention](#frontmatternamingconvention) +## Variables -## frontmatterGlobals +### frontmatterGlobals -> `const` **frontmatterGlobals**: `Partial`\<[`DeclarationOption`](https://typedoc.org/api/types/Configuration.DeclarationOption.html)> +> `const` **frontmatterGlobals**: `Partial`\<[`DeclarationOption`](https://typedoc.org/api/types/Configuration.DeclarationOption.html)\> + +**Defined in**: [options/declarations.ts:21](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-frontmatter/src/options/declarations.ts#L21) ```yaml filename="YAML" --- @@ -22,106 +19,115 @@ sidebar: true --- ``` -### Example +#### Example ```ts {"layout": "docs", "sidebar": true } ``` -### Default Value +#### Initializer ```ts { help: 'Specify static variables to be added to all frontmatter blocks.', - type: ParameterType.Mixed, + type: ParameterType.Object, defaultValue: {}, + validate(value) { + if (typeof value !== 'object') { + throw new Error('[typedoc-plugin-frontmatter] frontmatterGlobals must be an object.'); + } + }, } ``` -### Defined in - -[options/declarations.ts:15](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-frontmatter/src/options/declarations.ts#L15) - *** -## readmeFrontmatter +### readmeFrontmatter -> `const` **readmeFrontmatter**: `Partial`\<[`DeclarationOption`](https://typedoc.org/api/types/Configuration.DeclarationOption.html)> +> `const` **readmeFrontmatter**: `Partial`\<[`DeclarationOption`](https://typedoc.org/api/types/Configuration.DeclarationOption.html)\> -### Example +**Defined in**: [options/declarations.ts:37](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-frontmatter/src/options/declarations.ts#L37) + +#### Example ```ts {"onReadme": "true" } ``` -### Default Value +#### Initializer ```ts { help: 'Specify static variables to be added to the readme page only.', - type: ParameterType.Mixed, + type: ParameterType.Object, defaultValue: {}, + validate(value) { + if (typeof value !== 'object') { + throw new Error('[typedoc-plugin-frontmatter] readmeFrontmatter must be an object.'); + } + }, } ``` -### Defined in - -[options/declarations.ts:24](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-frontmatter/src/options/declarations.ts#L24) - *** -## indexFrontmatter +### indexFrontmatter + +> `const` **indexFrontmatter**: `Partial`\<[`DeclarationOption`](https://typedoc.org/api/types/Configuration.DeclarationOption.html)\> -> `const` **indexFrontmatter**: `Partial`\<[`DeclarationOption`](https://typedoc.org/api/types/Configuration.DeclarationOption.html)> +**Defined in**: [options/declarations.ts:53](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-frontmatter/src/options/declarations.ts#L53) -### Example +#### Example ```ts {"onIndex": "true" } ``` -### Default Value +#### Initializer ```ts { help: 'Specify static variables to be added to the index page only.', - type: ParameterType.Mixed, + type: ParameterType.Object, defaultValue: {}, + validate(value) { + if (typeof value !== 'object') { + throw new Error('[typedoc-plugin-frontmatter] indexFrontmatter must be an object.'); + } + }, } ``` -### Defined in - -[options/declarations.ts:33](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-frontmatter/src/options/declarations.ts#L33) - *** -## frontmatterCommentTags +### frontmatterCommentTags + +> `const` **frontmatterCommentTags**: `Partial`\<[`DeclarationOption`](https://typedoc.org/api/types/Configuration.DeclarationOption.html)\> -> `const` **frontmatterCommentTags**: `Partial`\<[`DeclarationOption`](https://typedoc.org/api/types/Configuration.DeclarationOption.html)> +**Defined in**: [options/declarations.ts:88](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-frontmatter/src/options/declarations.ts#L88) Frontmatter variables can be added by extracting comments from block (@) tags. Please note tags must be added to the comment blocks of the symbol exported to a page. -```ansi filename="Block Tags (someModule.ts)" -/** -* \@author Joe Bloggs -* -* \@description A description that will be added to frontmatter. -*/ -``` + ```ts filename="Block Tags (someModule.ts)" + /** + * \@author Joe Bloggs + * + * \@description A description that will be added to frontmatter. + */ + ``` ```yaml filename="YAML (someModule.md)" --- author: Joe Bloggs description: A description that will be added to frontmatter. --- -``` +```` -@example \["author", "description"] +@example ["author", "description"] -### Default Value +#### Initializer ```ts { @@ -130,17 +136,15 @@ description: A description that will be added to frontmatter. } ``` -### Defined in - -[options/declarations.ts:61](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-frontmatter/src/options/declarations.ts#L61) - *** -## preserveFrontmatterCommentTags +### preserveFrontmatterCommentTags + +> `const` **preserveFrontmatterCommentTags**: `Partial`\<[`DeclarationOption`](https://typedoc.org/api/types/Configuration.DeclarationOption.html)\> -> `const` **preserveFrontmatterCommentTags**: `Partial`\<[`DeclarationOption`](https://typedoc.org/api/types/Configuration.DeclarationOption.html)> +**Defined in**: [options/declarations.ts:93](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-frontmatter/src/options/declarations.ts#L93) -### Default Value +#### Initializer ```ts { @@ -150,21 +154,19 @@ description: A description that will be added to frontmatter. } ``` -### Defined in - -[options/declarations.ts:66](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-frontmatter/src/options/declarations.ts#L66) - *** -## frontmatterNamingConvention +### frontmatterNamingConvention + +> `const` **frontmatterNamingConvention**: `Partial`\<[`DeclarationOption`](https://typedoc.org/api/types/Configuration.DeclarationOption.html)\> -> `const` **frontmatterNamingConvention**: `Partial`\<[`DeclarationOption`](https://typedoc.org/api/types/Configuration.DeclarationOption.html)> +**Defined in**: [options/declarations.ts:104](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-frontmatter/src/options/declarations.ts#L104) Block tags have to be written in camelCase (see [tsdoc.org](https://tsdoc.org/pages/spec/tag_kinds)). This option can configure the output style of frontmatter variables when written to YAML. -### Default Value +#### Initializer ```ts { @@ -174,7 +176,3 @@ This option can configure the output style of frontmatter variables when written defaultValue: FrontmatterNamingConvention.CamelCase, } ``` - -### Defined in - -[options/declarations.ts:77](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-frontmatter/src/options/declarations.ts#L77) diff --git a/devguide/typedoc-plugin-frontmatter/options/namespaces/maps/README.md b/devguide/typedoc-plugin-frontmatter/options/namespaces/maps/README.md index 9c722b85e..d3e9c27fa 100644 --- a/devguide/typedoc-plugin-frontmatter/options/namespaces/maps/README.md +++ b/devguide/typedoc-plugin-frontmatter/options/namespaces/maps/README.md @@ -2,10 +2,17 @@ # maps -## Index +Defines option maps TypeDoc parameter Map types. -### Enumerations +## Enumerations -| Enumeration | Description | -| -------------------------------------------------------------------------- | ----------- | -| [FrontmatterNamingConvention](enumerations/FrontmatterNamingConvention.md) | - | +### FrontmatterNamingConvention + +**Defined in**: [options/maps.ts:7](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-frontmatter/src/options/maps.ts#L7) + +#### Enumeration Members + +| Enumeration Member | Value | +| ------ | ------ | +| `CamelCase` | `"camelCase"` | +| `SnakeCase` | `"snakeCase"` | diff --git a/devguide/typedoc-plugin-frontmatter/options/namespaces/maps/enumerations/FrontmatterNamingConvention.md b/devguide/typedoc-plugin-frontmatter/options/namespaces/maps/enumerations/FrontmatterNamingConvention.md deleted file mode 100644 index d4f21a34d..000000000 --- a/devguide/typedoc-plugin-frontmatter/options/namespaces/maps/enumerations/FrontmatterNamingConvention.md +++ /dev/null @@ -1,10 +0,0 @@ -[Developer Guide](../../../../../README.md) / [typedoc-plugin-frontmatter](../../../../README.md) / [options](../../../README.md) / [maps](../README.md) / FrontmatterNamingConvention - -# Enumeration: FrontmatterNamingConvention - -## Enumeration Members - -| Enumeration Member | Value | -| ------------------ | ------------- | -| `CamelCase` | `"camelCase"` | -| `SnakeCase` | `"snakeCase"` | diff --git a/devguide/typedoc-plugin-frontmatter/tags/README.md b/devguide/typedoc-plugin-frontmatter/tags/README.md index 8cad5c87f..1d124fdc2 100644 --- a/devguide/typedoc-plugin-frontmatter/tags/README.md +++ b/devguide/typedoc-plugin-frontmatter/tags/README.md @@ -4,48 +4,41 @@ Functionality to map options to tags. -## Contents +## Functions -* [getResolvedTags()](#getresolvedtags) -* [getFrontmatterTags()](#getfrontmattertags) - -## getResolvedTags() +### getResolvedTags() > **getResolvedTags**(`app`, `comment`?): `object` -### Parameters - -| Parameter | Type | -| ---------- | ---------------------------------------------------------------------------------------------- | -| `app` | [`MarkdownApplication`](../../typedoc-plugin-markdown/types/interfaces/MarkdownApplication.md) | -| `comment`? | [`Comment`](https://typedoc.org/api/classes/Models.Comment.html) | +**Defined in**: [tags.ts:10](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-frontmatter/src/tags.ts#L10) -### Returns +#### Parameters -`object` +| Parameter | Type | +| ------ | ------ | +| `app` | [`MarkdownApplication`](../../typedoc-plugin-markdown/types/interfaces/MarkdownApplication.md) | +| `comment`? | [`Comment`](https://typedoc.org/api/classes/Models.Comment.html) | -### Defined in +#### Returns -[tags.ts:10](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-frontmatter/src/tags.ts#L10) +`object` *** -## getFrontmatterTags() +### getFrontmatterTags() > **getFrontmatterTags**(`comment`, `frontmatterTags`, `namingConvention`): `object` -### Parameters +**Defined in**: [tags.ts:34](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-frontmatter/src/tags.ts#L34) -| Parameter | Type | -| ------------------ | ------------------------------------------------------------------------------------------------------- | -| `comment` | [`Comment`](https://typedoc.org/api/classes/Models.Comment.html) | -| `frontmatterTags` | `string`\[] | -| `namingConvention` | [`FrontmatterNamingConvention`](../options/namespaces/maps/enumerations/FrontmatterNamingConvention.md) | +#### Parameters -### Returns +| Parameter | Type | +| ------ | ------ | +| `comment` | [`Comment`](https://typedoc.org/api/classes/Models.Comment.html) | +| `frontmatterTags` | `string`[] | +| `namingConvention` | [`FrontmatterNamingConvention`](../options/namespaces/maps/README.md#frontmatternamingconvention) | -`object` - -### Defined in +#### Returns -[tags.ts:34](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-frontmatter/src/tags.ts#L34) +`object` diff --git a/devguide/typedoc-plugin-frontmatter/types/README.md b/devguide/typedoc-plugin-frontmatter/types/README.md index 25a7f4813..f6acd48d5 100644 --- a/devguide/typedoc-plugin-frontmatter/types/README.md +++ b/devguide/typedoc-plugin-frontmatter/types/README.md @@ -4,13 +4,8 @@ All plugin types are exported from this module. -## Index +## References -### Interfaces +### PluginOptions -| Interface | Description | -| ------------------------------------------------------ | --------------------------------------------- | -| [PluginOptions](interfaces/PluginOptions.md) | Describes the options declared by the plugin. | -| [FrontmatterGlobals](interfaces/FrontmatterGlobals.md) | - | -| [IndexFrontmatter](interfaces/IndexFrontmatter.md) | - | -| [ReadmeFrontmatter](interfaces/ReadmeFrontmatter.md) | - | +Re-exports [PluginOptions](../core/interfaces/PluginOptions.md) diff --git a/devguide/typedoc-plugin-frontmatter/types/interfaces/FrontmatterGlobals.md b/devguide/typedoc-plugin-frontmatter/types/interfaces/FrontmatterGlobals.md deleted file mode 100644 index 6f4a2b6b1..000000000 --- a/devguide/typedoc-plugin-frontmatter/types/interfaces/FrontmatterGlobals.md +++ /dev/null @@ -1,3 +0,0 @@ -[Developer Guide](../../../README.md) / [typedoc-plugin-frontmatter](../../README.md) / [types](../README.md) / FrontmatterGlobals - -# Interface: FrontmatterGlobals diff --git a/devguide/typedoc-plugin-frontmatter/types/interfaces/IndexFrontmatter.md b/devguide/typedoc-plugin-frontmatter/types/interfaces/IndexFrontmatter.md deleted file mode 100644 index c6f97de81..000000000 --- a/devguide/typedoc-plugin-frontmatter/types/interfaces/IndexFrontmatter.md +++ /dev/null @@ -1,3 +0,0 @@ -[Developer Guide](../../../README.md) / [typedoc-plugin-frontmatter](../../README.md) / [types](../README.md) / IndexFrontmatter - -# Interface: IndexFrontmatter diff --git a/devguide/typedoc-plugin-frontmatter/types/interfaces/PluginOptions.md b/devguide/typedoc-plugin-frontmatter/types/interfaces/PluginOptions.md deleted file mode 100644 index 35029afb7..000000000 --- a/devguide/typedoc-plugin-frontmatter/types/interfaces/PluginOptions.md +++ /dev/null @@ -1,77 +0,0 @@ -[Developer Guide](../../../README.md) / [typedoc-plugin-frontmatter](../../README.md) / [types](../README.md) / PluginOptions - -# Interface: PluginOptions - -Describes the options declared by the plugin. - -## Properties - -### frontmatterCommentTags - -> **frontmatterCommentTags**: `string`\[] - -Specify which comment block tags should be added to frontmatter. - -#### Defined in - -[types/options.ts:11](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-frontmatter/src/types/options.ts#L11) - -*** - -### frontmatterGlobals - -> **frontmatterGlobals**: [`FrontmatterGlobals`](FrontmatterGlobals.md) - -Specify static variables to be added to all frontmatter blocks. - -#### Defined in - -[types/options.ts:16](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-frontmatter/src/types/options.ts#L16) - -*** - -### frontmatterNamingConvention - -> **frontmatterNamingConvention**: `"camelCase"` | `"snakeCase"` - -The naming convention that variables should be output as. - -#### Defined in - -[types/options.ts:21](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-frontmatter/src/types/options.ts#L21) - -*** - -### indexFrontmatter - -> **indexFrontmatter**: [`IndexFrontmatter`](IndexFrontmatter.md) - -Specify static variables to be added to the index page only. - -#### Defined in - -[types/options.ts:26](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-frontmatter/src/types/options.ts#L26) - -*** - -### preserveFrontmatterCommentTags - -> **preserveFrontmatterCommentTags**: `boolean` - -Preserve tags defined in frontmatter block tags in output. - -#### Defined in - -[types/options.ts:31](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-frontmatter/src/types/options.ts#L31) - -*** - -### readmeFrontmatter - -> **readmeFrontmatter**: [`ReadmeFrontmatter`](ReadmeFrontmatter.md) - -Specify static variables to be added to the readme page only. - -#### Defined in - -[types/options.ts:36](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-frontmatter/src/types/options.ts#L36) diff --git a/devguide/typedoc-plugin-frontmatter/types/interfaces/ReadmeFrontmatter.md b/devguide/typedoc-plugin-frontmatter/types/interfaces/ReadmeFrontmatter.md deleted file mode 100644 index e534268d7..000000000 --- a/devguide/typedoc-plugin-frontmatter/types/interfaces/ReadmeFrontmatter.md +++ /dev/null @@ -1,3 +0,0 @@ -[Developer Guide](../../../README.md) / [typedoc-plugin-frontmatter](../../README.md) / [types](../README.md) / ReadmeFrontmatter - -# Interface: ReadmeFrontmatter diff --git a/devguide/typedoc-plugin-markdown/README.md b/devguide/typedoc-plugin-markdown/README.md index 550827a5b..f373c7440 100644 --- a/devguide/typedoc-plugin-markdown/README.md +++ b/devguide/typedoc-plugin-markdown/README.md @@ -4,33 +4,28 @@ The core package of this monorepo and is the package that is used to generate the markdown documentation. -## Contents +Package features include: -* [What Does the Package Do?](#what-does-the-package-do) -* [Documents](#documents) - -## What Does the Package Do? - -* Extends some methods on the TypeDoc renderer to make compatible with Markdown output. -* Exposes some additional options to TypeDoc. -* Creates a new MarkdownTheme class that overrides the HTML DefaultTheme. -* Exposes some types on a public API. +- Extends some methods on the TypeDoc renderer to make compatible with Markdown output. +- Exposes some additional options to TypeDoc. +- Creates a new MarkdownTheme class that overrides the HTML DefaultTheme. +- Exposes some types on a public API. ## Documents -| Document | Description | -| ------------------------------------------------------- | ------------------------------------------------------------------- | +| Document | Description | +| ------ | ------ | | [Test and Validation](documents/Test-and-Validation.md) | Guidance on running tests, creating fixtures and validating output. | ## Modules -| Module | Description | -| ------------------------------------------------------ | -------------------------------------------------------------------- | -| [index](index/README.md) | The plugin entrypoint and bootstrapping of the plugin. | -| [renderer](renderer/README.md) | Includes functionality and override methods on the TypeDoc Renderer. | -| [events](events/README.md) | Contains the events classes used by the plugin. | -| [options](options/README.md) | Contains all the option declarations and types used in the plugin. | -| [internationalization](internationalization/README.md) | Exposes additional i18n keys and translations used by the theme. | -| [theme](theme/README.md) | Contains all functionality relevant to the markdown theme. | -| [libs](libs/README.md) | General pure library functions to be consumed across the plugin. | -| [types](types/README.md) | All plugin types are exported from this module. | +| Module | Description | +| ------ | ------ | +| [core](core/README.md) | The entry point for initializing and bootstrapping the plugin. | +| [renderer](renderer/README.md) | Includes functionality and override methods on the TypeDoc Renderer. | +| [events](events/README.md) | Contains the events classes used by the plugin. | +| [options](options/README.md) | Contains all the option declarations and types used in the plugin. | +| [internationalization](internationalization/README.md) | Exposes additional i18n keys and translations used by the theme. | +| [theme](theme/README.md) | Contains all functionality relevant to the markdown theme. | +| [libs](libs/README.md) | General pure library functions to be consumed across the plugin. | +| [types](types/README.md) | All plugin types are exported from this module. | diff --git a/devguide/typedoc-plugin-markdown/core/README.md b/devguide/typedoc-plugin-markdown/core/README.md new file mode 100644 index 000000000..7062d2f3a --- /dev/null +++ b/devguide/typedoc-plugin-markdown/core/README.md @@ -0,0 +1,40 @@ +[Developer Guide](../../README.md) / [typedoc-plugin-markdown](../README.md) / core + +# core + +The entry point for initializing and bootstrapping the plugin. + +## Functions + +### load() + +> **load**(`app`): `void` + +**Defined in**: [packages/typedoc-plugin-markdown/src/index.ts:40](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/index.ts#L40) + +The function that is called by TypeDoc to bootstrap the plugin. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `app` | [`Application`](https://typedoc.org/api/classes/Application.html) | + +#### Returns + +`void` + +#### Remarks + +The load function exposes additional TypeDoc options and make some adjustments. + +This method is not intended to be consumed in any other context that via the `plugin` option. + +The load functions: + +1. Bootstrap the plugin options +2. Configures markdown outputs +3. Configures localization +4. Applies any other behaviour + +The module also exports anything that is available publicly. diff --git a/devguide/typedoc-plugin-markdown/documents/Test-and-Validation.md b/devguide/typedoc-plugin-markdown/documents/Test-and-Validation.md index 6628f7a50..a81ba2ab0 100644 --- a/devguide/typedoc-plugin-markdown/documents/Test-and-Validation.md +++ b/devguide/typedoc-plugin-markdown/documents/Test-and-Validation.md @@ -4,22 +4,10 @@ This document contains guidance on running tests and creating fixtures. -## Contents - -* [Tooling](#tooling) -* [Get Started](#get-started) -* [Fixtures](#fixtures) - * [Building Fixtures](#building-fixtures) -* [Test](#test) - * [Specs](#specs) - * [Updating Snapshots](#updating-snapshots) -* [Validation](#validation) - * [Validation Scripts](#validation-scripts) - ## Tooling -* We use [Jest](https://jestjs.io/) with [ts-Jest](https://kulshekhar.github.io/ts-jest/) to run our test suites. -* We use [markdownlint](https://github.com/DavidAnson/markdownlint) and [remark-mdx](https://mdxjs.com/packages/remark-mdx/) to validate markdown. +- We use [Jest](https://jestjs.io/) with [ts-Jest](https://kulshekhar.github.io/ts-jest/) to run our test suites. +- We use [markdownlint](https://github.com/DavidAnson/markdownlint) and [remark-mdx](https://mdxjs.com/packages/remark-mdx/) to validate markdown. ## Get Started @@ -31,9 +19,9 @@ npm run test This command: -* Generates a suite of fixtures on a `prebuild` task. -* Runs some validation scripts to check the output of the fixtures. -* Runs Jest and triggers the spec files. +- Generates a suite of fixtures on a `prebuild` task. +- Runs some validation scripts to check the output of the fixtures. +- Runs Jest and triggers the spec files. ## Fixtures @@ -44,8 +32,8 @@ A series of snapshot tests are used to ensure the output of the plugin is consis ### Building Fixtures -* The `/fixtures/src` folder contains a set of TypeScript source files that are used as entrypoints. -* The `/fixtures/config.ts` is a configuration file that generates a set of fixture output files that are used by the Jest snapshot tests. It provides a mechanism to easily provide a combination of options. +- The `/fixtures/src` folder contains a set of TypeScript source files that are used as entrypoints. +- The `/fixtures/config.ts` is a configuration file that generates a set of fixture output files that are used by the Jest snapshot tests. It provides a mechanism to easily provide a combination of options. The fixtures are build in `pretest` script using a an internal package workspace. See `devtools/packages/fixtures`. @@ -55,8 +43,8 @@ Tests are run on the Jest test suite. ### Specs -* There are a suite of tests located in `/test/specs`. These tests run a series of snapshot tests against some output fixtures. -* All pure utility lib methods also have specs run against them in `/src/libs/utils`. +- There are a suite of tests located in `/test/specs`. These tests run a series of snapshot tests against some output fixtures. +- All pure utility lib methods also have specs run against them in `/src/libs/utils`. ### Updating Snapshots @@ -75,5 +63,5 @@ When the fixtures are build the output markdown is validated. ### Validation Scripts -* `markdownlint` ensures that all output is commonMark complaint. See `/test/script/lint.md`. -* `remark-mdx` ensures that the output is also MDX compliant. See `/test/script/lint.mdx`. +- `markdownlint` ensures that all output is commonMark complaint. See `/test/script/lint.md`. +- `remark-mdx` ensures that the output is also MDX compliant. See `/test/script/lint.mdx`. diff --git a/devguide/typedoc-plugin-markdown/events/README.md b/devguide/typedoc-plugin-markdown/events/README.md index 6cae505a6..2bc0ccc27 100644 --- a/devguide/typedoc-plugin-markdown/events/README.md +++ b/devguide/typedoc-plugin-markdown/events/README.md @@ -4,11 +4,9 @@ Contains the events classes used by the plugin. -## Index +## Events -### Events - -| Class | Description | -| --------------------------------------------------------- | --------------------------------------------------------------------- | -| [MarkdownPageEvent](classes/MarkdownPageEvent.md) | An event emitted before and after the markdown of a page is rendered. | -| [MarkdownRendererEvent](classes/MarkdownRendererEvent.md) | An event emitted at the beginning and end of the rendering process. | +| Class | Description | +| ------ | ------ | +| [MarkdownPageEvent](classes/MarkdownPageEvent.md) | An event emitted before and after the markdown of a page is rendered. | +| [MarkdownRendererEvent](classes/MarkdownRendererEvent.md) | An event emitted at the beginning and end of the rendering process. | diff --git a/devguide/typedoc-plugin-markdown/events/classes/MarkdownPageEvent.md b/devguide/typedoc-plugin-markdown/events/classes/MarkdownPageEvent.md index be6f30587..f1b4f8591 100644 --- a/devguide/typedoc-plugin-markdown/events/classes/MarkdownPageEvent.md +++ b/devguide/typedoc-plugin-markdown/events/classes/MarkdownPageEvent.md @@ -1,34 +1,20 @@ [Developer Guide](../../../README.md) / [typedoc-plugin-markdown](../../README.md) / [events](../README.md) / MarkdownPageEvent -# Class: MarkdownPageEvent\ +# Class: MarkdownPageEvent\ -An event emitted before and after the markdown of a page is rendered. +**Defined in**: [packages/typedoc-plugin-markdown/src/events/markdown-page-event.ts:8](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/events/markdown-page-event.ts#L8) -## Contents - -* [Extends](#extends) -* [Type Parameters](#type-parameters) -* [Properties](#properties) - * [project](#project) - * [model](#model) - * [group?](#group) - * [contents?](#contents-1) - * [url](#url) - * [filename](#filename) - * [frontmatter?](#frontmatter) -* [Events](#events) - * [BEGIN](#begin) - * [END](#end) +An event emitted before and after the markdown of a page is rendered. ## Extends -* `Event` +- `Event` ## Type Parameters -| Type Parameter | Default type | -| -------------- | --------------------------------------------------------------- | -| `Model` | [`Reflection`](https://typedoc.org/api/classes/Reflection.html) | +| Type Parameter | Default type | +| ------ | ------ | +| `Model` | [`Reflection`](https://typedoc.org/api/classes/Reflection.html) | ## Properties @@ -36,36 +22,30 @@ An event emitted before and after the markdown of a page is rendered. > **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 +**Defined in**: [packages/typedoc-plugin-markdown/src/events/markdown-page-event.ts:14](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/events/markdown-page-event.ts#L14) -[packages/typedoc-plugin-markdown/src/events/markdown-page-event.ts:14](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/events/markdown-page-event.ts#L14) +The [`ProjectReflection`](https://typedoc.org/api/classes/Models.ProjectReflection.html) instance the renderer is currently processing. *** ### model -> `readonly` **model**: `Model` +> `readonly` **model**: [`Model`](../../../classes/typedoc-plugin-markdown.events.MarkdownPageEvent.html#model) + +**Defined in**: [packages/typedoc-plugin-markdown/src/events/markdown-page-event.ts:20](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/events/markdown-page-event.ts#L20) 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/events/markdown-page-event.ts:20](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/events/markdown-page-event.ts#L20) - *** ### group? > `optional` **group**: `string` -The group title of the group reflection belongs to. - -#### Defined in +**Defined in**: [packages/typedoc-plugin-markdown/src/events/markdown-page-event.ts:25](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/events/markdown-page-event.ts#L25) -[packages/typedoc-plugin-markdown/src/events/markdown-page-event.ts:25](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/events/markdown-page-event.ts#L25) +The group title of the group reflection belongs to. *** @@ -73,25 +53,21 @@ The group title of the group reflection belongs to. > `optional` **contents**: `string` +**Defined in**: [packages/typedoc-plugin-markdown/src/events/markdown-page-event.ts:32](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/events/markdown-page-event.ts#L32) + The final markdown `string` content of the page. Should be rendered by layout templates and can be modified by plugins. -#### Defined in - -[packages/typedoc-plugin-markdown/src/events/markdown-page-event.ts:32](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/events/markdown-page-event.ts#L32) - *** ### url > **url**: `string` -The url `string` of the page. +**Defined in**: [packages/typedoc-plugin-markdown/src/events/markdown-page-event.ts:37](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/events/markdown-page-event.ts#L37) -#### Defined in - -[packages/typedoc-plugin-markdown/src/events/markdown-page-event.ts:37](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/events/markdown-page-event.ts#L37) +The url `string` of the page. *** @@ -99,23 +75,19 @@ The url `string` of the page. > **filename**: `string` -The complete `string` filename where the file will be written.. - -#### Defined in +**Defined in**: [packages/typedoc-plugin-markdown/src/events/markdown-page-event.ts:42](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/events/markdown-page-event.ts#L42) -[packages/typedoc-plugin-markdown/src/events/markdown-page-event.ts:42](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/events/markdown-page-event.ts#L42) +The complete `string` filename where the file will be written.. *** ### frontmatter? -> `optional` **frontmatter**: `Record`\<`string`, `any`> - -The frontmatter of this page represented as a key value object. This property can be utilised by other plugins. +> `optional` **frontmatter**: `Record`\<`string`, `any`\> -#### Defined in +**Defined in**: [packages/typedoc-plugin-markdown/src/events/markdown-page-event.ts:47](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/events/markdown-page-event.ts#L47) -[packages/typedoc-plugin-markdown/src/events/markdown-page-event.ts:47](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/events/markdown-page-event.ts#L47) +The frontmatter of this page represented as a key value object. This property can be utilised by other plugins. ## Events @@ -123,11 +95,9 @@ The frontmatter of this page represented as a key value object. This property ca > `readonly` `static` **BEGIN**: `"beginPage"` = `'beginPage'` -Triggered before a document will be rendered. - -#### Defined in +**Defined in**: [packages/typedoc-plugin-markdown/src/events/markdown-page-event.ts:61](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/events/markdown-page-event.ts#L61) -[packages/typedoc-plugin-markdown/src/events/markdown-page-event.ts:61](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/events/markdown-page-event.ts#L61) +Triggered before a document will be rendered. *** @@ -135,8 +105,6 @@ Triggered before a document will be rendered. > `readonly` `static` **END**: `"endPage"` = `'endPage'` -Triggered after a document has been rendered, just before it is written to disc. - -#### Defined in +**Defined in**: [packages/typedoc-plugin-markdown/src/events/markdown-page-event.ts:67](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/events/markdown-page-event.ts#L67) -[packages/typedoc-plugin-markdown/src/events/markdown-page-event.ts:67](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/events/markdown-page-event.ts#L67) +Triggered after a document has been rendered, just before it is written to disc. diff --git a/devguide/typedoc-plugin-markdown/events/classes/MarkdownRendererEvent.md b/devguide/typedoc-plugin-markdown/events/classes/MarkdownRendererEvent.md index bd994f8b3..1a823fe35 100644 --- a/devguide/typedoc-plugin-markdown/events/classes/MarkdownRendererEvent.md +++ b/devguide/typedoc-plugin-markdown/events/classes/MarkdownRendererEvent.md @@ -2,23 +2,13 @@ # Class: MarkdownRendererEvent -An event emitted at the beginning and end of the rendering process. - -## Contents +**Defined in**: [packages/typedoc-plugin-markdown/src/events/markdown-renderer-event.ts:15](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/events/markdown-renderer-event.ts#L15) -* [Extends](#extends) -* [Properties](#properties) - * [project](#project) - * [outputDirectory](#outputdirectory) - * [urls?](#urls) - * [navigation?](#navigation) -* [Events](#events) - * [BEGIN](#begin) - * [END](#end) +An event emitted at the beginning and end of the rendering process. ## Extends -* `Event` +- `Event` ## Properties @@ -26,11 +16,9 @@ An event emitted at the beginning and end of the rendering process. > `readonly` **project**: [`ProjectReflection`](https://typedoc.org/api/classes/Models.ProjectReflection.html) -The project the renderer is currently processing. - -#### Defined in +**Defined in**: [packages/typedoc-plugin-markdown/src/events/markdown-renderer-event.ts:19](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/events/markdown-renderer-event.ts#L19) -[packages/typedoc-plugin-markdown/src/events/markdown-renderer-event.ts:19](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/events/markdown-renderer-event.ts#L19) +The project the renderer is currently processing. *** @@ -38,35 +26,29 @@ The project the renderer is currently processing. > `readonly` **outputDirectory**: `string` -The path of the directory the documentation should be written to. - -#### Defined in +**Defined in**: [packages/typedoc-plugin-markdown/src/events/markdown-renderer-event.ts:24](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/events/markdown-renderer-event.ts#L24) -[packages/typedoc-plugin-markdown/src/events/markdown-renderer-event.ts:24](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/events/markdown-renderer-event.ts#L24) +The path of the directory the documentation should be written to. *** ### urls? -> `optional` **urls**: [`UrlMapping`](../../types/interfaces/UrlMapping.md)\<[`Reflection`](https://typedoc.org/api/classes/Reflection.html)>\[] - -A list of all pages that should be generated. +> `optional` **urls**: [`UrlMapping`](../../types/interfaces/UrlMapping.md)\<[`Reflection`](https://typedoc.org/api/classes/Reflection.html)\>[] -#### Defined in +**Defined in**: [packages/typedoc-plugin-markdown/src/events/markdown-renderer-event.ts:29](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/events/markdown-renderer-event.ts#L29) -[packages/typedoc-plugin-markdown/src/events/markdown-renderer-event.ts:29](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/events/markdown-renderer-event.ts#L29) +A list of all pages that should be generated. *** ### navigation? -> `optional` **navigation**: [`NavigationItem`](../../types/interfaces/NavigationItem.md)\[] - -The navigation structure of the project that can be utilised by plugins. +> `optional` **navigation**: [`NavigationItem`](../../types/interfaces/NavigationItem.md)[] -#### Defined in +**Defined in**: [packages/typedoc-plugin-markdown/src/events/markdown-renderer-event.ts:34](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/events/markdown-renderer-event.ts#L34) -[packages/typedoc-plugin-markdown/src/events/markdown-renderer-event.ts:34](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/events/markdown-renderer-event.ts#L34) +The navigation structure of the project that can be utilised by plugins. ## Events @@ -74,11 +56,9 @@ The navigation structure of the project that can be utilised by plugins. > `readonly` `static` **BEGIN**: `"beginRender"` = `'beginRender'` -Triggered before the renderer starts rendering a project. - -#### Defined in +**Defined in**: [packages/typedoc-plugin-markdown/src/events/markdown-renderer-event.ts:40](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/events/markdown-renderer-event.ts#L40) -[packages/typedoc-plugin-markdown/src/events/markdown-renderer-event.ts:40](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/events/markdown-renderer-event.ts#L40) +Triggered before the renderer starts rendering a project. *** @@ -86,8 +66,6 @@ Triggered before the renderer starts rendering a project. > `readonly` `static` **END**: `"endRender"` = `'endRender'` -Triggered after the renderer has written all documents. +**Defined in**: [packages/typedoc-plugin-markdown/src/events/markdown-renderer-event.ts:46](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/events/markdown-renderer-event.ts#L46) -#### Defined in - -[packages/typedoc-plugin-markdown/src/events/markdown-renderer-event.ts:46](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/events/markdown-renderer-event.ts#L46) +Triggered after the renderer has written all documents. diff --git a/devguide/typedoc-plugin-markdown/index/README.md b/devguide/typedoc-plugin-markdown/index/README.md deleted file mode 100644 index 7360e5454..000000000 --- a/devguide/typedoc-plugin-markdown/index/README.md +++ /dev/null @@ -1,29 +0,0 @@ -[Developer Guide](../../README.md) / [typedoc-plugin-markdown](../README.md) / index - -# index - -The plugin entrypoint and bootstrapping of the plugin. - -## load() - -> **load**(`app`): `void` - -The function that is called by TypeDoc to bootstrap the plugin. - -Here we expose additional TypeDoc options and make some adjustments. - -This method is not intended to be consumed in any other context that via the `plugin` option. - -### Parameters - -| Parameter | Type | -| --------- | ----------------------------------------------------------------- | -| `app` | [`Application`](https://typedoc.org/api/classes/Application.html) | - -### Returns - -`void` - -### Defined in - -[packages/typedoc-plugin-markdown/src/index.ts:27](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/index.ts#L27) diff --git a/devguide/typedoc-plugin-markdown/internationalization/README.md b/devguide/typedoc-plugin-markdown/internationalization/README.md index 762e05483..37073d1b2 100644 --- a/devguide/typedoc-plugin-markdown/internationalization/README.md +++ b/devguide/typedoc-plugin-markdown/internationalization/README.md @@ -8,49 +8,39 @@ The translatable strings configured in the plugin are only additional strings th To add a new locale or edit and existing locale (if you think the strings are incorrect). -## Contents - -* [Methods](#methods) - * [getTranslatable()](#gettranslatable) -* [Locales](#locales) - * [en](#en) - * [jp](#jp) - * [ko](#ko) - * [zh](#zh) - -## Methods +## Functions ### getTranslatable() > **getTranslatable**(`app`): `any` +**Defined in**: [packages/typedoc-plugin-markdown/src/internationalization/translatable.ts:16](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/internationalization/translatable.ts#L16) + 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) | +| Parameter | Type | +| ------ | ------ | +| `app` | [`Application`](https://typedoc.org/api/classes/Application.html) | #### Returns `any` -#### Defined in - -[packages/typedoc-plugin-markdown/src/internationalization/translatable.ts:16](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/internationalization/translatable.ts#L16) - ## Locales ### en > `const` **en**: [`TranslatableStrings`](../types/interfaces/TranslatableStrings.md) +**Defined in**: [packages/typedoc-plugin-markdown/src/internationalization/locales/en.ts:7](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/internationalization/locales/en.ts#L7) + Translations for 'en' locale. -#### Default Value +#### Initializer ```ts { @@ -67,6 +57,7 @@ Translations for 'en' locale. theme_member_plural: 'Members', theme_modifier: 'Modifier', theme_name: 'Name', + theme_package: 'Package', theme_packages: 'Packages', theme_type: 'Type', theme_value: 'Value', @@ -74,19 +65,17 @@ Translations for 'en' locale. } ``` -#### Defined in - -[packages/typedoc-plugin-markdown/src/internationalization/locales/en.ts:7](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/internationalization/locales/en.ts#L7) - *** ### jp -> `const` **jp**: `Partial`\<[`TranslatableStrings`](../types/interfaces/TranslatableStrings.md)> +> `const` **jp**: `Partial`\<[`TranslatableStrings`](../types/interfaces/TranslatableStrings.md)\> + +**Defined in**: [packages/typedoc-plugin-markdown/src/internationalization/locales/jp.ts:8](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/internationalization/locales/jp.ts#L8) Translations for 'jp' locale. -#### Default Value +#### Initializer ```ts { @@ -103,6 +92,7 @@ Translations for 'jp' locale. theme_member_plural: 'メンバー', theme_modifier: '修飾子', theme_name: '名前', + theme_package: 'パッケージ', theme_packages: 'パッケージ', theme_type: 'タイプ', theme_value: '値', @@ -110,19 +100,17 @@ Translations for 'jp' locale. } ``` -#### Defined in - -[packages/typedoc-plugin-markdown/src/internationalization/locales/jp.ts:8](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/internationalization/locales/jp.ts#L8) - *** ### ko -> `const` **ko**: `Partial`\<[`TranslatableStrings`](../types/interfaces/TranslatableStrings.md)> +> `const` **ko**: `Partial`\<[`TranslatableStrings`](../types/interfaces/TranslatableStrings.md)\> + +**Defined in**: [packages/typedoc-plugin-markdown/src/internationalization/locales/ko.ts:7](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/internationalization/locales/ko.ts#L7) Translations for 'ko' locale. -#### Default Value +#### Initializer ```ts { @@ -139,6 +127,7 @@ Translations for 'ko' locale. theme_member_plural: '멤버들', theme_modifier: '수정자', theme_name: '이름', + theme_package: '패키지', theme_packages: '패키지', theme_type: '유형', theme_value: '값', @@ -146,19 +135,17 @@ Translations for 'ko' locale. } ``` -#### Defined in - -[packages/typedoc-plugin-markdown/src/internationalization/locales/ko.ts:7](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/internationalization/locales/ko.ts#L7) - *** ### zh -> `const` **zh**: `Partial`\<[`TranslatableStrings`](../types/interfaces/TranslatableStrings.md)> +> `const` **zh**: `Partial`\<[`TranslatableStrings`](../types/interfaces/TranslatableStrings.md)\> + +**Defined in**: [packages/typedoc-plugin-markdown/src/internationalization/locales/zh.ts:7](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/internationalization/locales/zh.ts#L7) Translations for 'zh' locale. -#### Default Value +#### Initializer ```ts { @@ -175,13 +162,10 @@ Translations for 'zh' locale. theme_member_plural: '成员', theme_modifier: '修饰符', theme_name: '名称', + theme_package: '包', theme_packages: '包', theme_type: '类型', theme_value: '值', theme_version: '版本', } ``` - -#### Defined in - -[packages/typedoc-plugin-markdown/src/internationalization/locales/zh.ts:7](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/internationalization/locales/zh.ts#L7) diff --git a/devguide/typedoc-plugin-markdown/libs/README.md b/devguide/typedoc-plugin-markdown/libs/README.md index 99633ea87..8f18ea258 100644 --- a/devguide/typedoc-plugin-markdown/libs/README.md +++ b/devguide/typedoc-plugin-markdown/libs/README.md @@ -4,11 +4,9 @@ General pure library functions to be consumed across the plugin. -## Index +## Namespaces -### Namespaces - -| Namespace | Description | -| ----------------------------------------- | ------------------------------- | -| [markdown](namespaces/markdown/README.md) | - | -| [utils](namespaces/utils/README.md) | General utility pure functions. | +| Namespace | Description | +| ------ | ------ | +| [markdown](namespaces/markdown/README.md) | Helpers for generating markdown. | +| [utils](namespaces/utils/README.md) | General utility pure functions. | diff --git a/devguide/typedoc-plugin-markdown/libs/namespaces/markdown/README.md b/devguide/typedoc-plugin-markdown/libs/namespaces/markdown/README.md index e372eb233..c2c9a8396 100644 --- a/devguide/typedoc-plugin-markdown/libs/namespaces/markdown/README.md +++ b/devguide/typedoc-plugin-markdown/libs/namespaces/markdown/README.md @@ -2,285 +2,246 @@ # markdown -## 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() +Helpers for generating markdown. + +## Functions + +### backTicks() > **backTicks**(`text`): `string` +**Defined in**: [packages/typedoc-plugin-markdown/src/libs/markdown/back-ticks.ts:6](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/libs/markdown/back-ticks.ts#L6) + 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 +#### Parameters -| Parameter | Type | -| --------- | -------- | -| `text` | `string` | +| Parameter | Type | +| ------ | ------ | +| `text` | `string` | -### Returns +#### Returns `string` -### Defined in - -[packages/typedoc-plugin-markdown/src/libs/markdown/back-ticks.ts:7](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/libs/markdown/back-ticks.ts#L7) - *** -## blockQuoteBlock() +### blockQuoteBlock() > **blockQuoteBlock**(`content`): `string` -### Parameters +**Defined in**: [packages/typedoc-plugin-markdown/src/libs/markdown/block-quote-block.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/libs/markdown/block-quote-block.ts#L1) + +#### Parameters -| Parameter | Type | -| --------- | -------- | +| Parameter | Type | +| ------ | ------ | | `content` | `string` | -### Returns +#### Returns `string` -### Defined in - -[packages/typedoc-plugin-markdown/src/libs/markdown/block-quote-block.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/libs/markdown/block-quote-block.ts#L1) - *** -## bold() +### bold() > **bold**(`text`): `string` -### Parameters +**Defined in**: [packages/typedoc-plugin-markdown/src/libs/markdown/bold.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/libs/markdown/bold.ts#L1) -| Parameter | Type | -| --------- | -------- | -| `text` | `string` | +#### Parameters -### Returns +| Parameter | Type | +| ------ | ------ | +| `text` | `string` | -`string` +#### Returns -### Defined in - -[packages/typedoc-plugin-markdown/src/libs/markdown/bold.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/libs/markdown/bold.ts#L1) +`string` *** -## codeBlock() +### codeBlock() > **codeBlock**(`content`): `string` -### Parameters +**Defined in**: [packages/typedoc-plugin-markdown/src/libs/markdown/code-block.ts:3](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/libs/markdown/code-block.ts#L3) -| Parameter | Type | -| --------- | -------- | +#### Parameters + +| Parameter | Type | +| ------ | ------ | | `content` | `string` | -### Returns +#### Returns `string` -### Defined in - -[packages/typedoc-plugin-markdown/src/libs/markdown/code-block.ts:3](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/libs/markdown/code-block.ts#L3) - *** -## heading() +### heading() > **heading**(`level`, `text`): `string` +**Defined in**: [packages/typedoc-plugin-markdown/src/libs/markdown/heading.ts:6](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/libs/markdown/heading.ts#L6) + Returns a heading in markdown format -### Parameters +#### Parameters -| Parameter | Type | Description | -| --------- | -------- | ------------------------ | -| `level` | `number` | The level of the heading | -| `text` | `string` | The text of the heading | +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `level` | `number` | The level of the heading | +| `text` | `string` | The text of the heading | -### Returns +#### Returns `string` -### Defined in - -[packages/typedoc-plugin-markdown/src/libs/markdown/heading.ts:6](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/libs/markdown/heading.ts#L6) - *** -## horizontalRule() +### 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/main/packages/typedoc-plugin-markdown/src/libs/markdown/horizontal-rule.ts#L1) -### Defined in +#### Returns -[packages/typedoc-plugin-markdown/src/libs/markdown/horizontal-rule.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/libs/markdown/horizontal-rule.ts#L1) +`string` *** -## htmlTable() +### htmlTable() > **htmlTable**(`headers`, `rows`, `leftAlignHeadings`): `string` -### Parameters +**Defined in**: [packages/typedoc-plugin-markdown/src/libs/markdown/html-table.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/libs/markdown/html-table.ts#L1) -| Parameter | Type | Default value | -| ------------------- | -------------- | ------------- | -| `headers` | `string`\[] | `undefined` | -| `rows` | `string`\[]\[] | `undefined` | -| `leftAlignHeadings` | `boolean` | `false` | +#### Parameters -### Returns +| Parameter | Type | Default value | +| ------ | ------ | ------ | +| `headers` | `string`[] | `undefined` | +| `rows` | `string`[][] | `undefined` | +| `leftAlignHeadings` | `boolean` | `false` | -`string` +#### Returns -### Defined in - -[packages/typedoc-plugin-markdown/src/libs/markdown/html-table.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/libs/markdown/html-table.ts#L1) +`string` *** -## indentBlock() +### indentBlock() > **indentBlock**(`content`): `string` -### Parameters +**Defined in**: [packages/typedoc-plugin-markdown/src/libs/markdown/indent-block.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/libs/markdown/indent-block.ts#L1) + +#### Parameters -| Parameter | Type | -| --------- | -------- | +| Parameter | Type | +| ------ | ------ | | `content` | `string` | -### Returns +#### Returns `string` -### Defined in - -[packages/typedoc-plugin-markdown/src/libs/markdown/indent-block.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/libs/markdown/indent-block.ts#L1) - *** -## italic() +### italic() > **italic**(`text`): `string` -### Parameters +**Defined in**: [packages/typedoc-plugin-markdown/src/libs/markdown/italic.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/libs/markdown/italic.ts#L1) -| Parameter | Type | -| --------- | -------- | -| `text` | `string` | +#### Parameters -### Returns +| Parameter | Type | +| ------ | ------ | +| `text` | `string` | -`string` - -### Defined in +#### Returns -[packages/typedoc-plugin-markdown/src/libs/markdown/italic.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/libs/markdown/italic.ts#L1) +`string` *** -## link() +### link() > **link**(`label`, `url`): `string` +**Defined in**: [packages/typedoc-plugin-markdown/src/libs/markdown/link.ts:6](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/libs/markdown/link.ts#L6) + The link element -### Parameters +#### Parameters -| Parameter | Type | Description | -| --------- | ------------------ | -------------------------------- | -| `label` | `string` | The text to display for the link | -| `url` | `null` \| `string` | The url to link to | +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `label` | `string` | The text to display for the link | +| `url` | `null` \| `string` | The url to link to | -### Returns +#### Returns `string` -### Defined in - -[packages/typedoc-plugin-markdown/src/libs/markdown/link.ts:6](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/libs/markdown/link.ts#L6) - *** -## strikeThrough() +### strikeThrough() > **strikeThrough**(`content`): `string` -### Parameters +**Defined in**: [packages/typedoc-plugin-markdown/src/libs/markdown/strike-through.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/libs/markdown/strike-through.ts#L1) + +#### Parameters -| Parameter | Type | -| --------- | -------- | +| Parameter | Type | +| ------ | ------ | | `content` | `string` | -### Returns +#### Returns `string` -### Defined in - -[packages/typedoc-plugin-markdown/src/libs/markdown/strike-through.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/libs/markdown/strike-through.ts#L1) - *** -## table() +### table() > **table**(`headers`, `rows`, `headerLeftAlign`): `string` +**Defined in**: [packages/typedoc-plugin-markdown/src/libs/markdown/table.ts:7](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/libs/markdown/table.ts#L7) + Comments for table -### Parameters +#### Parameters -| Parameter | Type | Default value | -| ----------------- | -------------- | ------------- | -| `headers` | `string`\[] | `undefined` | -| `rows` | `string`\[]\[] | `undefined` | -| `headerLeftAlign` | `boolean` | `false` | +| Parameter | Type | Default value | +| ------ | ------ | ------ | +| `headers` | `string`[] | `undefined` | +| `rows` | `string`[][] | `undefined` | +| `headerLeftAlign` | `boolean` | `false` | -### Returns +#### Returns `string` -### Defined in - -[packages/typedoc-plugin-markdown/src/libs/markdown/table.ts:7](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/libs/markdown/table.ts#L7) - *** -## unorderedList() +### unorderedList() > **unorderedList**(`items`): `string` -### Parameters +**Defined in**: [packages/typedoc-plugin-markdown/src/libs/markdown/unordered-list.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/libs/markdown/unordered-list.ts#L1) -| Parameter | Type | -| --------- | ----------- | -| `items` | `string`\[] | +#### Parameters -### Returns +| Parameter | Type | +| ------ | ------ | +| `items` | `string`[] | -`string` +#### Returns -### Defined in - -[packages/typedoc-plugin-markdown/src/libs/markdown/unordered-list.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/libs/markdown/unordered-list.ts#L1) +`string` diff --git a/devguide/typedoc-plugin-markdown/libs/namespaces/utils/README.md b/devguide/typedoc-plugin-markdown/libs/namespaces/utils/README.md index 53979f99b..9493f02b9 100644 --- a/devguide/typedoc-plugin-markdown/libs/namespaces/utils/README.md +++ b/devguide/typedoc-plugin-markdown/libs/namespaces/utils/README.md @@ -4,283 +4,243 @@ General utility pure functions. -## Contents - -* [camelToTitleCase()](#cameltotitlecase) -* [encodeAngleBrackets()](#encodeanglebrackets) -* [escapeChars()](#escapechars) -* [formatMarkdown()](#formatmarkdown) -* [formatTableCell()](#formattablecell) -* [getFileNameWithExtension()](#getfilenamewithextension) -* [isQuoted()](#isquoted) -* [removeFirstScopedDirectory()](#removefirstscopeddirectory) -* [removeLineBreaks()](#removelinebreaks) -* [sanitizeComments()](#sanitizecomments) -* [slugify()](#slugify) -* [toPascalCase()](#topascalcase) -* [unEscapeChars()](#unescapechars) - -## camelToTitleCase() +## Functions -> **camelToTitleCase**(`text`): `string` +### camelToTitleCase() -### Parameters +> **camelToTitleCase**(`text`): `string` -| Parameter | Type | -| --------- | -------- | -| `text` | `string` | +**Defined in**: [packages/typedoc-plugin-markdown/src/libs/utils/camel-to-title-case.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/libs/utils/camel-to-title-case.ts#L1) -### Returns +#### Parameters -`string` +| Parameter | Type | +| ------ | ------ | +| `text` | `string` | -### Defined in +#### Returns -[packages/typedoc-plugin-markdown/src/libs/utils/camel-to-title-case.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/libs/utils/camel-to-title-case.ts#L1) +`string` *** -## encodeAngleBrackets() +### encodeAngleBrackets() > **encodeAngleBrackets**(`str`): `string` -### Parameters - -| Parameter | Type | -| --------- | -------- | -| `str` | `string` | +**Defined in**: [packages/typedoc-plugin-markdown/src/libs/utils/encode-angle-brackets.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/libs/utils/encode-angle-brackets.ts#L1) -### Returns +#### Parameters -`string` +| Parameter | Type | +| ------ | ------ | +| `str` | `string` | -### Defined in +#### Returns -[packages/typedoc-plugin-markdown/src/libs/utils/encode-angle-brackets.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/libs/utils/encode-angle-brackets.ts#L1) +`string` *** -## escapeChars() +### escapeChars() > **escapeChars**(`str`): `string` -### Parameters +**Defined in**: [packages/typedoc-plugin-markdown/src/libs/utils/escape-chars.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/libs/utils/escape-chars.ts#L1) -| Parameter | Type | -| --------- | -------- | -| `str` | `string` | +#### Parameters -### Returns +| Parameter | Type | +| ------ | ------ | +| `str` | `string` | -`string` +#### Returns -### Defined in - -[packages/typedoc-plugin-markdown/src/libs/utils/escape-chars.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/libs/utils/escape-chars.ts#L1) +`string` *** -## formatMarkdown() +### formatMarkdown() > **formatMarkdown**(`str`): `string` -### Parameters +**Defined in**: [packages/typedoc-plugin-markdown/src/libs/utils/format-markdown.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/libs/utils/format-markdown.ts#L1) -| Parameter | Type | -| --------- | -------- | -| `str` | `string` | +#### Parameters -### Returns +| Parameter | Type | +| ------ | ------ | +| `str` | `string` | -`string` - -### Defined in +#### Returns -[packages/typedoc-plugin-markdown/src/libs/utils/format-markdown.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/libs/utils/format-markdown.ts#L1) +`string` *** -## formatTableCell() +### formatTableCell() > **formatTableCell**(`str`): `string` -* Replace new lines with spaces -* Replaces code blocks with single backticks -* Replaces multiple spaces with single spaces +**Defined in**: [packages/typedoc-plugin-markdown/src/libs/utils/format-table-cell.ts:6](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/libs/utils/format-table-cell.ts#L6) -### Parameters +- Replace new lines with spaces +- Replaces code blocks with single backticks +- Replaces multiple spaces with single spaces -| Parameter | Type | -| --------- | -------- | -| `str` | `string` | +#### Parameters -### Returns - -`string` +| Parameter | Type | +| ------ | ------ | +| `str` | `string` | -### Defined in +#### Returns -[packages/typedoc-plugin-markdown/src/libs/utils/format-table-cell.ts:6](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/libs/utils/format-table-cell.ts#L6) +`string` *** -## getFileNameWithExtension() +### getFileNameWithExtension() > **getFileNameWithExtension**(`fileName`, `fileExtension`): `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/main/packages/typedoc-plugin-markdown/src/libs/utils/get-file-name-with-extension.ts#L6) + Returns a filename with extension while normalizing both the input name and input extension. -### Parameters +#### Parameters -| Parameter | Type | -| --------------- | -------- | -| `fileName` | `string` | +| Parameter | Type | +| ------ | ------ | +| `fileName` | `string` | | `fileExtension` | `string` | -### Returns +#### 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/main/packages/typedoc-plugin-markdown/src/libs/utils/get-file-name-with-extension.ts#L6) - *** -## isQuoted() +### isQuoted() > **isQuoted**(`str`): `boolean` -### Parameters - -| Parameter | Type | -| --------- | -------- | -| `str` | `string` | +**Defined in**: [packages/typedoc-plugin-markdown/src/libs/utils/is-quoted.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/libs/utils/is-quoted.ts#L1) -### Returns +#### Parameters -`boolean` +| Parameter | Type | +| ------ | ------ | +| `str` | `string` | -### Defined in +#### Returns -[packages/typedoc-plugin-markdown/src/libs/utils/is-quoted.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/libs/utils/is-quoted.ts#L1) +`boolean` *** -## removeFirstScopedDirectory() +### removeFirstScopedDirectory() > **removeFirstScopedDirectory**(`urlString`): `string` -### Parameters +**Defined in**: [packages/typedoc-plugin-markdown/src/libs/utils/remove-first-scoped-directory.ts:3](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/libs/utils/remove-first-scoped-directory.ts#L3) + +#### Parameters -| Parameter | Type | -| ----------- | -------- | +| Parameter | Type | +| ------ | ------ | | `urlString` | `string` | -### Returns +#### 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/main/packages/typedoc-plugin-markdown/src/libs/utils/remove-first-scoped-directory.ts#L3) - *** -## removeLineBreaks() +### removeLineBreaks() > **removeLineBreaks**(`str`): `string` -### Parameters +**Defined in**: [packages/typedoc-plugin-markdown/src/libs/utils/remove-line-breaks.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/libs/utils/remove-line-breaks.ts#L1) -| Parameter | Type | -| --------- | -------- | -| `str` | `string` | +#### Parameters -### Returns +| Parameter | Type | +| ------ | ------ | +| `str` | `string` | -`string` - -### Defined in +#### Returns -[packages/typedoc-plugin-markdown/src/libs/utils/remove-line-breaks.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/libs/utils/remove-line-breaks.ts#L1) +`string` *** -## sanitizeComments() +### sanitizeComments() > **sanitizeComments**(`str`): `string` -### Parameters +**Defined in**: [packages/typedoc-plugin-markdown/src/libs/utils/sanitize-comments.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/libs/utils/sanitize-comments.ts#L1) -| Parameter | Type | -| --------- | -------- | -| `str` | `string` | +#### Parameters -### Returns - -`string` +| Parameter | Type | +| ------ | ------ | +| `str` | `string` | -### Defined in +#### Returns -[packages/typedoc-plugin-markdown/src/libs/utils/sanitize-comments.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/libs/utils/sanitize-comments.ts#L1) +`string` *** -## slugify() +### slugify() > **slugify**(`url`): `string` -### Parameters - -| Parameter | Type | -| --------- | -------- | -| `url` | `string` | +**Defined in**: [packages/typedoc-plugin-markdown/src/libs/utils/slugify.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/libs/utils/slugify.ts#L1) -### Returns +#### Parameters -`string` +| Parameter | Type | +| ------ | ------ | +| `url` | `string` | -### Defined in +#### Returns -[packages/typedoc-plugin-markdown/src/libs/utils/slugify.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/libs/utils/slugify.ts#L1) +`string` *** -## toPascalCase() +### toPascalCase() > **toPascalCase**(`text`): `string` -### Parameters - -| Parameter | Type | -| --------- | -------- | -| `text` | `string` | +**Defined in**: [packages/typedoc-plugin-markdown/src/libs/utils/to-pascal-case.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/libs/utils/to-pascal-case.ts#L1) -### Returns +#### Parameters -`string` +| Parameter | Type | +| ------ | ------ | +| `text` | `string` | -### Defined in +#### Returns -[packages/typedoc-plugin-markdown/src/libs/utils/to-pascal-case.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/libs/utils/to-pascal-case.ts#L1) +`string` *** -## unEscapeChars() +### unEscapeChars() > **unEscapeChars**(`str`): `string` -### Parameters +**Defined in**: [packages/typedoc-plugin-markdown/src/libs/utils/un-escape-chars.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/libs/utils/un-escape-chars.ts#L1) -| Parameter | Type | -| --------- | -------- | -| `str` | `string` | +#### Parameters -### Returns +| Parameter | Type | +| ------ | ------ | +| `str` | `string` | -`string` +#### Returns -### Defined in - -[packages/typedoc-plugin-markdown/src/libs/utils/un-escape-chars.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/libs/utils/un-escape-chars.ts#L1) +`string` diff --git a/devguide/typedoc-plugin-markdown/options/README.md b/devguide/typedoc-plugin-markdown/options/README.md index 628dfffc7..0f3ec8fb9 100644 --- a/devguide/typedoc-plugin-markdown/options/README.md +++ b/devguide/typedoc-plugin-markdown/options/README.md @@ -4,41 +4,16 @@ Contains all the option declarations and types used in the plugin. -Options exposed to TypeDoc are added as a named export to the declarations options. +## Documents -## Contents +| Document | Description | +| ------ | ------ | +| [Adding options](documents/Adding%20options.md) | How to add new options. | -* [Index](#index) - * [Namespaces](#namespaces) +## Namespaces -## Example - -```ts -/** - * Some more detailed comments about the option. - * - * @category Display - */ -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 and categorized as per the `@category` tag. - -## Index - -### Namespaces - -| Namespace | Description | -| ------------------------------------------------- | ------------------------------------------------- | -| [constants](namespaces/constants/README.md) | Contains constant default values used in options. | -| [declarations](namespaces/declarations/README.md) | Typedoc options declarations. | -| [maps](namespaces/maps/README.md) | Maps a given value to the option type. | +| Namespace | Description | +| ------ | ------ | +| [constants](namespaces/constants/README.md) | Contains constant default values used in options. | +| [declarations](namespaces/declarations/README.md) | Typedoc options declarations. | +| [maps](namespaces/maps/README.md) | Defines option maps TypeDoc parameter Map types. | diff --git a/devguide/typedoc-plugin-markdown/options/documents/Adding options.md b/devguide/typedoc-plugin-markdown/options/documents/Adding options.md new file mode 100644 index 000000000..828af67aa --- /dev/null +++ b/devguide/typedoc-plugin-markdown/options/documents/Adding options.md @@ -0,0 +1,25 @@ +[Developer Guide](../../../README.md) / [typedoc-plugin-markdown](../../README.md) / [options](../README.md) / Adding options + +# Adding options + +Options exposed to TypeDoc are added as a named export to the `./src/options/declarations.ts` module file. + +```ts +/** + * Some more detailed comments about the option. + * + * @category Display + */ +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 and categorized as per the `@category` tag. diff --git a/devguide/typedoc-plugin-markdown/options/namespaces/constants/README.md b/devguide/typedoc-plugin-markdown/options/namespaces/constants/README.md index f51847ee3..97391007f 100644 --- a/devguide/typedoc-plugin-markdown/options/namespaces/constants/README.md +++ b/devguide/typedoc-plugin-markdown/options/namespaces/constants/README.md @@ -4,19 +4,17 @@ Contains constant default values used in options. -## Contents +## Variables -* [ALLOWED\_OWN\_FILE\_MEMBERS](#allowed_own_file_members) -* [TEXT\_CONTENT\_MAPPINGS](#text_content_mappings) -* [DEFAULT\_PAGE\_TITLES](#default_page_titles) +### ALLOWED\_OWN\_FILE\_MEMBERS -## ALLOWED\_OWN\_FILE\_MEMBERS +> `const` **ALLOWED\_OWN\_FILE\_MEMBERS**: `string`[] -> `const` **ALLOWED\_OWN\_FILE\_MEMBERS**: `string`\[] +**Defined in**: [packages/typedoc-plugin-markdown/src/options/constants.ts:12](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/options/constants.ts#L12) Default values for `membersWithOwnFile` option. -### Default Value +#### Initializer ```ts [ @@ -29,46 +27,38 @@ Default values for `membersWithOwnFile` option. ] ``` -### Defined in - -[packages/typedoc-plugin-markdown/src/options/constants.ts:12](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/options/constants.ts#L12) - *** -## TEXT\_CONTENT\_MAPPINGS +### TEXT\_CONTENT\_MAPPINGS > `const` **TEXT\_CONTENT\_MAPPINGS**: `object` -Default values for `textContentMappings` option. - -### Type declaration +**Defined in**: [packages/typedoc-plugin-markdown/src/options/constants.ts:24](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/options/constants.ts#L24) -| Name | Type | Default value | -| ------------------ | -------- | --------------------------- | -| `header.title` | `string` | '\{projectName} \{version}' | -| `breadcrumbs.home` | `string` | '\{projectName} \{version}' | -| `title.indexPage` | `string` | '\{projectName} \{version}' | -| `title.memberPage` | `string` | '\{kind}: \{name}' | -| `title.modulePage` | `string` | '\{name}' | +Default values for `textContentMappings` option. -### Defined in +#### Type declaration -[packages/typedoc-plugin-markdown/src/options/constants.ts:24](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/options/constants.ts#L24) +| Name | Type | Default value | +| ------ | ------ | ------ | +| `header.title` | `string` | '\{projectName\} \{version\}' | +| `breadcrumbs.home` | `string` | '\{projectName\} \{version\}' | +| `title.indexPage` | `string` | '\{projectName\} \{version\}' | +| `title.memberPage` | `string` | '\{kind\}: \{name\}' | +| `title.modulePage` | `string` | '\{name\}' | *** -## DEFAULT\_PAGE\_TITLES +### DEFAULT\_PAGE\_TITLES > `const` **DEFAULT\_PAGE\_TITLES**: `object` -### Type declaration - -| Name | Type | Default value | -| -------- | -------- | --------------------------- | -| `index` | `string` | '\{projectName} \{version}' | -| `member` | `string` | '\{kind}: \{name}' | -| `module` | `string` | '\{name}' | +**Defined in**: [packages/typedoc-plugin-markdown/src/options/constants.ts:32](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/options/constants.ts#L32) -### Defined in +#### Type declaration -[packages/typedoc-plugin-markdown/src/options/constants.ts:32](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/options/constants.ts#L32) +| Name | Type | Default value | +| ------ | ------ | ------ | +| `index` | `string` | '\{projectName\} \{version\}' | +| `member` | `string` | '\{kind\}: \{name\}' | +| `module` | `string` | '\{name\}' | diff --git a/devguide/typedoc-plugin-markdown/options/namespaces/declarations/README.md b/devguide/typedoc-plugin-markdown/options/namespaces/declarations/README.md index bc0060c59..b49dda75e 100644 --- a/devguide/typedoc-plugin-markdown/options/namespaces/declarations/README.md +++ b/devguide/typedoc-plugin-markdown/options/namespaces/declarations/README.md @@ -8,93 +8,40 @@ This will be exposed to TypeDoc as a new option when bootstrapping the plugin, w The JSDoc comments will also be used in the public facing documentation. -## Contents - -* [File](#file) - * [outputFileStrategy](#outputfilestrategy) - * [membersWithOwnFile](#memberswithownfile) - * [flattenOutputFiles](#flattenoutputfiles) - * [fileExtension](#fileextension) - * [entryFileName](#entryfilename) - * [modulesFileName](#modulesfilename) - * [mergeReadme](#mergereadme) - * [entryModule](#entrymodule) - * [excludeScopesInPaths](#excludescopesinpaths) -* [Display](#display) - * [hidePageHeader](#hidepageheader) - * [hideBreadcrumbs](#hidebreadcrumbs) - * [hidePageTitle](#hidepagetitle) - * [hideGroupHeadings](#hidegroupheadings) - * [useCodeBlocks](#usecodeblocks) - * [expandObjects](#expandobjects) - * [expandParameters](#expandparameters) - * [blockTagsPreserveOrder](#blocktagspreserveorder) - * [indexFormat](#indexformat) - * [parametersFormat](#parametersformat) - * [interfacePropertiesFormat](#interfacepropertiesformat) - * [classPropertiesFormat](#classpropertiesformat) - * [enumMembersFormat](#enummembersformat) - * [propertyMembersFormat](#propertymembersformat) - * [typeDeclarationFormat](#typedeclarationformat) - * [typeDeclarationVisibility](#typedeclarationvisibility) - * [tableColumnSettings](#tablecolumnsettings) -* [Utility](#utility) - * [formatWithPrettier](#formatwithprettier) - * [prettierConfigFile](#prettierconfigfile) - * [sanitizeComments](#sanitizecomments) - * [publicPath](#publicpath) - * [anchorPrefix](#anchorprefix) - * [useHTMLEncodedBrackets](#usehtmlencodedbrackets) - * [useHTMLAnchors](#usehtmlanchors) - * [preserveAnchorCasing](#preserveanchorcasing) - * [pageTitleTemplates](#pagetitletemplates) - ## File Options that are used to configure how files are output. ### outputFileStrategy -> `const` **outputFileStrategy**: `Partial`\<[`DeclarationOption`](https://typedoc.org/api/types/Configuration.DeclarationOption.html)> +> `const` **outputFileStrategy**: `Partial`\<[`DeclarationOption`](https://typedoc.org/api/types/Configuration.DeclarationOption.html)\> -TypeDoc creates documentation according to exports derived from the given [`--entryPointsStrategy`](https://typedoc.org/options/input/#entrypointstrategy) TypeDoc configuration. +**Defined in**: [packages/typedoc-plugin-markdown/src/options/declarations.ts:82](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/options/declarations.ts#L82) -This option provides some flexibility as to how output files are generated. +TypeDoc generates documentation models according to exports derived from the given +[`entryPoints`](https://typedoc.org/documents/Options.Input.html#entrypoints) and [`entryPointsStrategy`](https://typedoc.org/documents/Options.Input.html#entrypointstrategy) TypeDoc configurations. -It is also possible to further refine what members are exported to individual files with the `membersWithOwnFile` option. +This option provides some flexibility as to how files are generated by organising how these exports are organized on individual pages. +Note that each module and namespace will at a minimum have its own page. -The following keys are available: +The available keys are `"members"` (default) and `"modules"`. **"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. -``` - ├── README.md - ├── module-a/ - │ ├── classes/ - │ │ ├── ClassA.md - │ │ └── ClassB.md - │ └── functions/ - │ │ ├── FunctionA.md - │ │ └── FunctionB.md - └── module-b/ - └── classes/ - ├── ClassA.md - └── ClassB.md -``` +*See public docs for file tree example.* + + It is also possible to further refine what members are exported to individual files with the [`membersWithOwnFile`](#memberswithownfile) option. **"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. +Generates a single file for every module and namespace where all module members are hoisted to a single file. +This creates a flat navigation structure and reduces the amount of files generated. -``` - ├── README.md - ├── module-a.md - └── module-b.md -``` + *See public docs for file tree example.* -#### Default Value +#### Initializer ```ts { @@ -105,19 +52,17 @@ Generates a single file for every Module or Namespace where all members are hois } ``` -#### Defined in - -[packages/typedoc-plugin-markdown/src/options/declarations.ts:74](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/options/declarations.ts#L74) - *** ### membersWithOwnFile -> `const` **membersWithOwnFile**: `Partial`\<[`DeclarationOption`](https://typedoc.org/api/types/Configuration.DeclarationOption.html)> +> `const` **membersWithOwnFile**: `Partial`\<[`DeclarationOption`](https://typedoc.org/api/types/Configuration.DeclarationOption.html)\> + +**Defined in**: [packages/typedoc-plugin-markdown/src/options/declarations.ts:98](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/options/declarations.ts#L98) This option is useful when only specific types of members should be exported to a single file. -Ignored when `--outputFileStrategy` is equal to `"modules"` +This option only takes effect when [`outputFileStrategy`](#outputfilestrategy) is equal to `"members"` #### Example @@ -125,7 +70,7 @@ Ignored when `--outputFileStrategy` is equal to `"modules"` ["Class", "Enum", "Interface"] ``` -#### Default Value +#### Initializer ```ts { @@ -135,7 +80,7 @@ Ignored when `--outputFileStrategy` is equal to `"modules"` 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(', ')}`); + throw new Error(`'${kind}' is an invalid value for 'membersWithOwnFile'. Allowed values are: ${validValues.join(', ')}`); } } }, @@ -143,50 +88,21 @@ Ignored when `--outputFileStrategy` is equal to `"modules"` } ``` -#### Defined in - -[packages/typedoc-plugin-markdown/src/options/declarations.ts:90](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/options/declarations.ts#L90) - *** ### flattenOutputFiles -> `const` **flattenOutputFiles**: `Partial`\<[`DeclarationOption`](https://typedoc.org/api/types/Configuration.DeclarationOption.html)> +> `const` **flattenOutputFiles**: `Partial`\<[`DeclarationOption`](https://typedoc.org/api/types/Configuration.DeclarationOption.html)\> + +**Defined in**: [packages/typedoc-plugin-markdown/src/options/declarations.ts:133](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/options/declarations.ts#L133) By default output files are generated in a directory structure that mirrors the project's module hierarchy including folders for member kinds eg `classes`, `enums`, `functions` etc. This option will flatten the output files to a single directory as follows: -Default output: - -``` - ├── README.md - ├── module-a/ - │ ├── classes/ - │ │ ├── ClassA.md - │ │ └── ClassB.md - │ └── functions/ - │ │ ├── FunctionA.md - │ │ └── FunctionB.md - └── module-b/ - └── classes/ - ├── ClassA.md - └── ClassB.md -``` - -Flattened output: + *See public docs for file tree example.* -``` - ├── README.md - ├── module-a.Class.ClassA.md - ├── module-a.Class.ClassB.md - ├── module-a.Function.functionA.md - ├── module-a.Function.functionB.md - ├── module-b.Class.ClassA.md - └── module-b.Class.ClassB.md -``` - -#### Default Value +#### Initializer ```ts { @@ -196,15 +112,13 @@ Flattened output: } ``` -#### Defined in - -[packages/typedoc-plugin-markdown/src/options/declarations.ts:144](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/options/declarations.ts#L144) - *** ### fileExtension -> `const` **fileExtension**: `Partial`\<[`DeclarationOption`](https://typedoc.org/api/types/Configuration.DeclarationOption.html)> +> `const` **fileExtension**: `Partial`\<[`DeclarationOption`](https://typedoc.org/api/types/Configuration.DeclarationOption.html)\> + +**Defined in**: [packages/typedoc-plugin-markdown/src/options/declarations.ts:146](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/options/declarations.ts#L146) Typically Markdown files are recognised by the `.md` or `.markdown` file extensions.`.mdx` maybe required for compatibility with certain Markdown parsers. @@ -214,7 +128,7 @@ Typically Markdown files are recognised by the `.md` or `.markdown` file extensi ".mdx" ``` -#### Default Value +#### Initializer ```ts { @@ -229,15 +143,13 @@ Typically Markdown files are recognised by the `.md` or `.markdown` file extensi } ``` -#### Defined in - -[packages/typedoc-plugin-markdown/src/options/declarations.ts:157](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/options/declarations.ts#L157) - *** ### entryFileName -> `const` **entryFileName**: `Partial`\<[`DeclarationOption`](https://typedoc.org/api/types/Configuration.DeclarationOption.html)> +> `const` **entryFileName**: `Partial`\<[`DeclarationOption`](https://typedoc.org/api/types/Configuration.DeclarationOption.html)\> + +**Defined in**: [packages/typedoc-plugin-markdown/src/options/declarations.ts:176](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/options/declarations.ts#L176) The `entryFileName` in this context is the root page of the documentation and each module directory. This is essentially the equivalent to `index.html` for web pages. @@ -256,7 +168,7 @@ The content of root documentation file will be resolved in the following order: "index" ``` -#### Default Value +#### Initializer ```ts { @@ -266,15 +178,13 @@ The content of root documentation file will be resolved in the following order: } ``` -#### Defined in - -[packages/typedoc-plugin-markdown/src/options/declarations.ts:187](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/options/declarations.ts#L187) - *** ### modulesFileName -> `const` **modulesFileName**: `Partial`\<[`DeclarationOption`](https://typedoc.org/api/types/Configuration.DeclarationOption.html)> +> `const` **modulesFileName**: `Partial`\<[`DeclarationOption`](https://typedoc.org/api/types/Configuration.DeclarationOption.html)\> + +**Defined in**: [packages/typedoc-plugin-markdown/src/options/declarations.ts:192](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/options/declarations.ts#L192) Please note this option is not applicable when [`--readme`](https://typedoc.org/options/input/#readme) is set to "none" or `--mergeReadme` is set to "true". @@ -290,7 +200,7 @@ Please note this option is not applicable when [`--readme`](https://typedoc.org/ "modules | packages | globals" ``` -#### Default Value +#### Initializer ```ts { @@ -299,15 +209,13 @@ Please note this option is not applicable when [`--readme`](https://typedoc.org/ } ``` -#### Defined in - -[packages/typedoc-plugin-markdown/src/options/declarations.ts:203](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/options/declarations.ts#L203) - *** ### mergeReadme -> `const` **mergeReadme**: `Partial`\<[`DeclarationOption`](https://typedoc.org/api/types/Configuration.DeclarationOption.html)> +> `const` **mergeReadme**: `Partial`\<[`DeclarationOption`](https://typedoc.org/api/types/Configuration.DeclarationOption.html)\> + +**Defined in**: [packages/typedoc-plugin-markdown/src/options/declarations.ts:206](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/options/declarations.ts#L206) By default when a readme file is resolved, a separate readme page is created. @@ -315,7 +223,7 @@ This option appends the documentation main/index page to the readme page so only This option has no effect when [`--readme`](https://typedoc.org/options/input/#readme) is set to `"none"`. -#### Default Value +#### Initializer ```ts { @@ -325,15 +233,13 @@ This option has no effect when [`--readme`](https://typedoc.org/options/input/#r } ``` -#### Defined in - -[packages/typedoc-plugin-markdown/src/options/declarations.ts:217](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/options/declarations.ts#L217) - *** ### entryModule -> `const` **entryModule**: `Partial`\<[`DeclarationOption`](https://typedoc.org/api/types/Configuration.DeclarationOption.html)> +> `const` **entryModule**: `Partial`\<[`DeclarationOption`](https://typedoc.org/api/types/Configuration.DeclarationOption.html)\> + +**Defined in**: [packages/typedoc-plugin-markdown/src/options/declarations.ts:223](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/options/declarations.ts#L223) This option can be used when the root page of the documentation should be a specific module (typically a module named `index`). @@ -347,7 +253,7 @@ Please note a separate modules index page will not be generated, therefore would "index" ``` -#### Default Value +#### Initializer ```ts { @@ -356,15 +262,13 @@ Please note a separate modules index page will not be generated, therefore would } ``` -#### Defined in - -[packages/typedoc-plugin-markdown/src/options/declarations.ts:234](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/options/declarations.ts#L234) - *** ### excludeScopesInPaths -> `const` **excludeScopesInPaths**: `Partial`\<[`DeclarationOption`](https://typedoc.org/api/types/Configuration.DeclarationOption.html)> +> `const` **excludeScopesInPaths**: `Partial`\<[`DeclarationOption`](https://typedoc.org/api/types/Configuration.DeclarationOption.html)\> + +**Defined in**: [packages/typedoc-plugin-markdown/src/options/declarations.ts:255](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/options/declarations.ts#L255) By default directories are split by scopes when generating file paths. @@ -372,24 +276,17 @@ This option will remove reference to `@scope` in the path when generating files The following will be the directory structure for packages named `@scope/package-1` and `@scope/package-2`: -Output when set to `false` (default): + Output when set to `false` (default): -``` - └──@scope/ - ├── package-1/ - └── package-2/ -``` +*See public docs for file tree example.* Output when set to `true`: -``` - ├── package-1/ - └── package-2/ -``` +*See public docs for file tree example.* Ignored if `flattenOutputFiles` is set to `true`. -#### Default Value +#### Initializer ```ts { @@ -399,19 +296,17 @@ Ignored if `flattenOutputFiles` is set to `true`. } ``` -#### Defined in - -[packages/typedoc-plugin-markdown/src/options/declarations.ts:265](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/options/declarations.ts#L265) - ## Display Options that are used to configure how the output is structured and displayed. ### hidePageHeader -> `const` **hidePageHeader**: `Partial`\<[`DeclarationOption`](https://typedoc.org/api/types/Configuration.DeclarationOption.html)> +> `const` **hidePageHeader**: `Partial`\<[`DeclarationOption`](https://typedoc.org/api/types/Configuration.DeclarationOption.html)\> -#### Default Value +**Defined in**: [packages/typedoc-plugin-markdown/src/options/declarations.ts:264](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/options/declarations.ts#L264) + +#### Initializer ```ts { @@ -421,17 +316,15 @@ Options that are used to configure how the output is structured and displayed. } ``` -#### Defined in - -[packages/typedoc-plugin-markdown/src/options/declarations.ts:274](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/options/declarations.ts#L274) - *** ### hideBreadcrumbs -> `const` **hideBreadcrumbs**: `Partial`\<[`DeclarationOption`](https://typedoc.org/api/types/Configuration.DeclarationOption.html)> +> `const` **hideBreadcrumbs**: `Partial`\<[`DeclarationOption`](https://typedoc.org/api/types/Configuration.DeclarationOption.html)\> -#### Default Value +**Defined in**: [packages/typedoc-plugin-markdown/src/options/declarations.ts:273](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/options/declarations.ts#L273) + +#### Initializer ```ts { @@ -441,17 +334,15 @@ Options that are used to configure how the output is structured and displayed. } ``` -#### Defined in - -[packages/typedoc-plugin-markdown/src/options/declarations.ts:283](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/options/declarations.ts#L283) - *** ### hidePageTitle -> `const` **hidePageTitle**: `Partial`\<[`DeclarationOption`](https://typedoc.org/api/types/Configuration.DeclarationOption.html)> +> `const` **hidePageTitle**: `Partial`\<[`DeclarationOption`](https://typedoc.org/api/types/Configuration.DeclarationOption.html)\> -#### Default Value +**Defined in**: [packages/typedoc-plugin-markdown/src/options/declarations.ts:282](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/options/declarations.ts#L282) + +#### Initializer ```ts { @@ -461,21 +352,19 @@ Options that are used to configure how the output is structured and displayed. } ``` -#### Defined in - -[packages/typedoc-plugin-markdown/src/options/declarations.ts:292](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/options/declarations.ts#L292) - *** ### hideGroupHeadings -> `const` **hideGroupHeadings**: `Partial`\<[`DeclarationOption`](https://typedoc.org/api/types/Configuration.DeclarationOption.html)> +> `const` **hideGroupHeadings**: `Partial`\<[`DeclarationOption`](https://typedoc.org/api/types/Configuration.DeclarationOption.html)\> + +**Defined in**: [packages/typedoc-plugin-markdown/src/options/declarations.ts:295](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/options/declarations.ts#L295) By default members are grouped by kind (eg Classes, Functions etc). This creates a flat structure where all members are displayed at the same heading level. -#### Default Value +#### Initializer ```ts { @@ -485,15 +374,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:305](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/options/declarations.ts#L305) - *** ### useCodeBlocks -> `const` **useCodeBlocks**: `Partial`\<[`DeclarationOption`](https://typedoc.org/api/types/Configuration.DeclarationOption.html)> +> `const` **useCodeBlocks**: `Partial`\<[`DeclarationOption`](https://typedoc.org/api/types/Configuration.DeclarationOption.html)\> + +**Defined in**: [packages/typedoc-plugin-markdown/src/options/declarations.ts:321](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/options/declarations.ts#L321) This option can be used to improve readability and aesthetics when defining signatures and declarations. @@ -501,7 +388,7 @@ Please note that when this option is set to `true` it is not possible to link to As a work around the [`@link`](https://typedoc.org/tags/link/) tag can be be used to manually reference types. -#### Default Value +#### Initializer ```ts { @@ -511,21 +398,19 @@ 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:331](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/options/declarations.ts#L331) - *** ### expandObjects -> `const` **expandObjects**: `Partial`\<[`DeclarationOption`](https://typedoc.org/api/types/Configuration.DeclarationOption.html)> +> `const` **expandObjects**: `Partial`\<[`DeclarationOption`](https://typedoc.org/api/types/Configuration.DeclarationOption.html)\> -By default objects inside declarations are collapsed to preserve space and improve readability. +**Defined in**: [packages/typedoc-plugin-markdown/src/options/declarations.ts:334](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/options/declarations.ts#L334) + +By default when objects have associated documentation, object declarations are collapsed to preserve space and improve readability. This option should be set when a full object representation is preferred. -#### Default Value +#### Initializer ```ts { @@ -535,21 +420,19 @@ This option should be set when a full object representation is preferred. } ``` -#### Defined in - -[packages/typedoc-plugin-markdown/src/options/declarations.ts:344](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/options/declarations.ts#L344) - *** ### expandParameters -> `const` **expandParameters**: `Partial`\<[`DeclarationOption`](https://typedoc.org/api/types/Configuration.DeclarationOption.html)> +> `const` **expandParameters**: `Partial`\<[`DeclarationOption`](https://typedoc.org/api/types/Configuration.DeclarationOption.html)\> + +**Defined in**: [packages/typedoc-plugin-markdown/src/options/declarations.ts:347](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/options/declarations.ts#L347) By default parameters in signature definitions only display the parameter name so the output is more concise. This option should be set when a full type representation is preferred. -#### Default Value +#### Initializer ```ts { @@ -559,15 +442,13 @@ This option should be set when a full type representation is preferred. } ``` -#### Defined in - -[packages/typedoc-plugin-markdown/src/options/declarations.ts:357](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/options/declarations.ts#L357) - *** ### blockTagsPreserveOrder -> `const` **blockTagsPreserveOrder**: `Partial`\<[`DeclarationOption`](https://typedoc.org/api/types/Configuration.DeclarationOption.html)> +> `const` **blockTagsPreserveOrder**: `Partial`\<[`DeclarationOption`](https://typedoc.org/api/types/Configuration.DeclarationOption.html)\> + +**Defined in**: [packages/typedoc-plugin-markdown/src/options/declarations.ts:364](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/options/declarations.ts#L364) By default block tags (such as `@example`, `@remarks`, `@deprecated`) are rendered after "Parameters", "Returns" and "Type declaration" sections for signatures and declarations. @@ -581,7 +462,7 @@ Use this option to preserve the position of the tag content with the comment sum ["@example", "@deprecated"] ``` -#### Default Value +#### Initializer ```ts { @@ -596,25 +477,23 @@ Use this option to preserve the position of the tag content with the comment sum } ``` -#### Defined in - -[packages/typedoc-plugin-markdown/src/options/declarations.ts:374](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/options/declarations.ts#L374) - *** ### indexFormat -> `const` **indexFormat**: `Partial`\<[`DeclarationOption`](https://typedoc.org/api/types/Configuration.DeclarationOption.html)> +> `const` **indexFormat**: `Partial`\<[`DeclarationOption`](https://typedoc.org/api/types/Configuration.DeclarationOption.html)\> + +**Defined in**: [packages/typedoc-plugin-markdown/src/options/declarations.ts:390](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/options/declarations.ts#L390) 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 with key `table` - the first paragraph of the comment summary, or key `htmlTable` - the entire comment contents. -* 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 variable. +- For a **members index**, a description column will be added with key `table` - the first paragraph of the comment summary, or key `htmlTable` - the entire comment contents. +- 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 variable. -#### Default Value +#### Initializer ```ts { @@ -625,23 +504,21 @@ When table style is selected the following will be the behaviour: } ``` -#### Defined in - -[packages/typedoc-plugin-markdown/src/options/declarations.ts:400](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/options/declarations.ts#L400) - *** ### parametersFormat -> `const` **parametersFormat**: `Partial`\<[`DeclarationOption`](https://typedoc.org/api/types/Configuration.DeclarationOption.html)> +> `const` **parametersFormat**: `Partial`\<[`DeclarationOption`](https://typedoc.org/api/types/Configuration.DeclarationOption.html)\> + +**Defined in**: [packages/typedoc-plugin-markdown/src/options/declarations.ts:406](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/options/declarations.ts#L406) 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 table cells. +- **"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 table cells. -#### Default Value +#### Initializer ```ts { @@ -652,23 +529,21 @@ This option specifies the output format for parameters and type parameters of fu } ``` -#### Defined in - -[packages/typedoc-plugin-markdown/src/options/declarations.ts:416](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/options/declarations.ts#L416) - *** ### interfacePropertiesFormat -> `const` **interfacePropertiesFormat**: `Partial`\<[`DeclarationOption`](https://typedoc.org/api/types/Configuration.DeclarationOption.html)> +> `const` **interfacePropertiesFormat**: `Partial`\<[`DeclarationOption`](https://typedoc.org/api/types/Configuration.DeclarationOption.html)\> + +**Defined in**: [packages/typedoc-plugin-markdown/src/options/declarations.ts:422](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/options/declarations.ts#L422) This option specifies the output format for 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. -#### Default Value +#### Initializer ```ts { @@ -679,23 +554,21 @@ This option specifies the output format for interface properties: } ``` -#### Defined in - -[packages/typedoc-plugin-markdown/src/options/declarations.ts:432](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/options/declarations.ts#L432) - *** ### classPropertiesFormat -> `const` **classPropertiesFormat**: `Partial`\<[`DeclarationOption`](https://typedoc.org/api/types/Configuration.DeclarationOption.html)> +> `const` **classPropertiesFormat**: `Partial`\<[`DeclarationOption`](https://typedoc.org/api/types/Configuration.DeclarationOption.html)\> + +**Defined in**: [packages/typedoc-plugin-markdown/src/options/declarations.ts:438](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/options/declarations.ts#L438) This option specifies the output format for class 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. -#### Default Value +#### Initializer ```ts { @@ -706,23 +579,21 @@ This option specifies the output format for class properties: } ``` -#### Defined in - -[packages/typedoc-plugin-markdown/src/options/declarations.ts:448](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/options/declarations.ts#L448) - *** ### enumMembersFormat -> `const` **enumMembersFormat**: `Partial`\<[`DeclarationOption`](https://typedoc.org/api/types/Configuration.DeclarationOption.html)> +> `const` **enumMembersFormat**: `Partial`\<[`DeclarationOption`](https://typedoc.org/api/types/Configuration.DeclarationOption.html)\> + +**Defined in**: [packages/typedoc-plugin-markdown/src/options/declarations.ts:454](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/options/declarations.ts#L454) 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. -#### Default Value +#### Initializer ```ts { @@ -733,25 +604,23 @@ This option specifies the output format for enumeration members: } ``` -#### Defined in - -[packages/typedoc-plugin-markdown/src/options/declarations.ts:464](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/options/declarations.ts#L464) - *** ### propertyMembersFormat -> `const` **propertyMembersFormat**: `Partial`\<[`DeclarationOption`](https://typedoc.org/api/types/Configuration.DeclarationOption.html)> +> `const` **propertyMembersFormat**: `Partial`\<[`DeclarationOption`](https://typedoc.org/api/types/Configuration.DeclarationOption.html)\> + +**Defined in**: [packages/typedoc-plugin-markdown/src/options/declarations.ts:472](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/options/declarations.ts#L472) This option will handle the formatting of object literals assigned as properties in classes or interfaces. Note this options will only take effect when the property declaration is rendered in a `list` 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. +- **"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. -#### Default Value +#### Initializer ```ts { @@ -762,23 +631,21 @@ Note this options will only take effect when the property declaration is rendere } ``` -#### Defined in - -[packages/typedoc-plugin-markdown/src/options/declarations.ts:482](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/options/declarations.ts#L482) - *** ### typeDeclarationFormat -> `const` **typeDeclarationFormat**: `Partial`\<[`DeclarationOption`](https://typedoc.org/api/types/Configuration.DeclarationOption.html)> +> `const` **typeDeclarationFormat**: `Partial`\<[`DeclarationOption`](https://typedoc.org/api/types/Configuration.DeclarationOption.html)\> + +**Defined in**: [packages/typedoc-plugin-markdown/src/options/declarations.ts:488](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/options/declarations.ts#L488) This option specifies the output format for type declaration of variables and type aliases. -* **"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. -#### Default Value +#### Initializer ```ts { @@ -789,22 +656,20 @@ This option specifies the output format for type declaration of variables and ty } ``` -#### Defined in - -[packages/typedoc-plugin-markdown/src/options/declarations.ts:498](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/options/declarations.ts#L498) - *** ### typeDeclarationVisibility -> `const` **typeDeclarationVisibility**: `Partial`\<[`DeclarationOption`](https://typedoc.org/api/types/Configuration.DeclarationOption.html)> +> `const` **typeDeclarationVisibility**: `Partial`\<[`DeclarationOption`](https://typedoc.org/api/types/Configuration.DeclarationOption.html)\> + +**Defined in**: [packages/typedoc-plugin-markdown/src/options/declarations.ts:503](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/options/declarations.ts#L503) Configures the visibility level for type declaration documentation. Applies to both list and table formats. -* **"verbose"**: Provides full documentation details for all type declarations, including nested types. -* **"compact"**: Summarizes nested types as JSON, reducing verbosity while retaining key information. +- **"verbose"**: Provides full documentation details for all type declarations, including nested types. +- **"compact"**: Summarizes nested types as JSON, reducing verbosity while retaining key information. -#### Default Value +#### Initializer ```ts { @@ -815,22 +680,20 @@ Configures the visibility level for type declaration documentation. Applies to b } ``` -#### Defined in - -[packages/typedoc-plugin-markdown/src/options/declarations.ts:513](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/options/declarations.ts#L513) - *** ### tableColumnSettings -> `const` **tableColumnSettings**: `Partial`\<[`DeclarationOption`](https://typedoc.org/api/types/Configuration.DeclarationOption.html)> +> `const` **tableColumnSettings**: `Partial`\<[`DeclarationOption`](https://typedoc.org/api/types/Configuration.DeclarationOption.html)\> + +**Defined in**: [packages/typedoc-plugin-markdown/src/options/declarations.ts:530](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/options/declarations.ts#L530) By default, all available data for symbols are displayed in table columns which can result in several columns in certain use-cases. This option allows you to control the visibility of columns, prioritizing readability over displaying complete data. In addition you can control the alignment of the header text. -#### Default Value +#### Initializer ```ts { @@ -848,30 +711,28 @@ In addition you can control the alignment of the header text. } ``` -#### Defined in - -[packages/typedoc-plugin-markdown/src/options/declarations.ts:542](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/options/declarations.ts#L542) - ## Utility Options that are used for general configuration and utility purposes. ### formatWithPrettier -> `const` **formatWithPrettier**: `Partial`\<[`DeclarationOption`](https://typedoc.org/api/types/Configuration.DeclarationOption.html)> +> `const` **formatWithPrettier**: `Partial`\<[`DeclarationOption`](https://typedoc.org/api/types/Configuration.DeclarationOption.html)\> + +**Defined in**: [packages/typedoc-plugin-markdown/src/options/declarations.ts:558](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/options/declarations.ts#L558) This plugin generates well-formatted Markdown, however, integrating the popular formatting package [Prettier](https://prettier.io/) can provide additional enhancements, such as: -* Formats code inside fenced blocks using the respective Prettier configuration for that language. -* Aligns markdown table cells. -* Removes unnecessary escape characters. -* Wraps long lines of text to fit within a configurable line width. +- Formats code inside fenced blocks using the respective Prettier configuration for that language. +- Aligns markdown table cells. +- Removes unnecessary escape characters. +- Wraps long lines of text to fit within a configurable line width. Please note that Prettier is not a dependency of this plugin and must be installed in your project for this option to work. `npm i prettier --save-dev` to use this option. -#### Default Value +#### Initializer ```ts { @@ -881,15 +742,13 @@ Please note that Prettier is not a dependency of this plugin and must be install } ``` -#### Defined in - -[packages/typedoc-plugin-markdown/src/options/declarations.ts:570](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/options/declarations.ts#L570) - *** ### prettierConfigFile -> `const` **prettierConfigFile**: `Partial`\<[`DeclarationOption`](https://typedoc.org/api/types/Configuration.DeclarationOption.html)> +> `const` **prettierConfigFile**: `Partial`\<[`DeclarationOption`](https://typedoc.org/api/types/Configuration.DeclarationOption.html)\> + +**Defined in**: [packages/typedoc-plugin-markdown/src/options/declarations.ts:575](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/options/declarations.ts#L575) By default Prettier uses the options resolved from a discovered Prettier [configuration file](https://prettier.io/docs/en/configuration.html). @@ -903,7 +762,7 @@ Please note this option is only applicable when `formatWithPrettier` is set to ` "./path/to/.prettierrc.json" ``` -#### Default Value +#### Initializer ```ts { @@ -912,15 +771,13 @@ Please note this option is only applicable when `formatWithPrettier` is set to ` } ``` -#### Defined in - -[packages/typedoc-plugin-markdown/src/options/declarations.ts:587](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/options/declarations.ts#L587) - *** ### sanitizeComments -> `const` **sanitizeComments**: `Partial`\<[`DeclarationOption`](https://typedoc.org/api/types/Configuration.DeclarationOption.html)> +> `const` **sanitizeComments**: `Partial`\<[`DeclarationOption`](https://typedoc.org/api/types/Configuration.DeclarationOption.html)\> + +**Defined in**: [packages/typedoc-plugin-markdown/src/options/declarations.ts:595](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/options/declarations.ts#L595) *Please note this options does not affect the rendering of inline code or code blocks (using single/triple backticks).* @@ -930,11 +787,11 @@ This option will escape angle brackets `<` `>` and curly braces `{` `}` written This option would typically be used when source code comes from an external source 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. -#### Default Value +#### Initializer ```ts { @@ -944,15 +801,13 @@ This option would typically be used when source code comes from an external sour } ``` -#### Defined in - -[packages/typedoc-plugin-markdown/src/options/declarations.ts:607](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/options/declarations.ts#L607) - *** ### publicPath -> `const` **publicPath**: `Partial`\<[`DeclarationOption`](https://typedoc.org/api/types/Configuration.DeclarationOption.html)> +> `const` **publicPath**: `Partial`\<[`DeclarationOption`](https://typedoc.org/api/types/Configuration.DeclarationOption.html)\> + +**Defined in**: [packages/typedoc-plugin-markdown/src/options/declarations.ts:608](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/options/declarations.ts#L608) If undefined all urls will be relative. @@ -962,7 +817,7 @@ If undefined all urls will be relative. "http://abc.com" ``` -#### Default Value +#### Initializer ```ts { @@ -972,15 +827,13 @@ If undefined all urls will be relative. } ``` -#### Defined in - -[packages/typedoc-plugin-markdown/src/options/declarations.ts:620](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/options/declarations.ts#L620) - *** ### anchorPrefix -> `const` **anchorPrefix**: `Partial`\<[`DeclarationOption`](https://typedoc.org/api/types/Configuration.DeclarationOption.html)> +> `const` **anchorPrefix**: `Partial`\<[`DeclarationOption`](https://typedoc.org/api/types/Configuration.DeclarationOption.html)\> + +**Defined in**: [packages/typedoc-plugin-markdown/src/options/declarations.ts:621](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/options/declarations.ts#L621) This option should be used when parsers require a custom anchor prefix. @@ -990,7 +843,7 @@ This option should be used when parsers require a custom anchor prefix. "markdown-header" ``` -#### Default Value +#### Initializer ```ts { @@ -1000,20 +853,18 @@ This option should be used when parsers require a custom anchor prefix. } ``` -#### Defined in - -[packages/typedoc-plugin-markdown/src/options/declarations.ts:633](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/options/declarations.ts#L633) - *** ### useHTMLEncodedBrackets -> `const` **useHTMLEncodedBrackets**: `Partial`\<[`DeclarationOption`](https://typedoc.org/api/types/Configuration.DeclarationOption.html)> +> `const` **useHTMLEncodedBrackets**: `Partial`\<[`DeclarationOption`](https://typedoc.org/api/types/Configuration.DeclarationOption.html)\> + +**Defined in**: [packages/typedoc-plugin-markdown/src/options/declarations.ts:633](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/options/declarations.ts#L633) By default, opening and closing angle brackets (`<` and `>`) are escaped using backslashes, and most modern Markdown processors handle them consistently. However, using HTML entities (`<` and `>`) might be preferable to avoid any inconsistencies with some Markdown processors. -#### Default Value +#### Initializer ```ts { @@ -1023,46 +874,43 @@ However, using HTML entities (`<` and `>`) might be preferable to avoid an } ``` -#### Defined in - -[packages/typedoc-plugin-markdown/src/options/declarations.ts:645](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/options/declarations.ts#L645) - *** ### useHTMLAnchors -> `const` **useHTMLAnchors**: `Partial`\<[`DeclarationOption`](https://typedoc.org/api/types/Configuration.DeclarationOption.html)> +> `const` **useHTMLAnchors**: `Partial`\<[`DeclarationOption`](https://typedoc.org/api/types/Configuration.DeclarationOption.html)\> -This option should be used if there are issues when anchoring to symbols within a page. +**Defined in**: [packages/typedoc-plugin-markdown/src/options/declarations.ts:648](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/options/declarations.ts#L648) -* For Markdown parsers that do not automatically assign header ids. -* When cross referencing symbols that are referenced in a table row. +By default markdown parsers normally assign header IDs to headings automatically. +This is required when cross linking to symbols within a page. +This option should be used when parsers that do not automatically assign header IDs. -#### Default Value +Note that HTML anchors will be added to linkable symbols listed in table rows as there is no alternative way to anchor to these items. + +#### Initializer ```ts { - help: 'Add HTML named anchors to headings and table rows.', + help: 'Add HTML anchors to page headings.', type: ParameterType.Boolean, defaultValue: false, } ``` -#### Defined in - -[packages/typedoc-plugin-markdown/src/options/declarations.ts:659](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/options/declarations.ts#L659) - *** ### preserveAnchorCasing -> `const` **preserveAnchorCasing**: `Partial`\<[`DeclarationOption`](https://typedoc.org/api/types/Configuration.DeclarationOption.html)> +> `const` **preserveAnchorCasing**: `Partial`\<[`DeclarationOption`](https://typedoc.org/api/types/Configuration.DeclarationOption.html)\> + +**Defined in**: [packages/typedoc-plugin-markdown/src/options/declarations.ts:661](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/options/declarations.ts#L661) By default references to symbol anchor links are lowercased. This option can be used for engines that require the preservation of anchor link casing. -#### Default Value +#### Initializer ```ts { @@ -1072,15 +920,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:672](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/options/declarations.ts#L672) - *** ### pageTitleTemplates -> `const` **pageTitleTemplates**: `Partial`\<[`DeclarationOption`](https://typedoc.org/api/types/Configuration.DeclarationOption.html)> +> `const` **pageTitleTemplates**: `Partial`\<[`DeclarationOption`](https://typedoc.org/api/types/Configuration.DeclarationOption.html)\> + +**Defined in**: [packages/typedoc-plugin-markdown/src/options/declarations.ts:726](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/options/declarations.ts#L726) Customizes the page titles for index, module, and member pages in the documentation. @@ -1088,21 +934,21 @@ The option is provided as an object with keys corresponding to the page type. The Values of each key can be either: -* A function accepting input arguments. -* A strings supporting placeholders. +- A function accepting input arguments. +- A strings supporting placeholders. Available placeholders / arguments: -* `{projectName}` - the project's name resolved by TypeDoc. -* `{version}` - the project version resolved by TypeDoc (when includeVersion is `true`). -* `{kind}` - the reflection kind of the item. -* `{group}` - the group title that the item belongs to. +- `{projectName}` - the project's name resolved by TypeDoc. +- `{version}` - the project version resolved by TypeDoc (when includeVersion is `true`). +- `{kind}` - the reflection kind of the item. +- `{group}` - the group title that the item belongs to. Available keys: -* The `index` key (main documentation index page) accepts the `projectName` and `version` placeholder/args. -* The `module` key (module and namespace pages) accepts the `kind` and `name` placeholder/args. -* The `member` key (individual module member pages) accepts the `kind`, `name`, and `group` placeholder/args. +- The `index` key (main documentation index page) accepts the `projectName` and `version` placeholder/args. +- The `module` key (module and namespace pages) accepts the `kind` and `name` placeholder/args. +- The `member` key (individual module member pages) accepts the `kind`, `name`, and `group` placeholder/args. ```js filename="typedoc.cjs" pageTitleTemplates: { @@ -1112,7 +958,7 @@ pageTitleTemplates: { } ``` -#### Default Value +#### Initializer ```ts { @@ -1132,7 +978,3 @@ pageTitleTemplates: { }, } ``` - -#### Defined in - -[packages/typedoc-plugin-markdown/src/options/declarations.ts:739](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/options/declarations.ts#L739) diff --git a/devguide/typedoc-plugin-markdown/options/namespaces/maps/README.md b/devguide/typedoc-plugin-markdown/options/namespaces/maps/README.md index 24e7295d8..76e1ab304 100644 --- a/devguide/typedoc-plugin-markdown/options/namespaces/maps/README.md +++ b/devguide/typedoc-plugin-markdown/options/namespaces/maps/README.md @@ -2,14 +2,50 @@ # maps -Maps a given value to the option type. +Defines option maps TypeDoc parameter Map types. -## Index +## Enumerations -### Enumerations +### OutputFileStrategy -| Enumeration | Description | -| ---------------------------------------------------------------------- | ---------------------------------------------------------- | -| [OutputFileStrategy](enumerations/OutputFileStrategy.md) | The allowed values of the `--outputFileStrategy` option. | -| [DisplayFormat](enumerations/DisplayFormat.md) | The allowed values for formatting reflections and indexes. | -| [TypeDeclarationVisibility](enumerations/TypeDeclarationVisibility.md) | The allowed values for formatting reflections and indexes. | +**Defined in**: [packages/typedoc-plugin-markdown/src/options/maps.ts:10](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/options/maps.ts#L10) + +The allowed values of the `--outputFileStrategy` option. + +#### Enumeration Members + +| Enumeration Member | Value | +| ------ | ------ | +| `Members` | `"members"` | +| `Modules` | `"modules"` | + +*** + +### DisplayFormat + +**Defined in**: [packages/typedoc-plugin-markdown/src/options/maps.ts:18](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/options/maps.ts#L18) + +The allowed values for formatting reflections and indexes. + +#### Enumeration Members + +| Enumeration Member | Value | +| ------ | ------ | +| `List` | `"list"` | +| `Table` | `"table"` | +| `HtmlTable` | `"htmlTable"` | + +*** + +### TypeDeclarationVisibility + +**Defined in**: [packages/typedoc-plugin-markdown/src/options/maps.ts:27](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/options/maps.ts#L27) + +The allowed values for formatting reflections and indexes. + +#### Enumeration Members + +| Enumeration Member | Value | +| ------ | ------ | +| `Compact` | `"compact"` | +| `Verbose` | `"verbose"` | diff --git a/devguide/typedoc-plugin-markdown/options/namespaces/maps/enumerations/DisplayFormat.md b/devguide/typedoc-plugin-markdown/options/namespaces/maps/enumerations/DisplayFormat.md deleted file mode 100644 index 7c9560c2b..000000000 --- a/devguide/typedoc-plugin-markdown/options/namespaces/maps/enumerations/DisplayFormat.md +++ /dev/null @@ -1,13 +0,0 @@ -[Developer Guide](../../../../../README.md) / [typedoc-plugin-markdown](../../../../README.md) / [options](../../../README.md) / [maps](../README.md) / DisplayFormat - -# Enumeration: DisplayFormat - -The allowed values for formatting reflections and indexes. - -## Enumeration Members - -| Enumeration Member | Value | -| ------------------ | ------------- | -| `List` | `"list"` | -| `Table` | `"table"` | -| `HtmlTable` | `"htmlTable"` | diff --git a/devguide/typedoc-plugin-markdown/options/namespaces/maps/enumerations/OutputFileStrategy.md b/devguide/typedoc-plugin-markdown/options/namespaces/maps/enumerations/OutputFileStrategy.md deleted file mode 100644 index 6ad931634..000000000 --- a/devguide/typedoc-plugin-markdown/options/namespaces/maps/enumerations/OutputFileStrategy.md +++ /dev/null @@ -1,12 +0,0 @@ -[Developer Guide](../../../../../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/devguide/typedoc-plugin-markdown/options/namespaces/maps/enumerations/TypeDeclarationVisibility.md b/devguide/typedoc-plugin-markdown/options/namespaces/maps/enumerations/TypeDeclarationVisibility.md deleted file mode 100644 index c9b79eef3..000000000 --- a/devguide/typedoc-plugin-markdown/options/namespaces/maps/enumerations/TypeDeclarationVisibility.md +++ /dev/null @@ -1,12 +0,0 @@ -[Developer Guide](../../../../../README.md) / [typedoc-plugin-markdown](../../../../README.md) / [options](../../../README.md) / [maps](../README.md) / TypeDeclarationVisibility - -# Enumeration: TypeDeclarationVisibility - -The allowed values for formatting reflections and indexes. - -## Enumeration Members - -| Enumeration Member | Value | -| ------------------ | ----------- | -| `Compact` | `"compact"` | -| `Verbose` | `"verbose"` | diff --git a/devguide/typedoc-plugin-markdown/renderer/README.md b/devguide/typedoc-plugin-markdown/renderer/README.md index 1c1111ef8..0b3235d8a 100644 --- a/devguide/typedoc-plugin-markdown/renderer/README.md +++ b/devguide/typedoc-plugin-markdown/renderer/README.md @@ -4,61 +4,60 @@ Includes functionality and override methods on the TypeDoc Renderer. -## Contents +## Functions -* [resolvePackages()](#resolvepackages) -* [render()](#render) - -## resolvePackages() +### 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. +**Defined in**: [packages/typedoc-plugin-markdown/src/renderer/packages.ts:15](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/renderer/packages.ts#L15) -By intercepting the package options set in the converter and storing them on the renderer we can use them later in the theme. +Resolves packages meta data for the project. -### Parameters +#### Parameters -| Parameter | Type | -| ------------ | ----------------------------------------------------------------- | -| `app` | [`Application`](https://typedoc.org/api/classes/Application.html) | -| `context` | `Context` | -| `packageDir` | `string` | +| Parameter | Type | +| ------ | ------ | +| `app` | [`Application`](https://typedoc.org/api/classes/Application.html) | +| `context` | [`Context`](https://typedoc.org/api/classes/Context.html) | +| `packageDir` | `string` | -### Returns +#### Returns `void` -### Defined in +#### Remarks + +Currently options set for packages are only stored on the converter and are destroyed before being passed to the Renderer. -[packages/typedoc-plugin-markdown/src/renderer/packages.ts:11](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/renderer/packages.ts#L11) +By intercepting the package options set in the converter and storing them on the renderer we can use them later in the theme. *** -## render() +### render() -> **render**(`renderer`, `project`, `outputDirectory`): `Promise`\<`void`> +> **render**(`renderer`, `project`, `outputDirectory`): `Promise`\<`void`\> -The render method for the Markdown plugin +**Defined in**: [packages/typedoc-plugin-markdown/src/renderer/render.ts:26](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/renderer/render.ts#L26) -This is essentially a copy the default theme render method with some adjustments. +The render method for the Markdown plugin -* 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 -### Parameters +| Parameter | Type | +| ------ | ------ | +| `renderer` | [`Renderer`](https://typedoc.org/api/classes/Renderer.html) | +| `project` | [`ProjectReflection`](https://typedoc.org/api/classes/Models.ProjectReflection.html) | +| `outputDirectory` | `string` | -| Parameter | Type | -| ----------------- | ------------------------------------------------------------------------------------ | -| `renderer` | [`Renderer`](https://typedoc.org/api/classes/Renderer.html) | -| `project` | [`ProjectReflection`](https://typedoc.org/api/classes/Models.ProjectReflection.html) | -| `outputDirectory` | `string` | +#### Returns -### Returns +`Promise`\<`void`\> -`Promise`\<`void`> +#### Remarks -### Defined in +This is essentially a copy the default theme render method with some adjustments. -[packages/typedoc-plugin-markdown/src/renderer/render.ts:24](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/renderer/render.ts#L24) +- 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. diff --git a/devguide/typedoc-plugin-markdown/theme/README.md b/devguide/typedoc-plugin-markdown/theme/README.md index 4bda1d00b..b78c207bc 100644 --- a/devguide/typedoc-plugin-markdown/theme/README.md +++ b/devguide/typedoc-plugin-markdown/theme/README.md @@ -4,11 +4,15 @@ Contains all functionality relevant to the markdown theme. -## Index +## Documents -### Theme Classes +| Document | Description | +| ------ | ------ | +| [Custom Theme](documents/Custom%20Theme.md) | How to extend the default Markdown Theme. | -| Class | Description | -| ------------------------------------------------------- | ----------------------------------------------------------------------------------- | -| [MarkdownTheme](classes/MarkdownTheme.md) | The main theme class for the plugin. | +## Classes + +| Class | Description | +| ------ | ------ | +| [MarkdownTheme](classes/MarkdownTheme.md) | The main theme class for the plugin. | | [MarkdownThemeContext](classes/MarkdownThemeContext.md) | The theme context class that is provided as context on the rendering of every page. | diff --git a/devguide/typedoc-plugin-markdown/theme/classes/MarkdownTheme.md b/devguide/typedoc-plugin-markdown/theme/classes/MarkdownTheme.md index d6ae1e673..daddb712a 100644 --- a/devguide/typedoc-plugin-markdown/theme/classes/MarkdownTheme.md +++ b/devguide/typedoc-plugin-markdown/theme/classes/MarkdownTheme.md @@ -2,7 +2,7 @@ # Class: MarkdownTheme -**`Internal`** +**Defined in**: [packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts:26](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts#L26) The main theme class for the plugin. @@ -12,25 +12,9 @@ You would typically only be interested in overriding the the theme's render cont 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. -## Contents - -* [Extends](#extends) -* [Constructors](#constructors) - * [new MarkdownTheme()](#new-markdowntheme) -* [Methods](#methods) - * [render()](#render) - * [getRenderContext()](#getrendercontext) - * [getUrls()](#geturls) - * [getNavigation()](#getnavigation) - * [getTemplateMapping()](#gettemplatemapping) - * [documentTemplate()](#documenttemplate) - * [readmeTemplate()](#readmetemplate) - * [projectTemplate()](#projecttemplate) - * [reflectionTemplate()](#reflectiontemplate) - ## Extends -* [`Theme`](https://typedoc.org/api/classes/Theme.html) +- [`Theme`](https://typedoc.org/api/classes/Theme.html) ## Constructors @@ -38,10 +22,12 @@ The API follows the implementation of [TypeDoc's custom theming](https://github. > **new MarkdownTheme**(`renderer`): [`MarkdownTheme`](MarkdownTheme.md) +**Defined in**: [packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts:27](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts#L27) + #### Parameters -| Parameter | Type | -| ---------- | ----------------------------------------------------------- | +| Parameter | Type | +| ------ | ------ | | `renderer` | [`Renderer`](https://typedoc.org/api/classes/Renderer.html) | #### Returns @@ -52,26 +38,22 @@ The API follows the implementation of [TypeDoc's custom theming](https://github. `Theme.constructor` -#### Defined in - -[packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts:31](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts#L31) - ## Methods ### render() > **render**(`page`, `template`): `string` -**`Internal`** +**Defined in**: [packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts:34](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts#L34) Renders a template and page model to a string. #### Parameters -| Parameter | Type | -| ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `page` | [`MarkdownPageEvent`](../../events/classes/MarkdownPageEvent.md)\<[`Reflection`](https://typedoc.org/api/classes/Reflection.html)> | -| `template` | [`RenderTemplate`](../../types/type-aliases/RenderTemplate.md)\<[`MarkdownPageEvent`](../../events/classes/MarkdownPageEvent.md)\<[`Reflection`](https://typedoc.org/api/classes/Reflection.html)>> | +| Parameter | Type | +| ------ | ------ | +| `page` | [`MarkdownPageEvent`](../../events/classes/MarkdownPageEvent.md) | +| `template` | [`RenderTemplate`](../../types/README.md#rendertemplatet)\<[`MarkdownPageEvent`](../../events/classes/MarkdownPageEvent.md)\> | #### Returns @@ -81,81 +63,71 @@ Renders a template and page model to a string. `Theme.render` -#### Defined in - -[packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts:40](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts#L40) - *** ### getRenderContext() > **getRenderContext**(`page`): [`MarkdownThemeContext`](MarkdownThemeContext.md) +**Defined in**: [packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts:51](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts#L51) + 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`](../../events/classes/MarkdownPageEvent.md)\<[`Reflection`](https://typedoc.org/api/classes/Reflection.html)> | +| Parameter | Type | +| ------ | ------ | +| `page` | [`MarkdownPageEvent`](../../events/classes/MarkdownPageEvent.md) | #### Returns [`MarkdownThemeContext`](MarkdownThemeContext.md) -#### Defined in - -[packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts:57](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts#L57) - *** ### getUrls() -> **getUrls**(`project`): [`UrlMapping`](../../types/interfaces/UrlMapping.md)\<[`Reflection`](https://typedoc.org/api/classes/Reflection.html)>\[] +> **getUrls**(`project`): [`UrlMapping`](../../types/interfaces/UrlMapping.md)\<[`Reflection`](https://typedoc.org/api/classes/Reflection.html)\>[] + +**Defined in**: [packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts:58](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts#L58) Maps the models of the given project to the desired output files. #### Parameters -| Parameter | Type | -| --------- | ------------------------------------------------------------------------------------ | +| Parameter | Type | +| ------ | ------ | | `project` | [`ProjectReflection`](https://typedoc.org/api/classes/Models.ProjectReflection.html) | #### Returns -[`UrlMapping`](../../types/interfaces/UrlMapping.md)\<[`Reflection`](https://typedoc.org/api/classes/Reflection.html)>\[] +[`UrlMapping`](../../types/interfaces/UrlMapping.md)\<[`Reflection`](https://typedoc.org/api/classes/Reflection.html)\>[] #### Overrides `Theme.getUrls` -#### Defined in - -[packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts:64](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts#L64) - *** ### getNavigation() -> **getNavigation**(`project`): [`NavigationItem`](../../types/interfaces/NavigationItem.md)\[] +> **getNavigation**(`project`): [`NavigationItem`](../../types/interfaces/NavigationItem.md)[] + +**Defined in**: [packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts:65](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts#L65) Map the models of the given project to a navigation structure. #### Parameters -| Parameter | Type | -| --------- | ------------------------------------------------------------------------------------ | +| Parameter | Type | +| ------ | ------ | | `project` | [`ProjectReflection`](https://typedoc.org/api/classes/Models.ProjectReflection.html) | #### Returns -[`NavigationItem`](../../types/interfaces/NavigationItem.md)\[] - -#### Defined in - -[packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts:71](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts#L71) +[`NavigationItem`](../../types/interfaces/NavigationItem.md)[] *** @@ -163,107 +135,89 @@ Map the models of the given project to a navigation structure. > **getTemplateMapping**(`kind`, `outputFileStrategy`?): `any` -**`Internal`** +**Defined in**: [packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts:72](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts#L72) + +Returns the template mapping for a given reflection kind. #### Parameters -| Parameter | Type | -| --------------------- | ---------------------------------------------------------------------------------------- | -| `kind` | [`ReflectionKind`](https://typedoc.org/api/enums/Models.ReflectionKind-1.html) | -| `outputFileStrategy`? | [`OutputFileStrategy`](../../options/namespaces/maps/enumerations/OutputFileStrategy.md) | +| Parameter | Type | +| ------ | ------ | +| `kind` | [`ReflectionKind`](https://typedoc.org/api/enums/Models.ReflectionKind-1.html) | +| `outputFileStrategy`? | [`OutputFileStrategy`](../../options/namespaces/maps/README.md#outputfilestrategy) | #### Returns `any` -#### Defined in - -[packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts:78](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts#L78) - *** ### documentTemplate() > **documentTemplate**(`page`): `string` -**`Internal`** +**Defined in**: [packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts:193](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts#L193) #### Parameters -| Parameter | Type | -| --------- | --------------------------------------------------------------------------------------- | -| `page` | [`MarkdownPageEvent`](../../events/classes/MarkdownPageEvent.md)\<`DocumentReflection`> | +| Parameter | Type | +| ------ | ------ | +| `page` | [`MarkdownPageEvent`](../../events/classes/MarkdownPageEvent.md)\<`DocumentReflection`\> | #### Returns `string` -#### Defined in - -[packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts:202](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts#L202) - *** ### readmeTemplate() > **readmeTemplate**(`page`): `string` -**`Internal`** +**Defined in**: [packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts:197](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts#L197) #### Parameters -| Parameter | Type | -| --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `page` | [`MarkdownPageEvent`](../../events/classes/MarkdownPageEvent.md)\<[`ProjectReflection`](https://typedoc.org/api/classes/Models.ProjectReflection.html)> | +| Parameter | Type | +| ------ | ------ | +| `page` | [`MarkdownPageEvent`](../../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:209](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts#L209) - *** ### projectTemplate() > **projectTemplate**(`page`): `string` -**`Internal`** +**Defined in**: [packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts:201](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts#L201) #### Parameters -| Parameter | Type | -| --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `page` | [`MarkdownPageEvent`](../../events/classes/MarkdownPageEvent.md)\<[`ProjectReflection`](https://typedoc.org/api/classes/Models.ProjectReflection.html)> | +| Parameter | Type | +| ------ | ------ | +| `page` | [`MarkdownPageEvent`](../../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:216](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts#L216) - *** ### reflectionTemplate() > **reflectionTemplate**(`page`): `string` -**`Internal`** +**Defined in**: [packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts:205](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts#L205) #### Parameters -| Parameter | Type | -| --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `page` | [`MarkdownPageEvent`](../../events/classes/MarkdownPageEvent.md)\<[`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html)> | +| Parameter | Type | +| ------ | ------ | +| `page` | [`MarkdownPageEvent`](../../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:223](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts#L223) diff --git a/devguide/typedoc-plugin-markdown/theme/classes/MarkdownThemeContext.md b/devguide/typedoc-plugin-markdown/theme/classes/MarkdownThemeContext.md index fd37e1677..49b609216 100644 --- a/devguide/typedoc-plugin-markdown/theme/classes/MarkdownThemeContext.md +++ b/devguide/typedoc-plugin-markdown/theme/classes/MarkdownThemeContext.md @@ -2,7 +2,7 @@ # Class: MarkdownThemeContext -**`Internal`** +**Defined in**: [packages/typedoc-plugin-markdown/src/theme/markdown-themeContext.ts:35](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/theme/markdown-themeContext.ts#L35) The theme context class that is provided as context on the rendering of every page. @@ -10,133 +10,26 @@ It is heavily influenced by the equivalent [DefaultThemeRenderContext](https://t This class can be used to customize the theme output by extending the class and overriding the templates, partials and helpers. -## Contents - -* [Constructors](#constructors) - * [new MarkdownThemeContext()](#new-markdownthemecontext) -* [Properties](#properties) - * [internationalization](#internationalization) - * [i18n](#i18n) - * [theme](#theme) - * [page](#page) - * [options](#options) - * [packagesMetaData](#packagesmetadata) - * [hook()](#hook) - * [Type Parameters](#type-parameters) -* [Methods](#methods) - * [getPackageMetaData()](#getpackagemetadata) - * [getRelativeUrl()](#getrelativeurl) -* [Resources](#resources) - * [templates](#templates) - * [document()](#document) - * [project()](#project) - * [readme()](#readme) - * [reflection()](#reflection) - * [partials](#partials) - * [comment()](#comment) - * [body()](#body) - * [categories()](#categories) - * [groups()](#groups) - * [members()](#members) - * [accessor()](#accessor) - * [constructor()](#constructor) - * [memberContainer()](#membercontainer) - * [declaration()](#declaration) - * [declarationTitle()](#declarationtitle) - * [documents()](#documents) - * [enumMembersTable()](#enummemberstable) - * [hierarchy()](#hierarchy) - * [indexSignature()](#indexsignature) - * [inheritance()](#inheritance) - * [memberTitle()](#membertitle) - * [memberWithGroups()](#memberwithgroups) - * [parametersList()](#parameterslist) - * [parametersTable()](#parameterstable) - * [propertiesTable()](#propertiestable) - * [referenceMember()](#referencemember) - * [reflectionIndex()](#reflectionindex) - * [signature()](#signature) - * [signatureParameters()](#signatureparameters) - * [signatureReturns()](#signaturereturns) - * [signatureTitle()](#signaturetitle) - * [signatures()](#signatures) - * [sources()](#sources) - * [member()](#member) - * [typeAndParent()](#typeandparent) - * [typeArguments()](#typearguments) - * [typeDeclaration()](#typedeclaration) - * [typeDeclarationContainer()](#typedeclarationcontainer) - * [typeDeclarationList()](#typedeclarationlist) - * [typeDeclarationTable()](#typedeclarationtable) - * [typeParametersList()](#typeparameterslist) - * [typeParametersTable()](#typeparameterstable) - * [breadcrumbs()](#breadcrumbs) - * [footer()](#footer) - * [header()](#header) - * [packagesIndex()](#packagesindex) - * [pageTitle()](#pagetitle) - * [arrayType()](#arraytype) - * [conditionalType()](#conditionaltype) - * [indexAccessType()](#indexaccesstype) - * [inferredType()](#inferredtype) - * [intersectionType()](#intersectiontype) - * [intrinsicType()](#intrinsictype) - * [literalType()](#literaltype) - * [namedTupleType()](#namedtupletype) - * [optionalType()](#optionaltype) - * [queryType()](#querytype) - * [referenceType()](#referencetype) - * [declarationType()](#declarationtype) - * [functionType()](#functiontype) - * [reflectionType()](#reflectiontype) - * [someType()](#sometype) - * [tupleType()](#tupletype) - * [typeOperatorType()](#typeoperatortype) - * [unionType()](#uniontype) - * [unknownType()](#unknowntype) - * [helpers](#helpers) - * [getAngleBracket()](#getanglebracket) - * [getCommentParts()](#getcommentparts) - * [getDeclarationType()](#getdeclarationtype) - * [getDescriptionForComment()](#getdescriptionforcomment) - * [getFlattenedDeclarations()](#getflatteneddeclarations) - * [getGroupIndexList()](#getgroupindexlist) - * [getGroupIndexTable()](#getgroupindextable) - * [getGroupIndex()](#getgroupindex) - * [getHierarchyType()](#gethierarchytype) - * [getKeyword()](#getkeyword) - * [getModifier()](#getmodifier) - * [getParameterDefaultValue()](#getparameterdefaultvalue) - * [getProjectName()](#getprojectname) - * [getPropertyDefaultValue()](#getpropertydefaultvalue) - * [getReflectionFlags()](#getreflectionflags) - * [getReturnType()](#getreturntype) - * [hasUsefulTypeDetails()](#hasusefultypedetails) - * [isGroupKind()](#isgroupkind) - * [useTableFormat()](#usetableformat) - ## Constructors ### new MarkdownThemeContext() > **new MarkdownThemeContext**(`theme`, `page`, `options`): [`MarkdownThemeContext`](MarkdownThemeContext.md) +**Defined in**: [packages/typedoc-plugin-markdown/src/theme/markdown-themeContext.ts:42](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/theme/markdown-themeContext.ts#L42) + #### Parameters -| Parameter | Type | Description | -| --------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------- | -| `theme` | [`MarkdownTheme`](MarkdownTheme.md) | The theme instance. | -| `page` | [`MarkdownPageEvent`](../../events/classes/MarkdownPageEvent.md)\<[`Reflection`](https://typedoc.org/api/classes/Reflection.html)> | The current page event. | -| `options` | [`Options`](https://typedoc.org/api/types/Configuration.Options.html) | The options provided to the application. | +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `theme` | [`MarkdownTheme`](MarkdownTheme.md) | The theme instance. | +| `page` | [`MarkdownPageEvent`](../../events/classes/MarkdownPageEvent.md) | The current page event. | +| `options` | [`Options`](https://typedoc.org/api/types/Configuration.Options.html) | The options provided to the application. | #### Returns [`MarkdownThemeContext`](MarkdownThemeContext.md) -#### Defined in - -[packages/typedoc-plugin-markdown/src/theme/markdown-themeContext.ts:46](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/theme/markdown-themeContext.ts#L46) - ## Properties Properties are passed into the constructor and are used to provide context to the theme. @@ -145,9 +38,7 @@ Properties are passed into the constructor and are used to provide context to th > **internationalization**: `Internationalization` -#### Defined in - -[packages/typedoc-plugin-markdown/src/theme/markdown-themeContext.ts:40](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/theme/markdown-themeContext.ts#L40) +**Defined in**: [packages/typedoc-plugin-markdown/src/theme/markdown-themeContext.ts:36](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/theme/markdown-themeContext.ts#L36) *** @@ -155,9 +46,7 @@ Properties are passed into the constructor and are used to provide context to th > **i18n**: `TranslationProxy` -#### Defined in - -[packages/typedoc-plugin-markdown/src/theme/markdown-themeContext.ts:41](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/theme/markdown-themeContext.ts#L41) +**Defined in**: [packages/typedoc-plugin-markdown/src/theme/markdown-themeContext.ts:37](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/theme/markdown-themeContext.ts#L37) *** @@ -165,23 +54,19 @@ Properties are passed into the constructor and are used to provide context to th > `private` **theme**: [`MarkdownTheme`](MarkdownTheme.md) -The theme instance. - -#### Defined in +**Defined in**: [packages/typedoc-plugin-markdown/src/theme/markdown-themeContext.ts:46](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/theme/markdown-themeContext.ts#L46) -[packages/typedoc-plugin-markdown/src/theme/markdown-themeContext.ts:50](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/theme/markdown-themeContext.ts#L50) +The theme instance. *** ### page -> `readonly` **page**: [`MarkdownPageEvent`](../../events/classes/MarkdownPageEvent.md)\<[`Reflection`](https://typedoc.org/api/classes/Reflection.html)> +> `readonly` **page**: [`MarkdownPageEvent`](../../events/classes/MarkdownPageEvent.md) -The current page event. +**Defined in**: [packages/typedoc-plugin-markdown/src/theme/markdown-themeContext.ts:50](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/theme/markdown-themeContext.ts#L50) -#### Defined in - -[packages/typedoc-plugin-markdown/src/theme/markdown-themeContext.ts:54](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/theme/markdown-themeContext.ts#L54) +The current page event. *** @@ -189,33 +74,29 @@ The current page event. > `readonly` **options**: [`Options`](https://typedoc.org/api/types/Configuration.Options.html) -The options provided to the application. +**Defined in**: [packages/typedoc-plugin-markdown/src/theme/markdown-themeContext.ts:54](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/theme/markdown-themeContext.ts#L54) -#### Defined in - -[packages/typedoc-plugin-markdown/src/theme/markdown-themeContext.ts:58](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/theme/markdown-themeContext.ts#L58) +The options provided to the application. *** ### packagesMetaData -> `private` **packagesMetaData**: `Record`\<`string`, [`PackageMetaData`](../../types/interfaces/PackageMetaData.md)> +> `private` **packagesMetaData**: `Record`\<`string`, [`PackageMetaData`](../../types/interfaces/PackageMetaData.md)\> + +**Defined in**: [packages/typedoc-plugin-markdown/src/theme/markdown-themeContext.ts:68](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/theme/markdown-themeContext.ts#L68) 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-themeContext.ts:72](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/theme/markdown-themeContext.ts#L72) - *** ### hook() -> **hook**: \<`K`>(`event`, ...`args`) => `string`\[] +> **hook**: \<`K`\>(`event`, ...`args`) => `string`[] -**`Internal`** +**Defined in**: [packages/typedoc-plugin-markdown/src/theme/markdown-themeContext.ts:168](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/theme/markdown-themeContext.ts#L168) Hook into the TypeDoc rendering system. @@ -223,24 +104,20 @@ Emits an event to all currently subscribed listeners. #### Type Parameters -| Type Parameter | -| ---------------------------------------------------------------------------------------------- | +| Type Parameter | +| ------ | | `K` *extends* keyof [`MarkdownRendererHooks`](../../types/interfaces/MarkdownRendererHooks.md) | #### Parameters -| Parameter | Type | Description | -| --------- | -------------------------------------------------------------------------------- | ------------------------------------- | -| `event` | `K` | the event to emit. | -| ...`args` | [`MarkdownRendererHooks`](../../types/interfaces/MarkdownRendererHooks.md)\[`K`] | any arguments required for the event. | +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `event` | `K` | the event to emit. | +| ...`args` | [`MarkdownRendererHooks`](../../types/interfaces/MarkdownRendererHooks.md)\[`K`\] | any arguments required for the event. | #### Returns -`string`\[] - -#### Defined in - -[packages/typedoc-plugin-markdown/src/theme/markdown-themeContext.ts:167](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/theme/markdown-themeContext.ts#L167) +`string`[] ## Methods @@ -248,25 +125,35 @@ General context aware helper methods not bound to any specific models that can b ### getPackageMetaData() -> **getPackageMetaData**(`packageName`): `undefined` | [`PackageMetaData`](../../types/interfaces/PackageMetaData.md) +> **getPackageMetaData**(`packageName`): `undefined` \| [`PackageMetaData`](../../types/interfaces/PackageMetaData.md) -**`Internal`** +**Defined in**: [packages/typedoc-plugin-markdown/src/theme/markdown-themeContext.ts:116](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/theme/markdown-themeContext.ts#L116) Returns the package meta data for a given package name when entrypointStrategy is set to `packages`. #### Parameters -| Parameter | Type | Description | -| ------------- | -------- | --------------------------------------------------------- | +| Parameter | Type | Description | +| ------ | ------ | ------ | | `packageName` | `string` | The package name as per `name` field from `package.json`. | #### Returns -`undefined` | [`PackageMetaData`](../../types/interfaces/PackageMetaData.md) +`undefined` \| [`PackageMetaData`](../../types/interfaces/PackageMetaData.md) + +*** + +### getPackagesCount() + +> **getPackagesCount**(): `number` -#### Defined in +**Defined in**: [packages/typedoc-plugin-markdown/src/theme/markdown-themeContext.ts:123](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/theme/markdown-themeContext.ts#L123) -[packages/typedoc-plugin-markdown/src/theme/markdown-themeContext.ts:122](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/theme/markdown-themeContext.ts#L122) +Return the number of packages in the project. + +#### Returns + +`number` *** @@ -274,25 +161,23 @@ Returns the package meta data for a given package name when entrypointStrategy i > **getRelativeUrl**(`url`, `ignorePublicPath`): `string` +**Defined in**: [packages/typedoc-plugin-markdown/src/theme/markdown-themeContext.ts:137](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/theme/markdown-themeContext.ts#L137) + 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. | +| 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-themeContext.ts:134](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/theme/markdown-themeContext.ts#L134) - ## Resources Theme resources are the main building blocks for the theme context. They are split into three namespaces: `templates`, `partials` and `helpers`. @@ -301,6 +186,8 @@ Theme resources are the main building blocks for the theme context. They are spl > **templates**: `object` +**Defined in**: [packages/typedoc-plugin-markdown/src/theme/markdown-themeContext.ts:76](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/theme/markdown-themeContext.ts#L76) + 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. @@ -313,9 +200,9 @@ Template that maps to a project document. ##### Parameters -| Parameter | Type | -| --------- | --------------------------------------------------------------------------------------- | -| `page` | [`MarkdownPageEvent`](../../events/classes/MarkdownPageEvent.md)\<`DocumentReflection`> | +| Parameter | Type | +| ------ | ------ | +| `page` | [`MarkdownPageEvent`](../../events/classes/MarkdownPageEvent.md)\<`DocumentReflection`\> | ##### Returns @@ -329,9 +216,9 @@ Template that maps to the root project reflection. This will be the index page / ##### Parameters -| Parameter | Type | -| --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `page` | [`MarkdownPageEvent`](../../events/classes/MarkdownPageEvent.md)\<[`ProjectReflection`](https://typedoc.org/api/classes/Models.ProjectReflection.html)> | +| Parameter | Type | +| ------ | ------ | +| `page` | [`MarkdownPageEvent`](../../events/classes/MarkdownPageEvent.md)\<[`ProjectReflection`](https://typedoc.org/api/classes/Models.ProjectReflection.html)\> | ##### Returns @@ -345,9 +232,9 @@ Template that specifically maps to the resolved readme file. This template is no ##### Parameters -| Parameter | Type | -| --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `page` | [`MarkdownPageEvent`](../../events/classes/MarkdownPageEvent.md)\<[`ProjectReflection`](https://typedoc.org/api/classes/Models.ProjectReflection.html)> | +| Parameter | Type | +| ------ | ------ | +| `page` | [`MarkdownPageEvent`](../../events/classes/MarkdownPageEvent.md)\<[`ProjectReflection`](https://typedoc.org/api/classes/Models.ProjectReflection.html)\> | ##### Returns @@ -361,39 +248,37 @@ Template that maps to individual reflection models. ##### Parameters -| Parameter | Type | -| --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `page` | [`MarkdownPageEvent`](../../events/classes/MarkdownPageEvent.md)\<[`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html)> | +| Parameter | Type | +| ------ | ------ | +| `page` | [`MarkdownPageEvent`](../../events/classes/MarkdownPageEvent.md)\<[`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html)\> | ##### Returns `string` -#### Defined in - -[packages/typedoc-plugin-markdown/src/theme/markdown-themeContext.ts:80](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/theme/markdown-themeContext.ts#L80) - *** ### partials > **partials**: `object` +**Defined in**: [packages/typedoc-plugin-markdown/src/theme/markdown-themeContext.ts:96](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/theme/markdown-themeContext.ts#L96) + 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. +- 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. +- 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() @@ -401,15 +286,15 @@ Partials are categorised by their use: ##### Parameters -| Parameter | Type | -| ------------------------ | -------------------------------------------------------------------------------------------------------------------------------- | -| `model` | [`Comment`](https://typedoc.org/api/classes/Models.Comment.html) | -| `options` | \{`headingLevel`: `number`;`showSummary`: `boolean`;`showTags`: `boolean`;`showReturns`: `boolean`;`isTableColumn`: `boolean`; } | -| `options.headingLevel`? | `number` | -| `options.showSummary`? | `boolean` | -| `options.showTags`? | `boolean` | -| `options.showReturns`? | `boolean` | -| `options.isTableColumn`? | `boolean` | +| Parameter | Type | +| ------ | ------ | +| `model` | [`Comment`](https://typedoc.org/api/classes/Models.Comment.html) | +| `options` | \{ `headingLevel`: `number`; `showSummary`: `boolean`; `showTags`: `boolean`; `showReturns`: `boolean`; `isTableColumn`: `boolean`; \} | +| `options.headingLevel`? | `number` | +| `options.showSummary`? | `boolean` | +| `options.showTags`? | `boolean` | +| `options.showReturns`? | `boolean` | +| `options.isTableColumn`? | `boolean` | ##### Returns @@ -421,11 +306,11 @@ Partials are categorised by their use: ##### Parameters -| Parameter | Type | -| ---------------------- | ---------------------------------------------------------------------------------------- | -| `model` | [`ContainerReflection`](https://typedoc.org/api/classes/Models.ContainerReflection.html) | -| `options` | \{`headingLevel`: `number`; } | -| `options.headingLevel` | `number` | +| Parameter | Type | +| ------ | ------ | +| `model` | [`ContainerReflection`](https://typedoc.org/api/classes/Models.ContainerReflection.html) | +| `options` | \{ `headingLevel`: `number`; \} | +| `options.headingLevel` | `number` | ##### Returns @@ -437,11 +322,11 @@ Partials are categorised by their use: ##### Parameters -| Parameter | Type | -| ---------------------- | -------------------------------------------------------------------------------------------------- | -| `model` | [`ReflectionCategory`](https://typedoc.org/api/types/ReflectionCategory.DeclarationOption.html)\[] | -| `options` | \{`headingLevel`: `number`; } | -| `options.headingLevel` | `number` | +| Parameter | Type | +| ------ | ------ | +| `model` | [`ReflectionCategory`](https://typedoc.org/api/types/ReflectionCategory.DeclarationOption.html)[] | +| `options` | \{ `headingLevel`: `number`; \} | +| `options.headingLevel` | `number` | ##### Returns @@ -453,12 +338,12 @@ Partials are categorised by their use: ##### Parameters -| Parameter | Type | -| ---------------------- | -------------------------------------------------------------------------------------------------------------------- | -| `model` | [`ReflectionGroup`](https://typedoc.org/api/classes/ReflectionGroup.html)\[] | -| `options` | \{`headingLevel`: `number`;`kind`: [`ReflectionKind`](https://typedoc.org/api/enums/Models.ReflectionKind-1.html); } | -| `options.headingLevel` | `number` | -| `options.kind` | [`ReflectionKind`](https://typedoc.org/api/enums/Models.ReflectionKind-1.html) | +| Parameter | Type | +| ------ | ------ | +| `model` | [`ReflectionGroup`](https://typedoc.org/api/classes/ReflectionGroup.html)[] | +| `options` | \{ `headingLevel`: `number`; `kind`: [`ReflectionKind`](https://typedoc.org/api/enums/Models.ReflectionKind-1.html); \} | +| `options.headingLevel` | `number` | +| `options.kind` | [`ReflectionKind`](https://typedoc.org/api/enums/Models.ReflectionKind-1.html) | ##### Returns @@ -470,12 +355,12 @@ Partials are categorised by their use: ##### Parameters -| Parameter | Type | -| ---------------------- | ----------------------------------------------------------------------------------------------- | -| `model` | [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html)\[] | -| `options` | \{`headingLevel`: `number`;`groupTitle`: `string`; } | -| `options.headingLevel` | `number` | -| `options.groupTitle`? | `string` | +| Parameter | Type | +| ------ | ------ | +| `model` | [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html)[] | +| `options` | \{ `headingLevel`: `number`; `groupTitle`: `string`; \} | +| `options.headingLevel` | `number` | +| `options.groupTitle`? | `string` | ##### Returns @@ -487,11 +372,11 @@ Partials are categorised by their use: ##### Parameters -| Parameter | Type | -| ---------------------- | -------------------------------------------------------------------------------------------- | -| `model` | [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html) | -| `options` | \{`headingLevel`: `number`; } | -| `options.headingLevel` | `number` | +| Parameter | Type | +| ------ | ------ | +| `model` | [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html) | +| `options` | \{ `headingLevel`: `number`; \} | +| `options.headingLevel` | `number` | ##### Returns @@ -503,11 +388,11 @@ Partials are categorised by their use: ##### Parameters -| Parameter | Type | -| ---------------------- | -------------------------------------------------------------------------------------------- | -| `model` | [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html) | -| `options` | \{`headingLevel`: `number`; } | -| `options.headingLevel` | `number` | +| Parameter | Type | +| ------ | ------ | +| `model` | [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html) | +| `options` | \{ `headingLevel`: `number`; \} | +| `options.headingLevel` | `number` | ##### Returns @@ -519,13 +404,13 @@ Partials are categorised by their use: ##### Parameters -| Parameter | Type | -| ---------------------- | -------------------------------------------------------------------------------------------- | -| `model` | [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html) | -| `options` | \{`headingLevel`: `number`;`nested`: `boolean`;`groupTitle`: `string`; } | -| `options.headingLevel` | `number` | -| `options.nested`? | `boolean` | -| `options.groupTitle`? | `string` | +| Parameter | Type | +| ------ | ------ | +| `model` | [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html) | +| `options` | \{ `headingLevel`: `number`; `nested`: `boolean`; `groupTitle`: `string`; \} | +| `options.headingLevel` | `number` | +| `options.nested`? | `boolean` | +| `options.groupTitle`? | `string` | ##### Returns @@ -537,12 +422,12 @@ Partials are categorised by their use: ##### Parameters -| Parameter | Type | -| ---------------------- | -------------------------------------------------------------------------------------------- | -| `model` | [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html) | -| `options` | \{`headingLevel`: `number`;`nested`: `boolean`; } | -| `options.headingLevel` | `number` | -| `options.nested`? | `boolean` | +| Parameter | Type | +| ------ | ------ | +| `model` | [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html) | +| `options` | \{ `headingLevel`: `number`; `nested`: `boolean`; \} | +| `options.headingLevel` | `number` | +| `options.nested`? | `boolean` | ##### Returns @@ -554,9 +439,9 @@ Partials are categorised by their use: ##### Parameters -| Parameter | Type | -| --------- | -------------------------------------------------------------------------------------------- | -| `model` | [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html) | +| Parameter | Type | +| ------ | ------ | +| `model` | [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html) | ##### Returns @@ -568,11 +453,11 @@ Partials are categorised by their use: ##### Parameters -| Parameter | Type | -| ---------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `model` | [`ProjectReflection`](https://typedoc.org/api/classes/Models.ProjectReflection.html) \| [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html) \| [`ContainerReflection`](https://typedoc.org/api/classes/Models.ContainerReflection.html) | -| `options` | \{`headingLevel`: `number`; } | -| `options.headingLevel` | `number` | +| Parameter | Type | +| ------ | ------ | +| `model` | [`ProjectReflection`](https://typedoc.org/api/classes/Models.ProjectReflection.html) \| [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html) \| [`ContainerReflection`](https://typedoc.org/api/classes/Models.ContainerReflection.html) | +| `options` | \{ `headingLevel`: `number`; \} | +| `options.headingLevel` | `number` | ##### Returns @@ -584,9 +469,23 @@ Partials are categorised by their use: ##### Parameters -| Parameter | Type | -| --------- | ----------------------------------------------------------------------------------------------- | -| `model` | [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html)\[] | +| Parameter | Type | +| ------ | ------ | +| `model` | [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html)[] | + +##### Returns + +`string` + +#### groupIndex() + +> **groupIndex**: (`group`) => `string` + +##### Parameters + +| Parameter | Type | +| ------ | ------ | +| `group` | [`ReflectionCategory`](https://typedoc.org/api/types/ReflectionCategory.DeclarationOption.html) \| [`ReflectionGroup`](https://typedoc.org/api/classes/ReflectionGroup.html) | ##### Returns @@ -598,11 +497,11 @@ Partials are categorised by their use: ##### Parameters -| Parameter | Type | -| ---------------------- | ------------------------------------------------------------------------------------------ | -| `model` | [`DeclarationHierarchy`](https://typedoc.org/api/classes/Models.DeclarationHierarchy.html) | -| `options` | \{`headingLevel`: `number`; } | -| `options.headingLevel` | `number` | +| Parameter | Type | +| ------ | ------ | +| `model` | [`DeclarationHierarchy`](https://typedoc.org/api/classes/Models.DeclarationHierarchy.html) | +| `options` | \{ `headingLevel`: `number`; \} | +| `options.headingLevel` | `number` | ##### Returns @@ -614,9 +513,9 @@ Partials are categorised by their use: ##### Parameters -| Parameter | Type | -| --------- | --------------------------------------------------------------------------------- | -| `model` | [`SignatureReflection`](https://typedoc.org/api/classes/SignatureReflection.html) | +| Parameter | Type | +| ------ | ------ | +| `model` | [`SignatureReflection`](https://typedoc.org/api/classes/SignatureReflection.html) | ##### Returns @@ -628,11 +527,11 @@ Partials are categorised by their use: ##### Parameters -| Parameter | Type | -| ---------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `model` | [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html) \| [`SignatureReflection`](https://typedoc.org/api/classes/SignatureReflection.html) | -| `options` | \{`headingLevel`: `number`; } | -| `options.headingLevel` | `number` | +| Parameter | Type | +| ------ | ------ | +| `model` | [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html) \| [`SignatureReflection`](https://typedoc.org/api/classes/SignatureReflection.html) | +| `options` | \{ `headingLevel`: `number`; \} | +| `options.headingLevel` | `number` | ##### Returns @@ -644,9 +543,9 @@ Partials are categorised by their use: ##### Parameters -| Parameter | Type | -| --------- | -------------------------------------------------------------------------------------------- | -| `model` | [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html) | +| Parameter | Type | +| ------ | ------ | +| `model` | [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html) | ##### Returns @@ -660,11 +559,11 @@ Renders a top-level member that contains group and child members such as Classes ##### Parameters -| Parameter | Type | -| ---------------------- | -------------------------------------------------------------------------------------------- | -| `model` | [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html) | -| `options` | \{`headingLevel`: `number`; } | -| `options.headingLevel` | `number` | +| Parameter | Type | +| ------ | ------ | +| `model` | [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html) | +| `options` | \{ `headingLevel`: `number`; \} | +| `options.headingLevel` | `number` | ##### Returns @@ -676,11 +575,11 @@ Renders a top-level member that contains group and child members such as Classes ##### Parameters -| Parameter | Type | -| ---------------------- | ------------------------------------------------------------------------------------ | -| `model` | [`ParameterReflection`](https://typedoc.org/api/classes/ParameterReflection.html)\[] | -| `options` | \{`headingLevel`: `number`; } | -| `options.headingLevel` | `number` | +| Parameter | Type | +| ------ | ------ | +| `model` | [`ParameterReflection`](https://typedoc.org/api/classes/ParameterReflection.html)[] | +| `options` | \{ `headingLevel`: `number`; \} | +| `options.headingLevel` | `number` | ##### Returns @@ -692,9 +591,9 @@ Renders a top-level member that contains group and child members such as Classes ##### Parameters -| Parameter | Type | -| --------- | ------------------------------------------------------------------------------------ | -| `model` | [`ParameterReflection`](https://typedoc.org/api/classes/ParameterReflection.html)\[] | +| Parameter | Type | +| ------ | ------ | +| `model` | [`ParameterReflection`](https://typedoc.org/api/classes/ParameterReflection.html)[] | ##### Returns @@ -710,11 +609,11 @@ There is no association list partial for properties as these are handled as a st ##### Parameters -| Parameter | Type | -| ----------------------- | ----------------------------------------------------------------------------------------------- | -| `model` | [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html)\[] | -| `options`? | \{`isEventProps`: `boolean`; } | -| `options.isEventProps`? | `boolean` | +| Parameter | Type | +| ------ | ------ | +| `model` | [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html)[] | +| `options`? | \{ `isEventProps`: `boolean`; \} | +| `options.isEventProps`? | `boolean` | ##### Returns @@ -726,9 +625,9 @@ There is no association list partial for properties as these are handled as a st ##### Parameters -| Parameter | Type | -| --------- | --------------------------------------------------------------------------------- | -| `model` | [`ReferenceReflection`](https://typedoc.org/api/classes/ReferenceReflection.html) | +| Parameter | Type | +| ------ | ------ | +| `model` | [`ReferenceReflection`](https://typedoc.org/api/classes/ReferenceReflection.html) | ##### Returns @@ -740,11 +639,11 @@ There is no association list partial for properties as these are handled as a st ##### Parameters -| Parameter | Type | -| ---------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `model` | [`ProjectReflection`](https://typedoc.org/api/classes/Models.ProjectReflection.html) \| [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html) | -| `options` | \{`headingLevel`: `number`; } | -| `options.headingLevel` | `number` | +| Parameter | Type | +| ------ | ------ | +| `model` | [`ProjectReflection`](https://typedoc.org/api/classes/Models.ProjectReflection.html) \| [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html) | +| `options` | \{ `headingLevel`: `number`; \} | +| `options.headingLevel` | `number` | ##### Returns @@ -756,14 +655,14 @@ There is no association list partial for properties as these are handled as a st ##### Parameters -| Parameter | Type | -| ----------------------------- | ------------------------------------------------------------------------------------------------------ | -| `model` | [`SignatureReflection`](https://typedoc.org/api/classes/SignatureReflection.html) | -| `options` | \{`headingLevel`: `number`;`nested`: `boolean`;`accessor`: `string`;`multipleSignatures`: `boolean`; } | -| `options.headingLevel` | `number` | -| `options.nested`? | `boolean` | -| `options.accessor`? | `string` | -| `options.multipleSignatures`? | `boolean` | +| Parameter | Type | +| ------ | ------ | +| `model` | [`SignatureReflection`](https://typedoc.org/api/classes/SignatureReflection.html) | +| `options` | \{ `headingLevel`: `number`; `nested`: `boolean`; `accessor`: `string`; `multipleSignatures`: `boolean`; \} | +| `options.headingLevel` | `number` | +| `options.nested`? | `boolean` | +| `options.accessor`? | `string` | +| `options.multipleSignatures`? | `boolean` | ##### Returns @@ -775,9 +674,9 @@ There is no association list partial for properties as these are handled as a st ##### Parameters -| Parameter | Type | -| --------- | ------------------------------------------------------------------------------------ | -| `model` | [`ParameterReflection`](https://typedoc.org/api/classes/ParameterReflection.html)\[] | +| Parameter | Type | +| ------ | ------ | +| `model` | [`ParameterReflection`](https://typedoc.org/api/classes/ParameterReflection.html)[] | ##### Returns @@ -789,11 +688,11 @@ There is no association list partial for properties as these are handled as a st ##### Parameters -| Parameter | Type | -| ---------------------- | --------------------------------------------------------------------------------- | -| `model` | [`SignatureReflection`](https://typedoc.org/api/classes/SignatureReflection.html) | -| `options` | \{`headingLevel`: `number`; } | -| `options.headingLevel` | `number` | +| Parameter | Type | +| ------ | ------ | +| `model` | [`SignatureReflection`](https://typedoc.org/api/classes/SignatureReflection.html) | +| `options` | \{ `headingLevel`: `number`; \} | +| `options.headingLevel` | `number` | ##### Returns @@ -805,12 +704,12 @@ There is no association list partial for properties as these are handled as a st ##### Parameters -| Parameter | Type | -| ---------------------- | --------------------------------------------------------------------------------- | -| `model` | [`SignatureReflection`](https://typedoc.org/api/classes/SignatureReflection.html) | -| `options`? | \{`accessor`: `string`;`includeType`: `boolean`; } | -| `options.accessor`? | `string` | -| `options.includeType`? | `boolean` | +| Parameter | Type | +| ------ | ------ | +| `model` | [`SignatureReflection`](https://typedoc.org/api/classes/SignatureReflection.html) | +| `options`? | \{ `accessor`: `string`; `includeType`: `boolean`; \} | +| `options.accessor`? | `string` | +| `options.includeType`? | `boolean` | ##### Returns @@ -822,12 +721,12 @@ There is no association list partial for properties as these are handled as a st ##### Parameters -| Parameter | Type | -| ---------------------- | -------------------------------------------------------------------------------------------- | -| `model` | [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html) | -| `options` | \{`headingLevel`: `number`;`nested`: `boolean`; } | -| `options.headingLevel` | `number` | -| `options.nested`? | `boolean` | +| Parameter | Type | +| ------ | ------ | +| `model` | [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html) | +| `options` | \{ `headingLevel`: `number`; `nested`: `boolean`; \} | +| `options.headingLevel` | `number` | +| `options.nested`? | `boolean` | ##### Returns @@ -835,15 +734,15 @@ There is no association list partial for properties as these are handled as a st #### sources() -> **sources**: (`model`, `options`) => `string` +> **sources**: (`model`, `options`?) => `string` ##### Parameters -| Parameter | Type | -| ---------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `model` | [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html) \| [`SignatureReflection`](https://typedoc.org/api/classes/SignatureReflection.html) | -| `options` | \{`headingLevel`: `number`; } | -| `options.headingLevel` | `number` | +| Parameter | Type | +| ------ | ------ | +| `model` | [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html) \| [`SignatureReflection`](https://typedoc.org/api/classes/SignatureReflection.html) | +| `options`? | \{ `hideLabel`: `boolean`; \} | +| `options.hideLabel`? | `boolean` | ##### Returns @@ -855,12 +754,12 @@ There is no association list partial for properties as these are handled as a st ##### Parameters -| Parameter | Type | -| ---------------------- | -------------------------------------------------------------------------------------------- | -| `model` | [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html) | -| `options` | \{`headingLevel`: `number`;`nested`: `boolean`; } | -| `options.headingLevel` | `number` | -| `options.nested`? | `boolean` | +| Parameter | Type | +| ------ | ------ | +| `model` | [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html) | +| `options` | \{ `headingLevel`: `number`; `nested`: `boolean`; \} | +| `options.headingLevel` | `number` | +| `options.nested`? | `boolean` | ##### Returns @@ -872,9 +771,9 @@ There is no association list partial for properties as these are handled as a st ##### Parameters -| Parameter | Type | -| --------- | --------------------------------------------------------------------------------------------------------------------------------------------- | -| `model` | [`ReferenceType`](https://typedoc.org/api/classes/ReferenceType.html) \| [`ArrayType`](https://typedoc.org/api/classes/Models.ArrayType.html) | +| Parameter | Type | +| ------ | ------ | +| `model` | [`ReferenceType`](https://typedoc.org/api/classes/ReferenceType.html) \| [`ArrayType`](https://typedoc.org/api/classes/Models.ArrayType.html) | ##### Returns @@ -886,11 +785,11 @@ There is no association list partial for properties as these are handled as a st ##### Parameters -| Parameter | Type | -| ------------------------ | -------------------------------------------------------------- | -| `model` | [`SomeType`](https://typedoc.org/api/classes/SomeType.html)\[] | -| `options`? | \{`forceCollapse`: `boolean`; } | -| `options.forceCollapse`? | `boolean` | +| Parameter | Type | +| ------ | ------ | +| `model` | [`SomeType`](https://typedoc.org/api/classes/SomeType.html)[] | +| `options`? | \{ `forceCollapse`: `boolean`; \} | +| `options.forceCollapse`? | `boolean` | ##### Returns @@ -902,12 +801,12 @@ There is no association list partial for properties as these are handled as a st ##### Parameters -| Parameter | Type | -| ---------------------- | -------------------------------------------------------------------------------------------- | -| `model` | [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html) | -| `options` | \{`headingLevel`: `number`;`allowSource`: `boolean`; } | -| `options.headingLevel` | `number` | -| `options.allowSource`? | `boolean` | +| Parameter | Type | +| ------ | ------ | +| `model` | [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html) | +| `options` | \{ `headingLevel`: `number`; `allowSource`: `boolean`; \} | +| `options.headingLevel` | `number` | +| `options.allowSource`? | `boolean` | ##### Returns @@ -919,13 +818,13 @@ There is no association list partial for properties as these are handled as a st ##### Parameters -| Parameter | Type | -| ------------------- | -------------------------------------------------------------------------------------------- | -| `model` | [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html) | -| `typeDeclaration` | [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html) | -| `opts` | \{`headingLevel`: `number`;`nested`: `boolean`; } | -| `opts.headingLevel` | `number` | -| `opts.nested`? | `boolean` | +| Parameter | Type | +| ------ | ------ | +| `model` | [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html) | +| `typeDeclaration` | [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html) | +| `opts` | \{ `headingLevel`: `number`; `nested`: `boolean`; \} | +| `opts.headingLevel` | `number` | +| `opts.nested`? | `boolean` | ##### Returns @@ -937,11 +836,11 @@ There is no association list partial for properties as these are handled as a st ##### Parameters -| Parameter | Type | -| ---------------------- | ----------------------------------------------------------------------------------------------- | -| `model` | [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html)\[] | -| `options` | \{`headingLevel`: `number`; } | -| `options.headingLevel` | `number` | +| Parameter | Type | +| ------ | ------ | +| `model` | [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html)[] | +| `options` | \{ `headingLevel`: `number`; \} | +| `options.headingLevel` | `number` | ##### Returns @@ -953,11 +852,11 @@ There is no association list partial for properties as these are handled as a st ##### Parameters -| Parameter | Type | -| --------------- | ----------------------------------------------------------------------------------------------- | -| `model` | [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html)\[] | -| `options` | \{`kind`: [`ReflectionKind`](https://typedoc.org/api/enums/Models.ReflectionKind-1.html); } | -| `options.kind`? | [`ReflectionKind`](https://typedoc.org/api/enums/Models.ReflectionKind-1.html) | +| Parameter | Type | +| ------ | ------ | +| `model` | [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html)[] | +| `options` | \{ `kind`: [`ReflectionKind`](https://typedoc.org/api/enums/Models.ReflectionKind-1.html); \} | +| `options.kind`? | [`ReflectionKind`](https://typedoc.org/api/enums/Models.ReflectionKind-1.html) | ##### Returns @@ -969,9 +868,9 @@ There is no association list partial for properties as these are handled as a st ##### Parameters -| Parameter | Type | -| --------- | -------------------------------------------------------------------------------------------- | -| `model` | [`TypeParameterReflection`](https://typedoc.org/api/classes/TypeParameterReflection.html)\[] | +| Parameter | Type | +| ------ | ------ | +| `model` | [`TypeParameterReflection`](https://typedoc.org/api/classes/TypeParameterReflection.html)[] | ##### Returns @@ -983,9 +882,9 @@ There is no association list partial for properties as these are handled as a st ##### Parameters -| Parameter | Type | -| --------- | -------------------------------------------------------------------------------------------- | -| `model` | [`TypeParameterReflection`](https://typedoc.org/api/classes/TypeParameterReflection.html)\[] | +| Parameter | Type | +| ------ | ------ | +| `model` | [`TypeParameterReflection`](https://typedoc.org/api/classes/TypeParameterReflection.html)[] | ##### Returns @@ -1021,9 +920,9 @@ There is no association list partial for properties as these are handled as a st ##### Parameters -| Parameter | Type | -| --------- | ------------------------------------------------------------------------------------ | -| `model` | [`ProjectReflection`](https://typedoc.org/api/classes/Models.ProjectReflection.html) | +| Parameter | Type | +| ------ | ------ | +| `model` | [`ProjectReflection`](https://typedoc.org/api/classes/Models.ProjectReflection.html) | ##### Returns @@ -1043,9 +942,9 @@ There is no association list partial for properties as these are handled as a st ##### Parameters -| Parameter | Type | -| --------- | -------------------------------------------------------------------- | -| `model` | [`ArrayType`](https://typedoc.org/api/classes/Models.ArrayType.html) | +| Parameter | Type | +| ------ | ------ | +| `model` | [`ArrayType`](https://typedoc.org/api/classes/Models.ArrayType.html) | ##### Returns @@ -1057,9 +956,9 @@ There is no association list partial for properties as these are handled as a st ##### Parameters -| Parameter | Type | -| --------- | -------------------------------------------------------------------------------- | -| `model` | [`ConditionalType`](https://typedoc.org/api/classes/Models.ConditionalType.html) | +| Parameter | Type | +| ------ | ------ | +| `model` | [`ConditionalType`](https://typedoc.org/api/classes/Models.ConditionalType.html) | ##### Returns @@ -1071,9 +970,9 @@ There is no association list partial for properties as these are handled as a st ##### Parameters -| Parameter | Type | -| --------- | --------------------------------------------------------------------------------------------- | -| `model` | [`IndexedAccessType`](https://typedoc.org/api/types/IndexedAccessType.DeclarationOption.html) | +| Parameter | Type | +| ------ | ------ | +| `model` | [`IndexedAccessType`](https://typedoc.org/api/types/IndexedAccessType.DeclarationOption.html) | ##### Returns @@ -1085,9 +984,9 @@ There is no association list partial for properties as these are handled as a st ##### Parameters -| Parameter | Type | -| --------- | ----------------------------------------------------------------------------------- | -| `model` | [`InferredType`](https://typedoc.org/api/types/InferredType.DeclarationOption.html) | +| Parameter | Type | +| ------ | ------ | +| `model` | [`InferredType`](https://typedoc.org/api/types/InferredType.DeclarationOption.html) | ##### Returns @@ -1099,9 +998,9 @@ There is no association list partial for properties as these are handled as a st ##### Parameters -| Parameter | Type | -| --------- | ------------------------------------------------------------------------------------------- | -| `model` | [`IntersectionType`](https://typedoc.org/api/types/IntersectionType.DeclarationOption.html) | +| Parameter | Type | +| ------ | ------ | +| `model` | [`IntersectionType`](https://typedoc.org/api/types/IntersectionType.DeclarationOption.html) | ##### Returns @@ -1113,9 +1012,9 @@ There is no association list partial for properties as these are handled as a st ##### Parameters -| Parameter | Type | -| --------- | ------------------------------------------------------------------------------------- | -| `model` | [`IntrinsicType`](https://typedoc.org/api/types/IntrinsicType.DeclarationOption.html) | +| Parameter | Type | +| ------ | ------ | +| `model` | [`IntrinsicType`](https://typedoc.org/api/types/IntrinsicType.DeclarationOption.html) | ##### Returns @@ -1127,9 +1026,9 @@ There is no association list partial for properties as these are handled as a st ##### Parameters -| Parameter | Type | -| --------- | --------------------------------------------------------------------------------- | -| `model` | [`LiteralType`](https://typedoc.org/api/types/LiteralType.DeclarationOption.html) | +| Parameter | Type | +| ------ | ------ | +| `model` | [`LiteralType`](https://typedoc.org/api/types/LiteralType.DeclarationOption.html) | ##### Returns @@ -1141,9 +1040,9 @@ There is no association list partial for properties as these are handled as a st ##### Parameters -| Parameter | Type | -| --------- | ------------------------------------------------------------------------------------------- | -| `model` | [`NamedTupleMember`](https://typedoc.org/api/types/NamedTupleMember.DeclarationOption.html) | +| Parameter | Type | +| ------ | ------ | +| `model` | [`NamedTupleMember`](https://typedoc.org/api/types/NamedTupleMember.DeclarationOption.html) | ##### Returns @@ -1155,9 +1054,9 @@ There is no association list partial for properties as these are handled as a st ##### Parameters -| Parameter | Type | -| --------- | -------------- | -| `model` | `OptionalType` | +| Parameter | Type | +| ------ | ------ | +| `model` | `OptionalType` | ##### Returns @@ -1169,9 +1068,9 @@ There is no association list partial for properties as these are handled as a st ##### Parameters -| Parameter | Type | -| --------- | -------------------------------------------------------------------- | -| `model` | [`QueryType`](https://typedoc.org/api/classes/Models.QueryType.html) | +| Parameter | Type | +| ------ | ------ | +| `model` | [`QueryType`](https://typedoc.org/api/classes/Models.QueryType.html) | ##### Returns @@ -1183,9 +1082,9 @@ There is no association list partial for properties as these are handled as a st ##### Parameters -| Parameter | Type | -| --------- | --------------------------------------------------------------------- | -| `model` | [`ReferenceType`](https://typedoc.org/api/classes/ReferenceType.html) | +| Parameter | Type | +| ------ | ------ | +| `model` | [`ReferenceType`](https://typedoc.org/api/classes/ReferenceType.html) | ##### Returns @@ -1197,11 +1096,11 @@ There is no association list partial for properties as these are handled as a st ##### Parameters -| Parameter | Type | -| ------------------------ | -------------------------------------------------------------------------------------------- | -| `model` | [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html) | -| `options`? | \{`forceCollapse`: `boolean`; } | -| `options.forceCollapse`? | `boolean` | +| Parameter | Type | +| ------ | ------ | +| `model` | [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html) | +| `options`? | \{ `forceCollapse`: `boolean`; \} | +| `options.forceCollapse`? | `boolean` | ##### Returns @@ -1213,11 +1112,11 @@ There is no association list partial for properties as these are handled as a st ##### Parameters -| Parameter | Type | -| ----------------------------- | ------------------------------------------------------------------------------------ | -| `model` | [`SignatureReflection`](https://typedoc.org/api/classes/SignatureReflection.html)\[] | -| `options`? | \{`forceParameterType`: `boolean`; } | -| `options.forceParameterType`? | `boolean` | +| Parameter | Type | +| ------ | ------ | +| `model` | [`SignatureReflection`](https://typedoc.org/api/classes/SignatureReflection.html)[] | +| `options`? | \{ `forceParameterType`: `boolean`; \} | +| `options.forceParameterType`? | `boolean` | ##### Returns @@ -1229,11 +1128,11 @@ There is no association list partial for properties as these are handled as a st ##### Parameters -| Parameter | Type | -| ------------------------ | ----------------------------------------------------------------------- | -| `model` | [`ReflectionType`](https://typedoc.org/api/classes/ReflectionType.html) | -| `options`? | \{`forceCollapse`: `boolean`; } | -| `options.forceCollapse`? | `boolean` | +| Parameter | Type | +| ------ | ------ | +| `model` | [`ReflectionType`](https://typedoc.org/api/classes/ReflectionType.html) | +| `options`? | \{ `forceCollapse`: `boolean`; \} | +| `options.forceCollapse`? | `boolean` | ##### Returns @@ -1245,11 +1144,11 @@ There is no association list partial for properties as these are handled as a st ##### Parameters -| Parameter | Type | -| ------------------------ | ----------------------------------------------------------- | -| `model`? | [`SomeType`](https://typedoc.org/api/classes/SomeType.html) | -| `options`? | \{`forceCollapse`: `boolean`; } | -| `options.forceCollapse`? | `boolean` | +| Parameter | Type | +| ------ | ------ | +| `model`? | [`SomeType`](https://typedoc.org/api/classes/SomeType.html) | +| `options`? | \{ `forceCollapse`: `boolean`; \} | +| `options.forceCollapse`? | `boolean` | ##### Returns @@ -1261,9 +1160,9 @@ There is no association list partial for properties as these are handled as a st ##### Parameters -| Parameter | Type | -| --------- | ------------------------------------------------------------- | -| `model` | [`TupleType`](https://typedoc.org/api/classes/TupleType.html) | +| Parameter | Type | +| ------ | ------ | +| `model` | [`TupleType`](https://typedoc.org/api/classes/TupleType.html) | ##### Returns @@ -1275,9 +1174,9 @@ There is no association list partial for properties as these are handled as a st ##### Parameters -| Parameter | Type | -| --------- | ------------------------------------------------------------------------------------------------- | -| `model` | [`TypeOperatorType`](https://typedoc.org/api/TypeDocOptions,TypeOperatorType/TypeDocOptions.html) | +| Parameter | Type | +| ------ | ------ | +| `model` | [`TypeOperatorType`](https://typedoc.org/api/TypeDocOptions,TypeOperatorType/TypeDocOptions.html) | ##### Returns @@ -1289,9 +1188,9 @@ There is no association list partial for properties as these are handled as a st ##### Parameters -| Parameter | Type | -| --------- | ----------------------------------------------------------------------------- | -| `model` | [`UnionType`](https://typedoc.org/api/types/UnionType.DeclarationOption.html) | +| Parameter | Type | +| ------ | ------ | +| `model` | [`UnionType`](https://typedoc.org/api/types/UnionType.DeclarationOption.html) | ##### Returns @@ -1303,31 +1202,29 @@ There is no association list partial for properties as these are handled as a st ##### Parameters -| Parameter | Type | -| --------- | --------------------------------------------------------------------------------- | -| `model` | [`UnknownType`](https://typedoc.org/api/types/UnknownType.DeclarationOption.html) | +| Parameter | Type | +| ------ | ------ | +| `model` | [`UnknownType`](https://typedoc.org/api/types/UnknownType.DeclarationOption.html) | ##### Returns `string` -#### Defined in - -[packages/typedoc-plugin-markdown/src/theme/markdown-themeContext.ts:100](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/theme/markdown-themeContext.ts#L100) - *** ### helpers > **helpers**: `object` +**Defined in**: [packages/typedoc-plugin-markdown/src/theme/markdown-themeContext.ts:109](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/theme/markdown-themeContext.ts#L109) + 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. +- 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. #### getAngleBracket() @@ -1335,8 +1232,8 @@ Please note that partials: ##### Parameters -| Parameter | Type | -| --------- | -------------- | +| Parameter | Type | +| ------ | ------ | | `bracket` | `"<"` \| `">"` | ##### Returns @@ -1349,9 +1246,9 @@ Please note that partials: ##### Parameters -| Parameter | Type | -| --------- | ----------------------------------------------------------------------------------------- | -| `model` | [`CommentDisplayPart`](https://typedoc.org/api/classes/Models.CommentDisplayPart.html)\[] | +| Parameter | Type | +| ------ | ------ | +| `model` | [`CommentDisplayPart`](https://typedoc.org/api/classes/Models.CommentDisplayPart.html)[] | ##### Returns @@ -1359,89 +1256,47 @@ Please note that partials: #### getDeclarationType() -> **getDeclarationType**: (`model`) => `undefined` | [`SomeType`](https://typedoc.org/api/classes/SomeType.html) +> **getDeclarationType**: (`model`) => `undefined` \| [`SomeType`](https://typedoc.org/api/classes/SomeType.html) ##### Parameters -| Parameter | Type | -| --------- | -------------------------------------------------------------------------------------------- | -| `model` | [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html) | +| Parameter | Type | +| ------ | ------ | +| `model` | [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html) | ##### Returns -`undefined` | [`SomeType`](https://typedoc.org/api/classes/SomeType.html) +`undefined` \| [`SomeType`](https://typedoc.org/api/classes/SomeType.html) #### getDescriptionForComment() -> **getDescriptionForComment**: (`comment`) => `null` | `string` +> **getDescriptionForComment**: (`comment`) => `null` \| `string` ##### Parameters -| Parameter | Type | -| --------- | ---------------------------------------------------------------- | +| Parameter | Type | +| ------ | ------ | | `comment` | [`Comment`](https://typedoc.org/api/classes/Models.Comment.html) | ##### Returns -`null` | `string` +`null` \| `string` #### getFlattenedDeclarations() -> **getFlattenedDeclarations**: (`model`, `options`?) => [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html)\[] +> **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`? | \{`includeSignatures`: `boolean`; } | -| `options.includeSignatures`? | `boolean` | +| Parameter | Type | +| ------ | ------ | +| `model` | [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html)[] | +| `options`? | \{ `includeSignatures`: `boolean`; \} | +| `options.includeSignatures`? | `boolean` | ##### Returns -[`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html)\[] - -#### getGroupIndexList() - -> **getGroupIndexList**: (`children`) => `string` - -##### Parameters - -| Parameter | Type | -| ---------- | -------------------------------------------------------------------------------------------------------------------------- | -| `children` | `DocumentReflection`\[] \| [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html)\[] | - -##### Returns - -`string` - -#### getGroupIndexTable() - -> **getGroupIndexTable**: (`children`) => `string` - -##### Parameters - -| Parameter | Type | -| ---------- | -------------------------------------------------------------------------------------------------------------------------- | -| `children` | `DocumentReflection`\[] \| [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html)\[] | - -##### Returns - -`string` - -#### getGroupIndex() - -> **getGroupIndex**: (`group`) => `any` - -##### Parameters - -| Parameter | Type | -| --------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `group` | [`ReflectionCategory`](https://typedoc.org/api/types/ReflectionCategory.DeclarationOption.html) \| [`ReflectionGroup`](https://typedoc.org/api/classes/ReflectionGroup.html) | - -##### Returns - -`any` +[`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html)[] #### getHierarchyType() @@ -1449,11 +1304,11 @@ Please note that partials: ##### Parameters -| Parameter | Type | -| ------------------- | ----------------------------------------------------------- | -| `model` | [`SomeType`](https://typedoc.org/api/classes/SomeType.html) | -| `options`? | \{`isTarget`: `boolean`; } | -| `options.isTarget`? | `boolean` | +| Parameter | Type | +| ------ | ------ | +| `model` | [`SomeType`](https://typedoc.org/api/classes/SomeType.html) | +| `options`? | \{ `isTarget`: `boolean`; \} | +| `options.isTarget`? | `boolean` | ##### Returns @@ -1465,9 +1320,9 @@ Please note that partials: ##### Parameters -| Parameter | Type | -| --------- | ------------------------------------------------------------------------------ | -| `model` | [`ReflectionKind`](https://typedoc.org/api/enums/Models.ReflectionKind-1.html) | +| Parameter | Type | +| ------ | ------ | +| `model` | [`ReflectionKind`](https://typedoc.org/api/enums/Models.ReflectionKind-1.html) | ##### Returns @@ -1475,17 +1330,17 @@ Please note that partials: #### getModifier() -> **getModifier**: (`model`) => `null` | `string` +> **getModifier**: (`model`) => `null` \| `string` ##### Parameters -| Parameter | Type | -| --------- | -------------------------------------------------------------------------------------------- | -| `model` | [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html) | +| Parameter | Type | +| ------ | ------ | +| `model` | [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html) | ##### Returns -`null` | `string` +`null` \| `string` #### getParameterDefaultValue() @@ -1493,9 +1348,9 @@ Please note that partials: ##### Parameters -| Parameter | Type | -| --------- | --------------------------------------------------------------------------------- | -| `model` | [`ParameterReflection`](https://typedoc.org/api/classes/ParameterReflection.html) | +| Parameter | Type | +| ------ | ------ | +| `model` | [`ParameterReflection`](https://typedoc.org/api/classes/ParameterReflection.html) | ##### Returns @@ -1507,11 +1362,11 @@ Please note that partials: ##### Parameters -| Parameter | Type | Default value | -| ------------------------ | ---------------------------------------------------------------------------------------------------------------------------------- | ------------- | -| `stringWithPlaceholders` | `string` | `undefined` | -| `page` | [`MarkdownPageEvent`](../../events/classes/MarkdownPageEvent.md)\<[`Reflection`](https://typedoc.org/api/classes/Reflection.html)> | `undefined` | -| `includeVersion` | `boolean` | `true` | +| Parameter | Type | Default value | +| ------ | ------ | ------ | +| `stringWithPlaceholders` | `string` | `undefined` | +| `page` | [`MarkdownPageEvent`](../../events/classes/MarkdownPageEvent.md) | `undefined` | +| `includeVersion` | `boolean` | `true` | ##### Returns @@ -1519,17 +1374,17 @@ Please note that partials: #### getPropertyDefaultValue() -> **getPropertyDefaultValue**: (`model`) => `null` | `string` +> **getPropertyDefaultValue**: (`model`) => `null` \| `string` ##### Parameters -| Parameter | Type | -| --------- | -------------------------------------------------------------------------------------------- | -| `model` | [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html) | +| Parameter | Type | +| ------ | ------ | +| `model` | [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html) | ##### Returns -`null` | `string` +`null` \| `string` #### getReflectionFlags() @@ -1537,8 +1392,8 @@ Please note that partials: ##### Parameters -| Parameter | Type | -| ----------------- | ------------------------------------------------------------------------- | +| Parameter | Type | +| ------ | ------ | | `reflectionFlags` | [`ReflectionFlags`](https://typedoc.org/api/classes/ReflectionFlags.html) | ##### Returns @@ -1551,9 +1406,9 @@ Please note that partials: ##### Parameters -| Parameter | Type | -| --------- | ----------------------------------------------------------- | -| `model`? | [`SomeType`](https://typedoc.org/api/classes/SomeType.html) | +| Parameter | Type | +| ------ | ------ | +| `model`? | [`SomeType`](https://typedoc.org/api/classes/SomeType.html) | ##### Returns @@ -1565,9 +1420,9 @@ Please note that partials: ##### Parameters -| Parameter | Type | -| --------- | ----------------------------------------------------------- | -| `type` | [`SomeType`](https://typedoc.org/api/classes/SomeType.html) | +| Parameter | Type | +| ------ | ------ | +| `type` | [`SomeType`](https://typedoc.org/api/classes/SomeType.html) | ##### Returns @@ -1579,9 +1434,9 @@ Please note that partials: ##### Parameters -| Parameter | Type | -| --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `model` | [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html) \| [`SignatureReflection`](https://typedoc.org/api/classes/SignatureReflection.html) | +| Parameter | Type | +| ------ | ------ | +| `model` | [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html) \| [`SignatureReflection`](https://typedoc.org/api/classes/SignatureReflection.html) | ##### Returns @@ -1593,15 +1448,11 @@ Please note that partials: ##### Parameters -| Parameter | Type | -| ----------------- | -------------------------------------------------------------------------------------------- | -| `key` | `"parameters"` \| `"properties"` \| `"enums"` \| `"typeDeclarations"` \| `"propertyMembers"` | -| `reflectionKind`? | [`ReflectionKind`](https://typedoc.org/api/enums/Models.ReflectionKind-1.html) | +| Parameter | Type | +| ------ | ------ | +| `key` | `"parameters"` \| `"properties"` \| `"enums"` \| `"typeDeclarations"` \| `"propertyMembers"` | +| `reflectionKind`? | [`ReflectionKind`](https://typedoc.org/api/enums/Models.ReflectionKind-1.html) | ##### Returns `boolean` - -#### Defined in - -[packages/typedoc-plugin-markdown/src/theme/markdown-themeContext.ts:113](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/theme/markdown-themeContext.ts#L113) diff --git a/devguide/typedoc-plugin-markdown/theme/documents/Custom Theme.md b/devguide/typedoc-plugin-markdown/theme/documents/Custom Theme.md new file mode 100644 index 000000000..599cfef70 --- /dev/null +++ b/devguide/typedoc-plugin-markdown/theme/documents/Custom Theme.md @@ -0,0 +1,69 @@ +[Developer Guide](../../../README.md) / [typedoc-plugin-markdown](../../README.md) / [theme](../README.md) / Custom Theme + +## Custom Theme + +If there are some specific customization not achievable with hooks or events then a more advanced customization can be achieved by providing a new theme class which returns a different context class. + +This implementation follows an adapted version of [TypeDoc's custom theming implementation](https://github.com/TypeStrong/typedoc/blob/master/internal-docs/custom-themes.md). + +Please note that although the theme api is public it is not covered by semantic versioning and the contract may change between versions (although changes will likely be minimal). If full stability is required please either fix versions, fork the project or do not extend the theme. + +### Example + +This code defines a new theme called “customTheme”: + +```ts +export function load(app) { + app.renderer.defineTheme('customTheme', MyMarkdownTheme); +} + +class MyMarkdownTheme extends MarkdownTheme {} +``` + +The theme can then be consumed by the `theme` option: + +```json filename="typedoc.json" +{ + "plugin": ["typedoc-plugin-mardown", "./local-plugins/my-custom-plugin.js"], + "theme": "customTheme" +} +``` + +The themes can be extended to provide custom partials, helpers and templates by proving a custom render context class. + +```ts +class MyMarkdownTheme extends MarkdownTheme { + getRenderContext(page) { + return new MyMarkdownThemeContext(this, page, this.application.options); + } +} + +class MyMarkdownThemeContext extends MarkdownThemeContext { + // customise templates + templates = { + ...this.templates, + reflection: (model) => { + return `New template for ${model.name}!`; + }, + }; + + // customise partials + partials = { + ...this.partials, + header: (model) => { + return ` +# Welcome to custom header for ${this.page.project.name} project and ${model.name} model! +Use my new helper - ${this.helpers.newHelper()} + `; + }, + }; + + // customise helpers + helpers = { + ...this.helpers, + newHelper: () => { + return 'New helper!'; + }, + }; +} +``` diff --git a/devguide/typedoc-plugin-markdown/types/README.md b/devguide/typedoc-plugin-markdown/types/README.md index 298d7b724..1aa26d38b 100644 --- a/devguide/typedoc-plugin-markdown/types/README.md +++ b/devguide/typedoc-plugin-markdown/types/README.md @@ -4,25 +4,43 @@ All plugin types are exported from this module. -## Index - -### Interfaces - -| Interface | Description | -| ------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------- | -| [TranslatableStrings](interfaces/TranslatableStrings.md) | The model of translatable strings specific to the Markdown theme. | -| [MarkdownApplication](interfaces/MarkdownApplication.md) | The MarkdownApplication extends TypeDoc's [Application](https://typedoc.org/api/classes/Application.html) instance with a custom renderer. | -| [MarkdownRendererHooks](interfaces/MarkdownRendererHooks.md) | Describes the hooks available to inject output in the markdown theme. | -| [MarkdownRenderer](interfaces/MarkdownRenderer.md) | The MarkdownRenderer extends TypeDoc's [Renderer](https://typedoc.org/api/classes/Renderer.html) instance with custom hooks and async jobs. | -| [PluginOptions](interfaces/PluginOptions.md) | Describes the options declared by the plugin. | -| [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) | Defines how reflections are mapped to urls. | -| [UrlOption](interfaces/UrlOption.md) | Used internally when building the URL mapping. | - -### Type Aliases - -| Type alias | Description | -| ------------------------------------------------ | ----------------------------------------------- | -| [RenderTemplate](type-aliases/RenderTemplate.md) | Defines the template type to use for rendering. | +## Interfaces + +| Interface | Description | +| ------ | ------ | +| [TranslatableStrings](interfaces/TranslatableStrings.md) | The model of translatable strings specific to the Markdown theme. | +| [MarkdownApplication](interfaces/MarkdownApplication.md) | The MarkdownApplication extends TypeDoc's [Application](https://typedoc.org/api/classes/Application.html) instance with a custom renderer. | +| [MarkdownRendererHooks](interfaces/MarkdownRendererHooks.md) | Describes the hooks available to inject output in the markdown theme. | +| [MarkdownRenderer](interfaces/MarkdownRenderer.md) | The MarkdownRenderer extends TypeDoc's [Renderer](https://typedoc.org/api/classes/Renderer.html) instance with custom hooks and async jobs. | +| [PluginOptions](interfaces/PluginOptions.md) | Describes the options declared by the plugin. | +| [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) | Defines how reflections are mapped to urls. | +| [UrlOption](interfaces/UrlOption.md) | Used internally when building the URL mapping. | + +## Type Aliases + +### RenderTemplate()\ + +> **RenderTemplate**\<`T`\>: (`data`) => `string` + +**Defined in**: [packages/typedoc-plugin-markdown/src/types/theme.ts:62](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/theme.ts#L62) + +Defines the template type to use for rendering. + +#### Type Parameters + +| Type Parameter | +| ------ | +| `T` | + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `data` | [`T`](../../types/typedoc-plugin-markdown.types.RenderTemplate.html#t) | + +#### Returns + +`string` diff --git a/devguide/typedoc-plugin-markdown/types/interfaces/MarkdownApplication.md b/devguide/typedoc-plugin-markdown/types/interfaces/MarkdownApplication.md index 7fc6c217d..46daf7928 100644 --- a/devguide/typedoc-plugin-markdown/types/interfaces/MarkdownApplication.md +++ b/devguide/typedoc-plugin-markdown/types/interfaces/MarkdownApplication.md @@ -2,17 +2,13 @@ # Interface: MarkdownApplication -The MarkdownApplication extends TypeDoc's [Application](https://typedoc.org/api/classes/Application.html) instance with a custom renderer. - -## Contents +**Defined in**: [packages/typedoc-plugin-markdown/src/types/markdown-application.ts:7](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/markdown-application.ts#L7) -* [Extends](#extends) -* [Properties](#properties) - * [renderer](#renderer) +The MarkdownApplication extends TypeDoc's [Application](https://typedoc.org/api/classes/Application.html) instance with a custom renderer. ## Extends -* [`Application`](https://typedoc.org/api/classes/Application.html) +- [`Application`](https://typedoc.org/api/classes/Application.html) ## Properties @@ -20,12 +16,10 @@ The MarkdownApplication extends TypeDoc's [Application](https://typedoc.org/api/ > **renderer**: [`MarkdownRenderer`](MarkdownRenderer.md) & [`Renderer`](https://typedoc.org/api/classes/Renderer.html) +**Defined in**: [packages/typedoc-plugin-markdown/src/types/markdown-application.ts:8](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/markdown-application.ts#L8) + The renderer used to generate the HTML documentation output. #### Overrides `Application.renderer` - -#### Defined in - -[packages/typedoc-plugin-markdown/src/types/markdown-application.ts:8](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/markdown-application.ts#L8) diff --git a/devguide/typedoc-plugin-markdown/types/interfaces/MarkdownRenderer.md b/devguide/typedoc-plugin-markdown/types/interfaces/MarkdownRenderer.md index 659478e55..7cef25c4e 100644 --- a/devguide/typedoc-plugin-markdown/types/interfaces/MarkdownRenderer.md +++ b/devguide/typedoc-plugin-markdown/types/interfaces/MarkdownRenderer.md @@ -2,25 +2,13 @@ # Interface: MarkdownRenderer -The MarkdownRenderer extends TypeDoc's [Renderer](https://typedoc.org/api/classes/Renderer.html) instance with custom hooks and async jobs. - -## Contents +**Defined in**: [packages/typedoc-plugin-markdown/src/types/markdown-renderer.ts:12](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/markdown-renderer.ts#L12) -* [Extends](#extends) -* [Properties](#properties) - * [defineTheme()](#definetheme) - * [markdownHooks](#markdownhooks) - * [preRenderAsyncJobs](#prerenderasyncjobs) - * [postRenderAsyncJobs](#postrenderasyncjobs) - * [packagesMeta](#packagesmeta) -* [Methods](#methods) - * [on()](#on) - * [Call Signature](#call-signature) - * [Call Signature](#call-signature-1) +The MarkdownRenderer extends TypeDoc's [Renderer](https://typedoc.org/api/classes/Renderer.html) instance with custom hooks and async jobs. ## Extends -* [`Renderer`](https://typedoc.org/api/classes/Renderer.html) +- [`Renderer`](https://typedoc.org/api/classes/Renderer.html) ## Properties @@ -28,14 +16,16 @@ The MarkdownRenderer extends TypeDoc's [Renderer](https://typedoc.org/api/classe > **defineTheme**: (`name`, `theme`) => `void` +**Defined in**: [packages/typedoc-plugin-markdown/src/types/markdown-renderer.ts:51](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/markdown-renderer.ts#L51) + Define a new theme that can be used to render output. #### Parameters -| Parameter | Type | Description | -| --------- | ----------------------------------------------------------------------- | ----------------------- | -| `name` | `string` | The name of the theme. | -| `theme` | (`renderer`) => [`MarkdownTheme`](../../theme/classes/MarkdownTheme.md) | The theme class to use. | +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `name` | `string` | The name of the theme. | +| `theme` | (`renderer`) => [`MarkdownTheme`](../../theme/classes/MarkdownTheme.md) | The theme class to use. | #### Returns @@ -45,25 +35,21 @@ Define a new theme that can be used to render output. `Renderer.defineTheme` -#### Defined in - -[packages/typedoc-plugin-markdown/src/types/markdown-renderer.ts:51](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/markdown-renderer.ts#L51) - *** ### markdownHooks -> **markdownHooks**: [`EventHooks`](https://typedoc.org/api/classes/EventHooks.html)\<[`MarkdownRendererHooks`](MarkdownRendererHooks.md), `string`> +> **markdownHooks**: [`EventHooks`](https://typedoc.org/api/classes/EventHooks.html)\<[`MarkdownRendererHooks`](MarkdownRendererHooks.md), `string`\> -#### Defined in - -[packages/typedoc-plugin-markdown/src/types/markdown-renderer.ts:56](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/markdown-renderer.ts#L56) +**Defined in**: [packages/typedoc-plugin-markdown/src/types/markdown-renderer.ts:56](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/markdown-renderer.ts#L56) *** ### preRenderAsyncJobs -> **preRenderAsyncJobs**: (`output`) => `Promise`\<`void`>\[] +> **preRenderAsyncJobs**: (`output`) => `Promise`\<`void`\>[] + +**Defined in**: [packages/typedoc-plugin-markdown/src/types/markdown-renderer.ts:63](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/markdown-renderer.ts#L63) A list of async jobs which must be completed before rendering output. @@ -71,27 +57,25 @@ Note: This array is cleared after calling the contained functions on each call. #### Parameters -| Parameter | Type | -| --------- | ------------------------------------------------------------------------ | -| `output` | [`MarkdownRendererEvent`](../../events/classes/MarkdownRendererEvent.md) | +| Parameter | Type | +| ------ | ------ | +| `output` | [`MarkdownRendererEvent`](../../events/classes/MarkdownRendererEvent.md) | #### Returns -`Promise`\<`void`> +`Promise`\<`void`\> #### Overrides `Renderer.preRenderAsyncJobs` -#### Defined in - -[packages/typedoc-plugin-markdown/src/types/markdown-renderer.ts:63](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/markdown-renderer.ts#L63) - *** ### postRenderAsyncJobs -> **postRenderAsyncJobs**: (`output`) => `Promise`\<`void`>\[] +> **postRenderAsyncJobs**: (`output`) => `Promise`\<`void`\>[] + +**Defined in**: [packages/typedoc-plugin-markdown/src/types/markdown-renderer.ts:71](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/markdown-renderer.ts#L71) A list of async jobs which must be completed after rendering output files but before generation is considered successful. These functions will be called after all documents have been written to the filesystem. @@ -100,33 +84,25 @@ Note: This array is cleared after calling the contained functions on each call. #### Parameters -| Parameter | Type | -| --------- | ------------------------------------------------------------------------ | -| `output` | [`MarkdownRendererEvent`](../../events/classes/MarkdownRendererEvent.md) | +| Parameter | Type | +| ------ | ------ | +| `output` | [`MarkdownRendererEvent`](../../events/classes/MarkdownRendererEvent.md) | #### Returns -`Promise`\<`void`> +`Promise`\<`void`\> #### Overrides `Renderer.postRenderAsyncJobs` -#### Defined in - -[packages/typedoc-plugin-markdown/src/types/markdown-renderer.ts:71](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/markdown-renderer.ts#L71) - *** ### packagesMeta -> **packagesMeta**: `Record`\<`string`, `object`> - -**`Internal`** +> **packagesMeta**: `Record`\<`string`, \{ `description`: `string`; `options`: [`Options`](https://typedoc.org/api/types/Configuration.Options.html); \}\> -#### Defined in - -[packages/typedoc-plugin-markdown/src/types/markdown-renderer.ts:74](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/markdown-renderer.ts#L74) +**Defined in**: [packages/typedoc-plugin-markdown/src/types/markdown-renderer.ts:73](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/markdown-renderer.ts#L73) ## Methods @@ -136,12 +112,14 @@ Note: This array is cleared after calling the contained functions on each call. > **on**(`event`, `callback`): `void` +**Defined in**: [packages/typedoc-plugin-markdown/src/types/markdown-renderer.ts:23](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/markdown-renderer.ts#L23) + ##### Parameters -| Parameter | Type | Description | -| ---------- | ---------------------------- | -------------------------------------------------------------------------------------------------- | -| `event` | `"beginPage"` \| `"endPage"` | Triggered before or after a document will be rendered. | -| `callback` | (`page`) => `void` | Receives the [MarkdownPageEvent](../../events/classes/MarkdownPageEvent.md) object as an argument. | +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `event` | `"beginPage"` \| `"endPage"` | Triggered before or after a document will be rendered. | +| `callback` | (`page`) => `void` | Receives the [MarkdownPageEvent](../../events/classes/MarkdownPageEvent.md) object as an argument. | ##### Returns @@ -157,20 +135,18 @@ app.renderer.on(MarkdownPageEvent.BEGIN, (renderer) => {}); `Renderer.on` -##### Defined in - -[packages/typedoc-plugin-markdown/src/types/markdown-renderer.ts:23](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/markdown-renderer.ts#L23) - #### Call Signature > **on**(`event`, `callback`): `void` +**Defined in**: [packages/typedoc-plugin-markdown/src/types/markdown-renderer.ts:38](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/markdown-renderer.ts#L38) + ##### Parameters -| Parameter | Type | Description | -| ---------- | -------------------------------- | ---------------------------------------------------------------------------------------------------------- | -| `event` | `"beginRender"` \| `"endRender"` | Triggered before or after rendering the project. | -| `callback` | (`page`) => `void` | Receives the [MarkdownRendererEvent](../../events/classes/MarkdownRendererEvent.md) object as an argument. | +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `event` | `"beginRender"` \| `"endRender"` | Triggered before or after rendering the project. | +| `callback` | (`page`) => `void` | Receives the [MarkdownRendererEvent](../../events/classes/MarkdownRendererEvent.md) object as an argument. | ##### Returns @@ -185,7 +161,3 @@ app.renderer.on(MarkdownRendererEvent.BEGIN, (renderer) => {}); ##### Overrides `Renderer.on` - -##### Defined in - -[packages/typedoc-plugin-markdown/src/types/markdown-renderer.ts:38](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/markdown-renderer.ts#L38) diff --git a/devguide/typedoc-plugin-markdown/types/interfaces/MarkdownRendererHooks.md b/devguide/typedoc-plugin-markdown/types/interfaces/MarkdownRendererHooks.md index 197920d8a..baf100922 100644 --- a/devguide/typedoc-plugin-markdown/types/interfaces/MarkdownRendererHooks.md +++ b/devguide/typedoc-plugin-markdown/types/interfaces/MarkdownRendererHooks.md @@ -2,64 +2,56 @@ # Interface: MarkdownRendererHooks +**Defined in**: [packages/typedoc-plugin-markdown/src/types/markdown-renderer-hooks.ts:6](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/markdown-renderer-hooks.ts#L6) + Describes the hooks available to inject output in the markdown theme. ## Hooks ### page.begin -> **page.begin**: \[[`MarkdownThemeContext`](../../theme/classes/MarkdownThemeContext.md)] - -Applied at the start of the markdown output. +> **page.begin**: \[[`MarkdownThemeContext`](../../theme/classes/MarkdownThemeContext.md)\] -#### Defined in +**Defined in**: [packages/typedoc-plugin-markdown/src/types/markdown-renderer-hooks.ts:12](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/markdown-renderer-hooks.ts#L12) -[packages/typedoc-plugin-markdown/src/types/markdown-renderer-hooks.ts:12](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/markdown-renderer-hooks.ts#L12) +Applied at the start of the markdown output. *** ### page.end -> **page.end**: \[[`MarkdownThemeContext`](../../theme/classes/MarkdownThemeContext.md)] +> **page.end**: \[[`MarkdownThemeContext`](../../theme/classes/MarkdownThemeContext.md)\] -Applied at the end of the markdown output. - -#### Defined in +**Defined in**: [packages/typedoc-plugin-markdown/src/types/markdown-renderer-hooks.ts:19](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/markdown-renderer-hooks.ts#L19) -[packages/typedoc-plugin-markdown/src/types/markdown-renderer-hooks.ts:19](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/markdown-renderer-hooks.ts#L19) +Applied at the end of the markdown output. *** ### content.begin -> **content.begin**: \[[`MarkdownThemeContext`](../../theme/classes/MarkdownThemeContext.md)] - -Applied before the main markdown content is rendered. +> **content.begin**: \[[`MarkdownThemeContext`](../../theme/classes/MarkdownThemeContext.md)\] -#### Defined in +**Defined in**: [packages/typedoc-plugin-markdown/src/types/markdown-renderer-hooks.ts:26](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/markdown-renderer-hooks.ts#L26) -[packages/typedoc-plugin-markdown/src/types/markdown-renderer-hooks.ts:26](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/markdown-renderer-hooks.ts#L26) +Applied before the main markdown content is rendered. *** ### index.page.begin -> **index.page.begin**: \[[`MarkdownThemeContext`](../../theme/classes/MarkdownThemeContext.md)] - -Applied at the start of the markdown output on the index page. +> **index.page.begin**: \[[`MarkdownThemeContext`](../../theme/classes/MarkdownThemeContext.md)\] -#### Defined in +**Defined in**: [packages/typedoc-plugin-markdown/src/types/markdown-renderer-hooks.ts:33](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/markdown-renderer-hooks.ts#L33) -[packages/typedoc-plugin-markdown/src/types/markdown-renderer-hooks.ts:33](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/markdown-renderer-hooks.ts#L33) +Applied at the start of the markdown output on the index page. *** ### index.page.end -> **index.page.end**: \[[`MarkdownThemeContext`](../../theme/classes/MarkdownThemeContext.md)] - -Applied at the end of the markdown output on the index page. +> **index.page.end**: \[[`MarkdownThemeContext`](../../theme/classes/MarkdownThemeContext.md)\] -#### Defined in +**Defined in**: [packages/typedoc-plugin-markdown/src/types/markdown-renderer-hooks.ts:40](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/markdown-renderer-hooks.ts#L40) -[packages/typedoc-plugin-markdown/src/types/markdown-renderer-hooks.ts:40](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/markdown-renderer-hooks.ts#L40) +Applied at the end of the markdown output on the index page. diff --git a/devguide/typedoc-plugin-markdown/types/interfaces/NavigationItem.md b/devguide/typedoc-plugin-markdown/types/interfaces/NavigationItem.md index 0d13882d5..40e2c4a3e 100644 --- a/devguide/typedoc-plugin-markdown/types/interfaces/NavigationItem.md +++ b/devguide/typedoc-plugin-markdown/types/interfaces/NavigationItem.md @@ -2,6 +2,8 @@ # Interface: NavigationItem +**Defined in**: [packages/typedoc-plugin-markdown/src/types/theme.ts:29](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/theme.ts#L29) + The model used to define the navigation structure. ## Properties @@ -10,19 +12,15 @@ The model used to define the navigation structure. > **title**: `string` -#### Defined in - -[packages/typedoc-plugin-markdown/src/types/theme.ts:30](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/theme.ts#L30) +**Defined in**: [packages/typedoc-plugin-markdown/src/types/theme.ts:30](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/theme.ts#L30) *** ### path? -> `optional` **path**: `null` | `string` +> `optional` **path**: `null` \| `string` -#### Defined in - -[packages/typedoc-plugin-markdown/src/types/theme.ts:31](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/theme.ts#L31) +**Defined in**: [packages/typedoc-plugin-markdown/src/types/theme.ts:31](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/theme.ts#L31) *** @@ -30,16 +28,20 @@ The model used to define the navigation structure. > `optional` **kind**: [`ReflectionKind`](https://typedoc.org/api/enums/Models.ReflectionKind-1.html) -#### Defined in +**Defined in**: [packages/typedoc-plugin-markdown/src/types/theme.ts:32](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/theme.ts#L32) + +*** + +### isDeprecated? -[packages/typedoc-plugin-markdown/src/types/theme.ts:32](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/theme.ts#L32) +> `optional` **isDeprecated**: `boolean` + +**Defined in**: [packages/typedoc-plugin-markdown/src/types/theme.ts:33](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/theme.ts#L33) *** ### children? -> `optional` **children**: [`NavigationItem`](NavigationItem.md)\[] - -#### Defined in +> `optional` **children**: [`NavigationItem`](NavigationItem.md)[] -[packages/typedoc-plugin-markdown/src/types/theme.ts:33](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/theme.ts#L33) +**Defined in**: [packages/typedoc-plugin-markdown/src/types/theme.ts:34](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/theme.ts#L34) diff --git a/devguide/typedoc-plugin-markdown/types/interfaces/PackageMetaData.md b/devguide/typedoc-plugin-markdown/types/interfaces/PackageMetaData.md index fbc6bdc68..2b2cfe76d 100644 --- a/devguide/typedoc-plugin-markdown/types/interfaces/PackageMetaData.md +++ b/devguide/typedoc-plugin-markdown/types/interfaces/PackageMetaData.md @@ -2,6 +2,8 @@ # Interface: PackageMetaData +**Defined in**: [packages/typedoc-plugin-markdown/src/types/theme.ts:9](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/theme.ts#L9) + The model used to define the package metadata when in packages mode. ## Properties @@ -10,9 +12,7 @@ The model used to define the package metadata when in packages mode. > **description**: `string` -#### Defined in - -[packages/typedoc-plugin-markdown/src/types/theme.ts:10](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/theme.ts#L10) +**Defined in**: [packages/typedoc-plugin-markdown/src/types/theme.ts:10](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/theme.ts#L10) *** @@ -20,6 +20,4 @@ The model used to define the package metadata when in packages mode. > **options**: [`Options`](https://typedoc.org/api/types/Configuration.Options.html) -#### Defined in - -[packages/typedoc-plugin-markdown/src/types/theme.ts:11](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/theme.ts#L11) +**Defined in**: [packages/typedoc-plugin-markdown/src/types/theme.ts:11](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/theme.ts#L11) diff --git a/devguide/typedoc-plugin-markdown/types/interfaces/PluginOptions.md b/devguide/typedoc-plugin-markdown/types/interfaces/PluginOptions.md index f03fe2936..bd44f9e07 100644 --- a/devguide/typedoc-plugin-markdown/types/interfaces/PluginOptions.md +++ b/devguide/typedoc-plugin-markdown/types/interfaces/PluginOptions.md @@ -2,68 +2,13 @@ # Interface: PluginOptions -Describes the options declared by the plugin. +**Defined in**: [packages/typedoc-plugin-markdown/src/types/options.ts:7](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/options.ts#L7) -## Contents - -* [Extended by](#extended-by) -* [Properties](#properties) - * [anchorPrefix](#anchorprefix) - * [blockTagsPreserveOrder](#blocktagspreserveorder) - * [classPropertiesFormat](#classpropertiesformat) - * [entryFileName](#entryfilename) - * [entryModule](#entrymodule) - * [enumMembersFormat](#enummembersformat) - * [~~excludeGroups~~](#excludegroups) - * [excludeScopesInPaths](#excludescopesinpaths) - * [expandObjects](#expandobjects) - * [expandParameters](#expandparameters) - * [fileExtension](#fileextension) - * [flattenOutputFiles](#flattenoutputfiles) - * [formatWithPrettier](#formatwithprettier) - * [hideBreadcrumbs](#hidebreadcrumbs) - * [hideGroupHeadings](#hidegroupheadings) - * [hidePageHeader](#hidepageheader) - * [hidePageTitle](#hidepagetitle) - * [indexFormat](#indexformat) - * [interfacePropertiesFormat](#interfacepropertiesformat) - * [membersWithOwnFile](#memberswithownfile) - * [mergeReadme](#mergereadme) - * [modulesFileName](#modulesfilename) - * [~~navigationModel~~](#navigationmodel) - * [~~excludeGroups~~](#excludegroups-1) - * [~~excludeCategories~~](#excludecategories) - * [~~excludeFolders~~](#excludefolders) - * [outputFileStrategy](#outputfilestrategy) - * [pageTitleTemplates](#pagetitletemplates) - * [index](#index) - * [member](#member) - * [module](#module) - * [parametersFormat](#parametersformat) - * [preserveAnchorCasing](#preserveanchorcasing) - * [prettierConfigFile](#prettierconfigfile) - * [propertiesFormat](#propertiesformat) - * [propertyMembersFormat](#propertymembersformat) - * [publicPath](#publicpath) - * [sanitizeComments](#sanitizecomments) - * [tableColumnSettings](#tablecolumnsettings) - * [hideDefaults](#hidedefaults) - * [hideInherited](#hideinherited) - * [hideModifiers](#hidemodifiers) - * [hideOverrides](#hideoverrides) - * [hideSources](#hidesources) - * [hideValues](#hidevalues) - * [leftAlignHeaders](#leftalignheaders) - * [textContentMappings](#textcontentmappings) - * [typeDeclarationFormat](#typedeclarationformat) - * [typeDeclarationVisibility](#typedeclarationvisibility) - * [useCodeBlocks](#usecodeblocks) - * [useHTMLAnchors](#usehtmlanchors) - * [useHTMLEncodedBrackets](#usehtmlencodedbrackets) +Describes the options declared by the plugin. ## Extended by -* [`PluginOptions`](../../../docusaurus-plugin-typedoc/index/interfaces/PluginOptions.md) +- [`PluginOptions`](../../../docusaurus-plugin-typedoc/core/interfaces/PluginOptions.md) ## Properties @@ -71,35 +16,29 @@ Describes the options declared by the plugin. > **anchorPrefix**: `string` -Custom anchor prefix when anchoring to in-page symbols. - -#### Defined in +**Defined in**: [packages/typedoc-plugin-markdown/src/types/options.ts:11](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/options.ts#L11) -[packages/typedoc-plugin-markdown/src/types/options.ts:11](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/options.ts#L11) +Custom anchor prefix when anchoring to in-page symbols. *** ### blockTagsPreserveOrder -> **blockTagsPreserveOrder**: `string`\[] - -Specifies comment block tags that should preserve their position. +> **blockTagsPreserveOrder**: `string`[] -#### Defined in +**Defined in**: [packages/typedoc-plugin-markdown/src/types/options.ts:16](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/options.ts#L16) -[packages/typedoc-plugin-markdown/src/types/options.ts:16](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/options.ts#L16) +Specifies comment block tags that should preserve their position. *** ### classPropertiesFormat -> **classPropertiesFormat**: `"table"` | `"list"` | `"htmlTable"` +> **classPropertiesFormat**: `"table"` \| `"list"` \| `"htmlTable"` -Sets the format of property groups for classes. - -#### Defined in +**Defined in**: [packages/typedoc-plugin-markdown/src/types/options.ts:21](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/options.ts#L21) -[packages/typedoc-plugin-markdown/src/types/options.ts:21](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/options.ts#L21) +Sets the format of property groups for classes. *** @@ -107,11 +46,9 @@ Sets the format of property groups for classes. > **entryFileName**: `string` -The file name of the entry page. +**Defined in**: [packages/typedoc-plugin-markdown/src/types/options.ts:26](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/options.ts#L26) -#### Defined in - -[packages/typedoc-plugin-markdown/src/types/options.ts:26](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/options.ts#L26) +The file name of the entry page. *** @@ -119,23 +56,19 @@ The file name of the entry page. > **entryModule**: `string` -The name of a module that should act as the root page for the documentation. +**Defined in**: [packages/typedoc-plugin-markdown/src/types/options.ts:31](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/options.ts#L31) -#### Defined in - -[packages/typedoc-plugin-markdown/src/types/options.ts:31](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/options.ts#L31) +The name of a module that should act as the root page for the documentation. *** ### enumMembersFormat -> **enumMembersFormat**: `"table"` | `"list"` | `"htmlTable"` - -Sets the format of enumeration members. +> **enumMembersFormat**: `"table"` \| `"list"` \| `"htmlTable"` -#### Defined in +**Defined in**: [packages/typedoc-plugin-markdown/src/types/options.ts:36](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/options.ts#L36) -[packages/typedoc-plugin-markdown/src/types/options.ts:36](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/options.ts#L36) +Sets the format of enumeration members. *** @@ -143,25 +76,21 @@ Sets the format of enumeration members. > **excludeGroups**: `boolean` +**Defined in**: [packages/typedoc-plugin-markdown/src/types/options.ts:41](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/options.ts#L41) + #### Deprecated This option has been renamed hideGroupHeadings to better reflect its purpose. -#### Defined in - -[packages/typedoc-plugin-markdown/src/types/options.ts:41](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/options.ts#L41) - *** ### excludeScopesInPaths > **excludeScopesInPaths**: `boolean` -Exclude writing @ scope directories in paths. - -#### Defined in +**Defined in**: [packages/typedoc-plugin-markdown/src/types/options.ts:46](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/options.ts#L46) -[packages/typedoc-plugin-markdown/src/types/options.ts:46](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/options.ts#L46) +Exclude writing @ scope directories in paths. *** @@ -169,11 +98,9 @@ Exclude writing @ scope directories in paths. > **expandObjects**: `boolean` -Expand objects inside declarations. - -#### Defined in +**Defined in**: [packages/typedoc-plugin-markdown/src/types/options.ts:51](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/options.ts#L51) -[packages/typedoc-plugin-markdown/src/types/options.ts:51](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/options.ts#L51) +Expand objects inside declarations. *** @@ -181,11 +108,9 @@ Expand objects inside declarations. > **expandParameters**: `boolean` -Expand parameters in signature parentheses to display type information. - -#### Defined in +**Defined in**: [packages/typedoc-plugin-markdown/src/types/options.ts:56](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/options.ts#L56) -[packages/typedoc-plugin-markdown/src/types/options.ts:56](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/options.ts#L56) +Expand parameters in signature parentheses to display type information. *** @@ -193,11 +118,9 @@ Expand parameters in signature parentheses to display type information. > **fileExtension**: `string` -Specify the file extension for generated output files. +**Defined in**: [packages/typedoc-plugin-markdown/src/types/options.ts:61](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/options.ts#L61) -#### Defined in - -[packages/typedoc-plugin-markdown/src/types/options.ts:61](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/options.ts#L61) +Specify the file extension for generated output files. *** @@ -205,11 +128,9 @@ Specify the file extension for generated output files. > **flattenOutputFiles**: `boolean` -Flatten output files to a single directory. - -#### Defined in +**Defined in**: [packages/typedoc-plugin-markdown/src/types/options.ts:66](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/options.ts#L66) -[packages/typedoc-plugin-markdown/src/types/options.ts:66](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/options.ts#L66) +Flatten output files to a single directory. *** @@ -217,11 +138,9 @@ Flatten output files to a single directory. > **formatWithPrettier**: `boolean` -Apply additional output formatting with Prettier. - -#### Defined in +**Defined in**: [packages/typedoc-plugin-markdown/src/types/options.ts:71](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/options.ts#L71) -[packages/typedoc-plugin-markdown/src/types/options.ts:71](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/options.ts#L71) +Apply additional output formatting with Prettier. *** @@ -229,11 +148,9 @@ Apply additional output formatting with Prettier. > **hideBreadcrumbs**: `boolean` -Do not print breadcrumbs. - -#### Defined in +**Defined in**: [packages/typedoc-plugin-markdown/src/types/options.ts:76](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/options.ts#L76) -[packages/typedoc-plugin-markdown/src/types/options.ts:76](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/options.ts#L76) +Do not print breadcrumbs. *** @@ -241,11 +158,9 @@ Do not print breadcrumbs. > **hideGroupHeadings**: `boolean` -Excludes grouping by kind so all members are rendered at the same level. - -#### Defined in +**Defined in**: [packages/typedoc-plugin-markdown/src/types/options.ts:81](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/options.ts#L81) -[packages/typedoc-plugin-markdown/src/types/options.ts:81](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/options.ts#L81) +Excludes grouping by kind so all members are rendered at the same level. *** @@ -253,11 +168,9 @@ Excludes grouping by kind so all members are rendered at the same level. > **hidePageHeader**: `boolean` -Do not print page header. - -#### Defined in +**Defined in**: [packages/typedoc-plugin-markdown/src/types/options.ts:86](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/options.ts#L86) -[packages/typedoc-plugin-markdown/src/types/options.ts:86](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/options.ts#L86) +Do not print page header. *** @@ -265,47 +178,39 @@ Do not print page header. > **hidePageTitle**: `boolean` -Do not print page title. - -#### Defined in +**Defined in**: [packages/typedoc-plugin-markdown/src/types/options.ts:91](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/options.ts#L91) -[packages/typedoc-plugin-markdown/src/types/options.ts:91](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/options.ts#L91) +Do not print page title. *** ### indexFormat -> **indexFormat**: `"table"` | `"list"` | `"htmlTable"` +> **indexFormat**: `"table"` \| `"list"` \| `"htmlTable"` -Sets the format of index items. +**Defined in**: [packages/typedoc-plugin-markdown/src/types/options.ts:96](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/options.ts#L96) -#### Defined in - -[packages/typedoc-plugin-markdown/src/types/options.ts:96](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/options.ts#L96) +Sets the format of index items. *** ### interfacePropertiesFormat -> **interfacePropertiesFormat**: `"table"` | `"list"` | `"htmlTable"` - -Sets the format of property groups for interfaces. +> **interfacePropertiesFormat**: `"table"` \| `"list"` \| `"htmlTable"` -#### Defined in +**Defined in**: [packages/typedoc-plugin-markdown/src/types/options.ts:101](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/options.ts#L101) -[packages/typedoc-plugin-markdown/src/types/options.ts:101](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/options.ts#L101) +Sets the format of property groups for interfaces. *** ### membersWithOwnFile -> **membersWithOwnFile**: (`"Enum"` | `"Variable"` | `"Function"` | `"Class"` | `"Interface"` | `"TypeAlias"`)\[] - -Determines which members are exported to their own file. +> **membersWithOwnFile**: (`"Enum"` \| `"Variable"` \| `"Function"` \| `"Class"` \| `"Interface"` \| `"TypeAlias"`)[] -#### Defined in +**Defined in**: [packages/typedoc-plugin-markdown/src/types/options.ts:106](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/options.ts#L106) -[packages/typedoc-plugin-markdown/src/types/options.ts:106](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/options.ts#L106) +Determines which members are exported to their own file. *** @@ -313,11 +218,9 @@ Determines which members are exported to their own file. > **mergeReadme**: `boolean` -Appends the documentation index page to the readme page. - -#### Defined in +**Defined in**: [packages/typedoc-plugin-markdown/src/types/options.ts:118](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/options.ts#L118) -[packages/typedoc-plugin-markdown/src/types/options.ts:118](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/options.ts#L118) +Appends the documentation index page to the readme page. *** @@ -325,11 +228,9 @@ Appends the documentation index page to the readme page. > **modulesFileName**: `string` -The file name of the separate modules / index page. - -#### Defined in +**Defined in**: [packages/typedoc-plugin-markdown/src/types/options.ts:123](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/options.ts#L123) -[packages/typedoc-plugin-markdown/src/types/options.ts:123](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/options.ts#L123) +The file name of the separate modules / index page. *** @@ -337,6 +238,8 @@ The file name of the separate modules / index page. > **navigationModel**: `object` +**Defined in**: [packages/typedoc-plugin-markdown/src/types/options.ts:128](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/options.ts#L128) + #### ~~excludeGroups~~ > **excludeGroups**: `boolean` @@ -353,21 +256,15 @@ The file name of the separate modules / index page. This option has been deprecated in favour of TypeDoc `navigation` option. -#### Defined in - -[packages/typedoc-plugin-markdown/src/types/options.ts:128](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/options.ts#L128) - *** ### outputFileStrategy -> **outputFileStrategy**: `"members"` | `"modules"` +> **outputFileStrategy**: `"members"` \| `"modules"` -Determines how output files are generated. +**Defined in**: [packages/typedoc-plugin-markdown/src/types/options.ts:137](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/options.ts#L137) -#### Defined in - -[packages/typedoc-plugin-markdown/src/types/options.ts:137](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/options.ts#L137) +Determines how output files are generated. *** @@ -375,35 +272,31 @@ Determines how output files are generated. > **pageTitleTemplates**: `object` +**Defined in**: [packages/typedoc-plugin-markdown/src/types/options.ts:142](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/options.ts#L142) + Change specific text placeholders in the template. #### index -> **index**: `string` | (`name`) => `string` +> **index**: `string` \| (`name`) => `string` #### member -> **member**: `string` | (`name`) => `string` +> **member**: `string` \| (`name`) => `string` #### module -> **module**: `string` | (`name`) => `string` - -#### Defined in - -[packages/typedoc-plugin-markdown/src/types/options.ts:142](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/options.ts#L142) +> **module**: `string` \| (`name`) => `string` *** ### parametersFormat -> **parametersFormat**: `"table"` | `"list"` | `"htmlTable"` - -Sets the format of parameter and type parameter groups. +> **parametersFormat**: `"table"` \| `"list"` \| `"htmlTable"` -#### Defined in +**Defined in**: [packages/typedoc-plugin-markdown/src/types/options.ts:155](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/options.ts#L155) -[packages/typedoc-plugin-markdown/src/types/options.ts:155](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/options.ts#L155) +Sets the format of parameter and type parameter groups. *** @@ -411,11 +304,9 @@ Sets the format of parameter and type parameter groups. > **preserveAnchorCasing**: `boolean` -Preserve anchor casing when generating link to symbols. - -#### Defined in +**Defined in**: [packages/typedoc-plugin-markdown/src/types/options.ts:160](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/options.ts#L160) -[packages/typedoc-plugin-markdown/src/types/options.ts:160](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/options.ts#L160) +Preserve anchor casing when generating link to symbols. *** @@ -423,35 +314,31 @@ Preserve anchor casing when generating link to symbols. > **prettierConfigFile**: `string` -Specify a custom Prettier configuration file location. - -#### Defined in +**Defined in**: [packages/typedoc-plugin-markdown/src/types/options.ts:165](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/options.ts#L165) -[packages/typedoc-plugin-markdown/src/types/options.ts:165](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/options.ts#L165) +Specify a custom Prettier configuration file location. *** -### propertiesFormat +### ~~propertiesFormat~~ -> **propertiesFormat**: `"table"` | `"list"` | `"htmlTable"` +> **propertiesFormat**: `"table"` \| `"list"` \| `"htmlTable"` -Sets the format of property groups for interfaces and classes. +**Defined in**: [packages/typedoc-plugin-markdown/src/types/options.ts:170](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/options.ts#L170) -#### Defined in +#### Deprecated -[packages/typedoc-plugin-markdown/src/types/options.ts:170](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/options.ts#L170) +This option has been deprecated in favour of `--interfacePropertiesFormat` and `--classPropertiesFormat`. *** ### propertyMembersFormat -> **propertyMembersFormat**: `"table"` | `"list"` | `"htmlTable"` - -Sets the format of style for property members for interfaces and classes. +> **propertyMembersFormat**: `"table"` \| `"list"` \| `"htmlTable"` -#### Defined in +**Defined in**: [packages/typedoc-plugin-markdown/src/types/options.ts:175](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/options.ts#L175) -[packages/typedoc-plugin-markdown/src/types/options.ts:175](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/options.ts#L175) +Sets the format of style for property members for interfaces and classes. *** @@ -459,11 +346,9 @@ Sets the format of style for property members for interfaces and classes. > **publicPath**: `string` -Specify the base path for all urls. - -#### Defined in +**Defined in**: [packages/typedoc-plugin-markdown/src/types/options.ts:180](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/options.ts#L180) -[packages/typedoc-plugin-markdown/src/types/options.ts:180](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/options.ts#L180) +Specify the base path for all urls. *** @@ -471,11 +356,9 @@ Specify the base path for all urls. > **sanitizeComments**: `boolean` -Sanitize HTML and JSX inside JsDoc comments. - -#### Defined in +**Defined in**: [packages/typedoc-plugin-markdown/src/types/options.ts:185](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/options.ts#L185) -[packages/typedoc-plugin-markdown/src/types/options.ts:185](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/options.ts#L185) +Sanitize HTML and JSX inside JsDoc comments. *** @@ -483,6 +366,8 @@ Sanitize HTML and JSX inside JsDoc comments. > **tableColumnSettings**: `object` +**Defined in**: [packages/typedoc-plugin-markdown/src/types/options.ts:190](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/options.ts#L190) + Control how table columns are configured and displayed. #### hideDefaults @@ -513,65 +398,57 @@ Control how table columns are configured and displayed. > **leftAlignHeaders**: `boolean` -#### Defined in - -[packages/typedoc-plugin-markdown/src/types/options.ts:190](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/options.ts#L190) - *** -### textContentMappings +### ~~textContentMappings~~ > **textContentMappings**: `object` -Change specific text placeholders in the template. +**Defined in**: [packages/typedoc-plugin-markdown/src/types/options.ts:203](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/options.ts#L203) -##### header.title +##### ~~header.title~~ > **header.title**: `string` -##### breadcrumbs.home +##### ~~breadcrumbs.home~~ > **breadcrumbs.home**: `string` -##### title.indexPage +##### ~~title.indexPage~~ > **title.indexPage**: `string` -##### title.memberPage +##### ~~title.memberPage~~ > **title.memberPage**: `string` -##### title.modulePage +##### ~~title.modulePage~~ > **title.modulePage**: `string` -#### Defined in +#### Deprecated -[packages/typedoc-plugin-markdown/src/types/options.ts:203](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/options.ts#L203) +This option has been deprecated in favour of `--pageTitleTemplates`. *** ### typeDeclarationFormat -> **typeDeclarationFormat**: `"table"` | `"list"` | `"htmlTable"` - -Sets the format of style for type declaration members. +> **typeDeclarationFormat**: `"table"` \| `"list"` \| `"htmlTable"` -#### Defined in +**Defined in**: [packages/typedoc-plugin-markdown/src/types/options.ts:214](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/options.ts#L214) -[packages/typedoc-plugin-markdown/src/types/options.ts:214](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/options.ts#L214) +Sets the format of style for type declaration members. *** ### typeDeclarationVisibility -> **typeDeclarationVisibility**: `"compact"` | `"verbose"` +> **typeDeclarationVisibility**: `"compact"` \| `"verbose"` -Set the visibility level for type declaration documentation. - -#### Defined in +**Defined in**: [packages/typedoc-plugin-markdown/src/types/options.ts:219](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/options.ts#L219) -[packages/typedoc-plugin-markdown/src/types/options.ts:219](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/options.ts#L219) +Set the visibility level for type declaration documentation. *** @@ -579,11 +456,9 @@ Set the visibility level for type declaration documentation. > **useCodeBlocks**: `boolean` -Wraps signatures and declarations in code blocks. - -#### Defined in +**Defined in**: [packages/typedoc-plugin-markdown/src/types/options.ts:224](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/options.ts#L224) -[packages/typedoc-plugin-markdown/src/types/options.ts:224](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/options.ts#L224) +Wraps signatures and declarations in code blocks. *** @@ -591,11 +466,9 @@ Wraps signatures and declarations in code blocks. > **useHTMLAnchors**: `boolean` -Add HTML named anchors to headings and table rows. - -#### Defined in +**Defined in**: [packages/typedoc-plugin-markdown/src/types/options.ts:229](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/options.ts#L229) -[packages/typedoc-plugin-markdown/src/types/options.ts:229](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/options.ts#L229) +Add HTML anchors to page headings. *** @@ -603,8 +476,6 @@ Add HTML named anchors to headings and table rows. > **useHTMLEncodedBrackets**: `boolean` -Use HTML encoded entities for angle brackets. - -#### Defined in +**Defined in**: [packages/typedoc-plugin-markdown/src/types/options.ts:234](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/options.ts#L234) -[packages/typedoc-plugin-markdown/src/types/options.ts:234](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/options.ts#L234) +Use HTML encoded entities for angle brackets. diff --git a/devguide/typedoc-plugin-markdown/types/interfaces/TemplateMapping.md b/devguide/typedoc-plugin-markdown/types/interfaces/TemplateMapping.md index 05d1950e6..c5f1e01ce 100644 --- a/devguide/typedoc-plugin-markdown/types/interfaces/TemplateMapping.md +++ b/devguide/typedoc-plugin-markdown/types/interfaces/TemplateMapping.md @@ -2,17 +2,17 @@ # Interface: TemplateMapping +**Defined in**: [packages/typedoc-plugin-markdown/src/types/theme.ts:40](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/theme.ts#L40) + Defines how reflections are mapped to urls. ## Properties ### directory -> **directory**: `null` | `string` - -#### Defined in +> **directory**: `null` \| `string` -[packages/typedoc-plugin-markdown/src/types/theme.ts:40](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/theme.ts#L40) +**Defined in**: [packages/typedoc-plugin-markdown/src/types/theme.ts:41](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/theme.ts#L41) *** @@ -20,9 +20,7 @@ Defines how reflections are mapped to urls. > **template**: `any` -#### Defined in - -[packages/typedoc-plugin-markdown/src/types/theme.ts:41](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/theme.ts#L41) +**Defined in**: [packages/typedoc-plugin-markdown/src/types/theme.ts:42](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/theme.ts#L42) *** @@ -30,6 +28,4 @@ Defines how reflections are mapped to urls. > **kind**: [`ReflectionKind`](https://typedoc.org/api/enums/Models.ReflectionKind-1.html) -#### Defined in - -[packages/typedoc-plugin-markdown/src/types/theme.ts:42](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/theme.ts#L42) +**Defined in**: [packages/typedoc-plugin-markdown/src/types/theme.ts:43](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/theme.ts#L43) diff --git a/devguide/typedoc-plugin-markdown/types/interfaces/TranslatableStrings.md b/devguide/typedoc-plugin-markdown/types/interfaces/TranslatableStrings.md index 499e381e0..703e6f5ed 100644 --- a/devguide/typedoc-plugin-markdown/types/interfaces/TranslatableStrings.md +++ b/devguide/typedoc-plugin-markdown/types/interfaces/TranslatableStrings.md @@ -2,6 +2,8 @@ # Interface: TranslatableStrings +**Defined in**: [packages/typedoc-plugin-markdown/src/types/internationalization.ts:10](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/internationalization.ts#L10) + The model of translatable strings specific to the Markdown theme. ## Properties @@ -10,9 +12,7 @@ The model of translatable strings specific to the Markdown theme. > **theme\_default\_value**: `string` -#### Defined in - -[packages/typedoc-plugin-markdown/src/types/internationalization.ts:11](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/internationalization.ts#L11) +**Defined in**: [packages/typedoc-plugin-markdown/src/types/internationalization.ts:11](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/internationalization.ts#L11) *** @@ -20,9 +20,7 @@ The model of translatable strings specific to the Markdown theme. > **theme\_default\_type**: `string` -#### Defined in - -[packages/typedoc-plugin-markdown/src/types/internationalization.ts:12](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/internationalization.ts#L12) +**Defined in**: [packages/typedoc-plugin-markdown/src/types/internationalization.ts:12](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/internationalization.ts#L12) *** @@ -30,9 +28,7 @@ The model of translatable strings specific to the Markdown theme. > **theme\_description**: `string` -#### Defined in - -[packages/typedoc-plugin-markdown/src/types/internationalization.ts:13](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/internationalization.ts#L13) +**Defined in**: [packages/typedoc-plugin-markdown/src/types/internationalization.ts:13](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/internationalization.ts#L13) *** @@ -40,9 +36,7 @@ The model of translatable strings specific to the Markdown theme. > **theme\_event**: `string` -#### Defined in - -[packages/typedoc-plugin-markdown/src/types/internationalization.ts:14](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/internationalization.ts#L14) +**Defined in**: [packages/typedoc-plugin-markdown/src/types/internationalization.ts:14](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/internationalization.ts#L14) *** @@ -50,9 +44,7 @@ The model of translatable strings specific to the Markdown theme. > **theme\_re\_exports**: `string` -#### Defined in - -[packages/typedoc-plugin-markdown/src/types/internationalization.ts:15](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/internationalization.ts#L15) +**Defined in**: [packages/typedoc-plugin-markdown/src/types/internationalization.ts:15](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/internationalization.ts#L15) *** @@ -60,9 +52,7 @@ The model of translatable strings specific to the Markdown theme. > **theme\_renames\_and\_re\_exports**: `string` -#### Defined in - -[packages/typedoc-plugin-markdown/src/types/internationalization.ts:16](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/internationalization.ts#L16) +**Defined in**: [packages/typedoc-plugin-markdown/src/types/internationalization.ts:16](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/internationalization.ts#L16) *** @@ -70,9 +60,7 @@ The model of translatable strings specific to the Markdown theme. > **theme\_extends**: `string` -#### Defined in - -[packages/typedoc-plugin-markdown/src/types/internationalization.ts:17](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/internationalization.ts#L17) +**Defined in**: [packages/typedoc-plugin-markdown/src/types/internationalization.ts:17](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/internationalization.ts#L17) *** @@ -80,9 +68,7 @@ The model of translatable strings specific to the Markdown theme. > **theme\_extended\_by**: `string` -#### Defined in - -[packages/typedoc-plugin-markdown/src/types/internationalization.ts:18](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/internationalization.ts#L18) +**Defined in**: [packages/typedoc-plugin-markdown/src/types/internationalization.ts:18](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/internationalization.ts#L18) *** @@ -90,9 +76,7 @@ The model of translatable strings specific to the Markdown theme. > **theme\_globals**: `string` -#### Defined in - -[packages/typedoc-plugin-markdown/src/types/internationalization.ts:19](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/internationalization.ts#L19) +**Defined in**: [packages/typedoc-plugin-markdown/src/types/internationalization.ts:19](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/internationalization.ts#L19) *** @@ -100,9 +84,7 @@ The model of translatable strings specific to the Markdown theme. > **theme\_member**: `string` -#### Defined in - -[packages/typedoc-plugin-markdown/src/types/internationalization.ts:20](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/internationalization.ts#L20) +**Defined in**: [packages/typedoc-plugin-markdown/src/types/internationalization.ts:20](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/internationalization.ts#L20) *** @@ -110,9 +92,7 @@ The model of translatable strings specific to the Markdown theme. > **theme\_member\_plural**: `string` -#### Defined in - -[packages/typedoc-plugin-markdown/src/types/internationalization.ts:21](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/internationalization.ts#L21) +**Defined in**: [packages/typedoc-plugin-markdown/src/types/internationalization.ts:21](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/internationalization.ts#L21) *** @@ -120,9 +100,7 @@ The model of translatable strings specific to the Markdown theme. > **theme\_modifier**: `string` -#### Defined in - -[packages/typedoc-plugin-markdown/src/types/internationalization.ts:22](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/internationalization.ts#L22) +**Defined in**: [packages/typedoc-plugin-markdown/src/types/internationalization.ts:22](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/internationalization.ts#L22) *** @@ -130,9 +108,15 @@ The model of translatable strings specific to the Markdown theme. > **theme\_name**: `string` -#### Defined in +**Defined in**: [packages/typedoc-plugin-markdown/src/types/internationalization.ts:23](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/internationalization.ts#L23) + +*** + +### theme\_package -[packages/typedoc-plugin-markdown/src/types/internationalization.ts:23](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/internationalization.ts#L23) +> **theme\_package**: `string` + +**Defined in**: [packages/typedoc-plugin-markdown/src/types/internationalization.ts:24](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/internationalization.ts#L24) *** @@ -140,9 +124,7 @@ The model of translatable strings specific to the Markdown theme. > **theme\_packages**: `string` -#### Defined in - -[packages/typedoc-plugin-markdown/src/types/internationalization.ts:24](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/internationalization.ts#L24) +**Defined in**: [packages/typedoc-plugin-markdown/src/types/internationalization.ts:25](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/internationalization.ts#L25) *** @@ -150,9 +132,7 @@ The model of translatable strings specific to the Markdown theme. > **theme\_type**: `string` -#### Defined in - -[packages/typedoc-plugin-markdown/src/types/internationalization.ts:25](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/internationalization.ts#L25) +**Defined in**: [packages/typedoc-plugin-markdown/src/types/internationalization.ts:26](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/internationalization.ts#L26) *** @@ -160,9 +140,7 @@ The model of translatable strings specific to the Markdown theme. > **theme\_value**: `string` -#### Defined in - -[packages/typedoc-plugin-markdown/src/types/internationalization.ts:26](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/internationalization.ts#L26) +**Defined in**: [packages/typedoc-plugin-markdown/src/types/internationalization.ts:27](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/internationalization.ts#L27) *** @@ -170,6 +148,4 @@ The model of translatable strings specific to the Markdown theme. > **theme\_version**: `string` -#### Defined in - -[packages/typedoc-plugin-markdown/src/types/internationalization.ts:27](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/internationalization.ts#L27) +**Defined in**: [packages/typedoc-plugin-markdown/src/types/internationalization.ts:28](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/internationalization.ts#L28) diff --git a/devguide/typedoc-plugin-markdown/types/interfaces/UrlMapping.md b/devguide/typedoc-plugin-markdown/types/interfaces/UrlMapping.md index 082a0fbb8..0ee962ce1 100644 --- a/devguide/typedoc-plugin-markdown/types/interfaces/UrlMapping.md +++ b/devguide/typedoc-plugin-markdown/types/interfaces/UrlMapping.md @@ -1,23 +1,16 @@ [Developer Guide](../../../README.md) / [typedoc-plugin-markdown](../../README.md) / [types](../README.md) / UrlMapping -# Interface: UrlMapping\ +# Interface: UrlMapping\ -The model used to define the URL mapping structure. - -## Contents +**Defined in**: [packages/typedoc-plugin-markdown/src/types/theme.ts:18](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/theme.ts#L18) -* [Type Parameters](#type-parameters) -* [Properties](#properties) - * [url](#url) - * [model](#model) - * [group?](#group) - * [template()](#template) +The model used to define the URL mapping structure. ## Type Parameters | Type Parameter | -| -------------- | -| `Model` | +| ------ | +| `Model` | ## Properties @@ -25,19 +18,15 @@ The model used to define the URL mapping structure. > **url**: `string` -#### Defined in - -[packages/typedoc-plugin-markdown/src/types/theme.ts:19](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/theme.ts#L19) +**Defined in**: [packages/typedoc-plugin-markdown/src/types/theme.ts:19](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/theme.ts#L19) *** ### model -> **model**: `Model` - -#### Defined in +> **model**: [`Model`](../../../interfaces/typedoc-plugin-markdown.types.UrlMapping.html#model) -[packages/typedoc-plugin-markdown/src/types/theme.ts:20](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/theme.ts#L20) +**Defined in**: [packages/typedoc-plugin-markdown/src/types/theme.ts:20](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/theme.ts#L20) *** @@ -45,9 +34,7 @@ The model used to define the URL mapping structure. > `optional` **group**: `string` -#### Defined in - -[packages/typedoc-plugin-markdown/src/types/theme.ts:21](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/theme.ts#L21) +**Defined in**: [packages/typedoc-plugin-markdown/src/types/theme.ts:21](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/theme.ts#L21) *** @@ -55,16 +42,14 @@ The model used to define the URL mapping structure. > **template**: (`data`) => `string` +**Defined in**: [packages/typedoc-plugin-markdown/src/types/theme.ts:22](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/theme.ts#L22) + #### Parameters -| Parameter | Type | -| --------- | -------------------------------------------------------------------------- | -| `data` | [`MarkdownPageEvent`](../../events/classes/MarkdownPageEvent.md)\<`Model`> | +| Parameter | Type | +| ------ | ------ | +| `data` | [`MarkdownPageEvent`](../../events/classes/MarkdownPageEvent.md)\<[`Model`](../../../interfaces/typedoc-plugin-markdown.types.UrlMapping.html#model)\> | #### Returns `string` - -#### Defined in - -[packages/typedoc-plugin-markdown/src/types/theme.ts:22](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/theme.ts#L22) diff --git a/devguide/typedoc-plugin-markdown/types/interfaces/UrlOption.md b/devguide/typedoc-plugin-markdown/types/interfaces/UrlOption.md index ca6517730..aba0f4742 100644 --- a/devguide/typedoc-plugin-markdown/types/interfaces/UrlOption.md +++ b/devguide/typedoc-plugin-markdown/types/interfaces/UrlOption.md @@ -2,6 +2,8 @@ # Interface: UrlOption +**Defined in**: [packages/typedoc-plugin-markdown/src/types/theme.ts:49](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/theme.ts#L49) + Used internally when building the URL mapping. ## Properties @@ -10,19 +12,15 @@ Used internally when building the URL mapping. > `optional` **parentUrl**: `string` -#### Defined in - -[packages/typedoc-plugin-markdown/src/types/theme.ts:49](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/theme.ts#L49) +**Defined in**: [packages/typedoc-plugin-markdown/src/types/theme.ts:50](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/theme.ts#L50) *** ### directory? -> `optional` **directory**: `null` | `string` +> `optional` **directory**: `null` \| `string` -#### Defined in - -[packages/typedoc-plugin-markdown/src/types/theme.ts:50](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/theme.ts#L50) +**Defined in**: [packages/typedoc-plugin-markdown/src/types/theme.ts:51](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/theme.ts#L51) *** @@ -30,19 +28,15 @@ Used internally when building the URL mapping. > `optional` **forceDirectory**: `boolean` -#### Defined in - -[packages/typedoc-plugin-markdown/src/types/theme.ts:51](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/theme.ts#L51) +**Defined in**: [packages/typedoc-plugin-markdown/src/types/theme.ts:52](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/theme.ts#L52) *** ### outputFileStrategy? -> `optional` **outputFileStrategy**: [`OutputFileStrategy`](../../options/namespaces/maps/enumerations/OutputFileStrategy.md) +> `optional` **outputFileStrategy**: [`OutputFileStrategy`](../../options/namespaces/maps/README.md#outputfilestrategy) -#### Defined in - -[packages/typedoc-plugin-markdown/src/types/theme.ts:52](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/theme.ts#L52) +**Defined in**: [packages/typedoc-plugin-markdown/src/types/theme.ts:53](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/theme.ts#L53) *** @@ -50,9 +44,7 @@ Used internally when building the URL mapping. > `optional` **entryModule**: `string` -#### Defined in - -[packages/typedoc-plugin-markdown/src/types/theme.ts:53](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/theme.ts#L53) +**Defined in**: [packages/typedoc-plugin-markdown/src/types/theme.ts:54](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/theme.ts#L54) *** @@ -60,9 +52,7 @@ Used internally when building the URL mapping. > `optional` **entryFileName**: `string` -#### Defined in - -[packages/typedoc-plugin-markdown/src/types/theme.ts:54](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/theme.ts#L54) +**Defined in**: [packages/typedoc-plugin-markdown/src/types/theme.ts:55](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/theme.ts#L55) *** @@ -70,6 +60,4 @@ Used internally when building the URL mapping. > `optional` **group**: `string` -#### Defined in - -[packages/typedoc-plugin-markdown/src/types/theme.ts:55](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/theme.ts#L55) +**Defined in**: [packages/typedoc-plugin-markdown/src/types/theme.ts:56](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/theme.ts#L56) diff --git a/devguide/typedoc-plugin-markdown/types/type-aliases/RenderTemplate.md b/devguide/typedoc-plugin-markdown/types/type-aliases/RenderTemplate.md deleted file mode 100644 index 57ea5e644..000000000 --- a/devguide/typedoc-plugin-markdown/types/type-aliases/RenderTemplate.md +++ /dev/null @@ -1,27 +0,0 @@ -[Developer Guide](../../../README.md) / [typedoc-plugin-markdown](../../README.md) / [types](../README.md) / RenderTemplate - -# Type Alias: RenderTemplate()\ - -> **RenderTemplate**\<`T`>: (`data`) => `string` - -Defines the template type to use for rendering. - -## Type Parameters - -| Type Parameter | -| -------------- | -| `T` | - -## Parameters - -| Parameter | Type | -| --------- | ---- | -| `data` | `T` | - -## Returns - -`string` - -## Defined in - -[packages/typedoc-plugin-markdown/src/types/theme.ts:61](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/theme.ts#L61) diff --git a/devguide/typedoc-plugin-remark/README.md b/devguide/typedoc-plugin-remark/README.md index be12e1c96..23fc2101b 100644 --- a/devguide/typedoc-plugin-remark/README.md +++ b/devguide/typedoc-plugin-remark/README.md @@ -4,19 +4,15 @@ "typedoc-plugin-remark" is a utility package that pipes output though specified remark plugins. -## Contents +Package features include: -* [What Does the Package Do?](#what-does-the-package-do) - -## What Does the Package Do? - -* Exposes some additional options to TypeDoc. -* Initializes a new remark processor and transform that syntax tree (mdast) using plugins. +- Exposes some additional options to TypeDoc. +- Initializes a new remark processor and transform that syntax tree (mdast) using plugins. ## Modules -| Module | Description | -| ---------------------------- | ------------------------------------------------------ | -| [index](index/README.md) | The plugin entrypoint and bootstrapping of the plugin. | -| [options](options/README.md) | All plugin types are exported from this module. | -| [types](types/README.md) | All plugin types are exported from this module. | +| Module | Description | +| ------ | ------ | +| [core](core/README.md) | The plugin entrypoint and bootstrapping of the plugin. | +| [options](options/README.md) | All plugin types are exported from this module. | +| [types](types/README.md) | All plugin types are exported from this module. | diff --git a/devguide/typedoc-plugin-remark/core/README.md b/devguide/typedoc-plugin-remark/core/README.md new file mode 100644 index 000000000..717a18593 --- /dev/null +++ b/devguide/typedoc-plugin-remark/core/README.md @@ -0,0 +1,29 @@ +[Developer Guide](../../README.md) / [typedoc-plugin-remark](../README.md) / core + +# core + +The plugin entrypoint and bootstrapping of the plugin. + +## Interfaces + +| Interface | Description | +| ------ | ------ | +| [PluginOptions](interfaces/PluginOptions.md) | Describes the options declared by the plugin. | + +## Functions + +### load() + +> **load**(`app`): `void` + +**Defined in**: [index.ts:17](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-remark/src/index.ts#L17) + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `app` | [`Application`](https://typedoc.org/api/classes/Application.html) | + +#### Returns + +`void` diff --git a/devguide/typedoc-plugin-remark/core/interfaces/PluginOptions.md b/devguide/typedoc-plugin-remark/core/interfaces/PluginOptions.md new file mode 100644 index 000000000..f8e9887e6 --- /dev/null +++ b/devguide/typedoc-plugin-remark/core/interfaces/PluginOptions.md @@ -0,0 +1,49 @@ +[Developer Guide](../../../README.md) / [typedoc-plugin-remark](../../README.md) / [core](../README.md) / PluginOptions + +# Interface: PluginOptions + +**Defined in**: [types/options.ts:7](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-remark/src/types/options.ts#L7) + +Describes the options declared by the plugin. + +## Properties + +### defaultRemarkPlugins + +> **defaultRemarkPlugins**: `object` + +**Defined in**: [types/options.ts:11](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-remark/src/types/options.ts#L11) + +A set of flags that control the enabling or disabling of remark plugins that are loaded by default. + +#### gfm + +> **gfm**: `boolean` + +#### frontmatter + +> **frontmatter**: `boolean` + +#### mdx + +> **mdx**: `boolean` + +*** + +### remarkPlugins + +> **remarkPlugins**: [`RemarkPlugin`](../../types/README.md#remarkplugin)[] + +**Defined in**: [types/options.ts:16](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-remark/src/types/options.ts#L16) + +An array of remark plugin names to be executed. + +*** + +### remarkStringifyOptions + +> **remarkStringifyOptions**: `Record`\<`string`, `any`\> + +**Defined in**: [types/options.ts:21](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-remark/src/types/options.ts#L21) + +Custom options for the remark-stringify plugin. diff --git a/devguide/typedoc-plugin-remark/index/README.md b/devguide/typedoc-plugin-remark/index/README.md deleted file mode 100644 index d06463a82..000000000 --- a/devguide/typedoc-plugin-remark/index/README.md +++ /dev/null @@ -1,23 +0,0 @@ -[Developer Guide](../../README.md) / [typedoc-plugin-remark](../README.md) / index - -# index - -The plugin entrypoint and bootstrapping of the plugin. - -## load() - -> **load**(`app`): `void` - -### Parameters - -| Parameter | Type | -| --------- | ----------------------------------------------------------------- | -| `app` | [`Application`](https://typedoc.org/api/classes/Application.html) | - -### Returns - -`void` - -### Defined in - -[index.ts:13](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-remark/src/index.ts#L13) diff --git a/devguide/typedoc-plugin-remark/options/README.md b/devguide/typedoc-plugin-remark/options/README.md index dc1a72ad5..0eeb93a17 100644 --- a/devguide/typedoc-plugin-remark/options/README.md +++ b/devguide/typedoc-plugin-remark/options/README.md @@ -4,11 +4,8 @@ All plugin types are exported from this module. -## Index +## Namespaces -### Namespaces - -| Namespace | Description | -| ------------------------------------------------- | ----------- | -| [declarations](namespaces/declarations/README.md) | - | -| [helpers](namespaces/helpers/README.md) | - | +| Namespace | Description | +| ------ | ------ | +| [declarations](namespaces/declarations/README.md) | - | diff --git a/devguide/typedoc-plugin-remark/options/namespaces/declarations/README.md b/devguide/typedoc-plugin-remark/options/namespaces/declarations/README.md index 8fa9781c0..94a4bb5cb 100644 --- a/devguide/typedoc-plugin-remark/options/namespaces/declarations/README.md +++ b/devguide/typedoc-plugin-remark/options/namespaces/declarations/README.md @@ -2,76 +2,100 @@ # declarations -## Contents +## Variables -* [remarkPlugins](#remarkplugins) -* [remarkStringifyOptions](#remarkstringifyoptions) +### remarkPlugins -## remarkPlugins +> `const` **remarkPlugins**: `Partial`\<[`DeclarationOption`](https://typedoc.org/api/types/Configuration.DeclarationOption.html)\> -> `const` **remarkPlugins**: `Partial`\<[`DeclarationOption`](https://typedoc.org/api/types/Configuration.DeclarationOption.html)> +**Defined in**: [options/declarations.ts:12](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-remark/src/options/declarations.ts#L12) -You can provide any compatible [remark plugins](https://github.com/remarkjs/remark/blob/main/doc/plugins.md) or you can write your own and reference locally. +You can include any compatible [remark plugins](https://github.com/remarkjs/remark/blob/main/doc/plugins.md) or create and reference your own locally. -Each required plugin should be individually installed. +Each plugin you wish to use must be installed individually. -Options can be passed either as an array of strings or an array of string / options. +Options can be provided as either an array of strings or an array of strings with associated options. -Please note that `remark-frontmatter`, `remark-gfm`, and `remark-mdx` are always included by default. - -### Example +#### Example ```ts -["unified-prettier","remark-github", ["remark-toc", { "maxDepth": 3 }] ] +["remark-github", ["remark-toc", { "maxDepth": 3 }] ] ``` -### Default Value +#### Initializer ```ts { - help: 'An array of remark plugin names.', + help: 'An array of remark plugin names to be executed.', type: ParameterType.Mixed, defaultValue: [], validate(value) { if (!Array.isArray(value)) { - throw new Error('remarkPlugins must be an array.'); + throw new Error('[typedoc-plugin-remark] remarkPlugins must be an array.'); } }, } ``` -### Defined in +*** + +### defaultRemarkPlugins + +> `const` **defaultRemarkPlugins**: `Partial`\<[`DeclarationOption`](https://typedoc.org/api/types/Configuration.DeclarationOption.html)\> + +**Defined in**: [options/declarations.ts:32](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-remark/src/options/declarations.ts#L32) + +By default, the plugins [`remark-gfm`](https://github.com/remarkjs/remark-gfm), [`remark-frontmatter`](https://github.com/remarkjs/remark-frontmatter), and [`remark-mdx`](https://github.com/mdx-js/mdx/tree/main/packages/remark-mdx) are included, as these are considered the most common use cases. -[options/declarations.ts:14](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-remark/src/options/declarations.ts#L14) +However, these plugins modify the default parsing behavior of remark, which may not be ideal for all scenarios. + +If you'd like to disable any of these default plugins, simply set the corresponding flag to `false`. + +#### Initializer + +```ts +{ + help: 'A set of flags that control the enabling or disabling of remark plugins that are loaded by default.', + type: ParameterType.Flags, + defaults: { + gfm: true, + frontmatter: true, + mdx: true, + }, +} +``` *** -## remarkStringifyOptions +### remarkStringifyOptions -> `const` **remarkStringifyOptions**: `Partial`\<[`DeclarationOption`](https://typedoc.org/api/types/Configuration.DeclarationOption.html)> +> `const` **remarkStringifyOptions**: `Partial`\<[`DeclarationOption`](https://typedoc.org/api/types/Configuration.DeclarationOption.html)\> -Under the hood, the `remark-stringify` plugin is used to serialize the markdown into final output. +**Defined in**: [options/declarations.ts:51](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-remark/src/options/declarations.ts#L51) + +Under the hood, the [`remark-stringify`](https://github.com/remarkjs/remark/tree/main/packages/remark-stringify) plugin is used to serialize the markdown into final output. You can pass in options to the `remark-stringify` plugin using this option. -Please see [https://github.com/remarkjs/remark/tree/main/packages/remark-stringify#options](https://github.com/remarkjs/remark/tree/main/packages/remark-stringify#options) +Please see https://github.com/remarkjs/remark/tree/main/packages/remark-stringify#options -### Example +#### Example ```ts { "bullet": "+", "fence": "~" } ``` -### Default Value +#### Initializer ```ts { help: 'Custom options for the remark-stringify plugin.', - type: ParameterType.Mixed, + type: ParameterType.Object, defaultValue: {}, + validate(value) { + if (typeof value !== 'object') { + throw new Error('[typedoc-plugin-remark] remarkStringifyOptions must be an object.'); + } + }, } ``` - -### Defined in - -[options/declarations.ts:34](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-remark/src/options/declarations.ts#L34) diff --git a/devguide/typedoc-plugin-remark/options/namespaces/helpers/README.md b/devguide/typedoc-plugin-remark/options/namespaces/helpers/README.md deleted file mode 100644 index 6d46de9a6..000000000 --- a/devguide/typedoc-plugin-remark/options/namespaces/helpers/README.md +++ /dev/null @@ -1,24 +0,0 @@ -[Developer Guide](../../../../README.md) / [typedoc-plugin-remark](../../../README.md) / [options](../../README.md) / helpers - -# helpers - -## addTableOfContents() - -> **addTableOfContents**(`event`, `remarkPlugins`, `remarkPluginsNames`, `app`): `void` - -### Parameters - -| Parameter | Type | -| -------------------- | ----------- | -| `event` | `any` | -| `remarkPlugins` | `any`\[] | -| `remarkPluginsNames` | `string`\[] | -| `app` | `any` | - -### Returns - -`void` - -### Defined in - -[options/helpers.ts:3](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-remark/src/options/helpers.ts#L3) diff --git a/devguide/typedoc-plugin-remark/types/README.md b/devguide/typedoc-plugin-remark/types/README.md index f429e14c5..9cb0ba230 100644 --- a/devguide/typedoc-plugin-remark/types/README.md +++ b/devguide/typedoc-plugin-remark/types/README.md @@ -4,10 +4,16 @@ All plugin types are exported from this module. -## Index +## Type Aliases -### Interfaces +### RemarkPlugin -| Interface | Description | -| -------------------------------------------- | --------------------------------------------- | -| [PluginOptions](interfaces/PluginOptions.md) | Describes the options declared by the plugin. | +> **RemarkPlugin**: `string` \| \[`string`, `Record`\<`string`, `any`\>\] + +**Defined in**: [types/options.ts:24](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-remark/src/types/options.ts#L24) + +## References + +### PluginOptions + +Re-exports [PluginOptions](../core/interfaces/PluginOptions.md) diff --git a/devguide/typedoc-plugin-remark/types/interfaces/PluginOptions.md b/devguide/typedoc-plugin-remark/types/interfaces/PluginOptions.md deleted file mode 100644 index b09cecae7..000000000 --- a/devguide/typedoc-plugin-remark/types/interfaces/PluginOptions.md +++ /dev/null @@ -1,29 +0,0 @@ -[Developer Guide](../../../README.md) / [typedoc-plugin-remark](../../README.md) / [types](../README.md) / PluginOptions - -# Interface: PluginOptions - -Describes the options declared by the plugin. - -## Properties - -### remarkPlugins - -> **remarkPlugins**: `any` - -An array of remark plugin names. - -#### Defined in - -[types/options.ts:11](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-remark/src/types/options.ts#L11) - -*** - -### remarkStringifyOptions - -> **remarkStringifyOptions**: `any` - -Custom options for the remark-stringify plugin. - -#### Defined in - -[types/options.ts:16](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-remark/src/types/options.ts#L16) diff --git a/devguide/typedoc-vitepress-theme/README.md b/devguide/typedoc-vitepress-theme/README.md index 1b9fe2690..3814d4e56 100644 --- a/devguide/typedoc-vitepress-theme/README.md +++ b/devguide/typedoc-vitepress-theme/README.md @@ -4,20 +4,16 @@ "typedoc-vitepress-theme" is a "theme" in the sense that it targets output for VitePress. -## Contents +Package features include: -* [What Does the Package Do?](#what-does-the-package-do) - -## What Does the Package Do? - -* Exposes some additional options to TypeDoc. -* Presets relevant typedoc-plugin-markdown options. -* Generates a sidebar json file. +- Exposes some additional options to TypeDoc. +- Presets relevant typedoc-plugin-markdown options. +- Generates a sidebar json file. ## Modules -| Module | Description | -| ---------------------------- | ------------------------------------------------------ | -| [index](index/README.md) | The plugin entrypoint and bootstrapping of the plugin. | -| [options](options/README.md) | All plugin types are exported from this module. | -| [types](types/README.md) | All plugin types are exported from this module. | +| Module | Description | +| ------ | ------ | +| [core](core/README.md) | The plugin entrypoint and bootstrapping of the plugin. | +| [options](options/README.md) | All plugin types are exported from this module. | +| [types](types/README.md) | All plugin types are exported from this module. | diff --git a/devguide/typedoc-vitepress-theme/core/README.md b/devguide/typedoc-vitepress-theme/core/README.md new file mode 100644 index 000000000..8f7ec2b50 --- /dev/null +++ b/devguide/typedoc-vitepress-theme/core/README.md @@ -0,0 +1,23 @@ +[Developer Guide](../../README.md) / [typedoc-vitepress-theme](../README.md) / core + +# core + +The plugin entrypoint and bootstrapping of the plugin. + +## Functions + +### load() + +> **load**(`app`): `void` + +**Defined in**: [index.ts:19](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-vitepress-theme/src/index.ts#L19) + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `app` | [`MarkdownApplication`](../../typedoc-plugin-markdown/types/interfaces/MarkdownApplication.md) | + +#### Returns + +`void` diff --git a/devguide/typedoc-vitepress-theme/index/README.md b/devguide/typedoc-vitepress-theme/index/README.md deleted file mode 100644 index a84493c91..000000000 --- a/devguide/typedoc-vitepress-theme/index/README.md +++ /dev/null @@ -1,23 +0,0 @@ -[Developer Guide](../../README.md) / [typedoc-vitepress-theme](../README.md) / index - -# index - -The plugin entrypoint and bootstrapping of the plugin. - -## load() - -> **load**(`app`): `void` - -### Parameters - -| Parameter | Type | -| --------- | ---------------------------------------------------------------------------------------------- | -| `app` | [`MarkdownApplication`](../../typedoc-plugin-markdown/types/interfaces/MarkdownApplication.md) | - -### Returns - -`void` - -### Defined in - -[index.ts:19](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-vitepress-theme/src/index.ts#L19) diff --git a/devguide/typedoc-vitepress-theme/options/README.md b/devguide/typedoc-vitepress-theme/options/README.md index e0d3aff77..70ced323c 100644 --- a/devguide/typedoc-vitepress-theme/options/README.md +++ b/devguide/typedoc-vitepress-theme/options/README.md @@ -4,11 +4,9 @@ All plugin types are exported from this module. -## Index +## Namespaces -### Namespaces - -| Namespace | Description | -| ------------------------------------------------- | ----------- | -| [declarations](namespaces/declarations/README.md) | - | -| [presets](namespaces/presets/README.md) | - | +| Namespace | Description | +| ------ | ------ | +| [declarations](namespaces/declarations/README.md) | - | +| [presets](namespaces/presets/README.md) | - | diff --git a/devguide/typedoc-vitepress-theme/options/namespaces/declarations/README.md b/devguide/typedoc-vitepress-theme/options/namespaces/declarations/README.md index 42e4ba2c3..02a9402c0 100644 --- a/devguide/typedoc-vitepress-theme/options/namespaces/declarations/README.md +++ b/devguide/typedoc-vitepress-theme/options/namespaces/declarations/README.md @@ -2,15 +2,14 @@ # declarations -## Contents +## Variables -* [docsRoot](#docsroot) -* [sidebar](#sidebar) - -## docsRoot +### docsRoot > `const` **docsRoot**: `object` +**Defined in**: [options/declarations.ts:28](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-vitepress-theme/src/options/declarations.ts#L28) + If TypeDoc is run from outside of the VitePress project root directory, then `docsRoot` should be set to the path of the VitePress root directory. e.g. the following file structure: @@ -33,50 +32,44 @@ Requires the following config: } ``` -### Type declaration - -| Name | Type | Default value | -| -------------- | --------------- | ----------------------------------------- | -| `help` | `string` | 'The path to the VitePress project root.' | -| `type` | `ParameterType` | ParameterType.Path | -| `defaultValue` | `string` | './' | - -### Defined in +#### Type declaration -[options/declarations.ts:28](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-vitepress-theme/src/options/declarations.ts#L28) +| Name | Type | Default value | +| ------ | ------ | ------ | +| `help` | `string` | 'The path to the VitePress project root.' | +| `type` | `ParameterType` | ParameterType.Path | +| `defaultValue` | `string` | './' | *** -## sidebar +### sidebar > `const` **sidebar**: `object` +**Defined in**: [options/declarations.ts:54](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-vitepress-theme/src/options/declarations.ts#L54) + **sidebar.autoConfiguration** Set to `false` to disable sidebar generation. Defaults to true. **sidebar.format** -Enables backward compatibility with VuePress. Available options \[`"vitepress"`, `"vuepress1"`, `"vuepress2"`]. Defaults to `"vitepress"`. +Enables backward compatibility with VuePress. Available options [`"vitepress"`, `"vuepress1"`, `"vuepress2"`]. Defaults to `"vitepress"`. **sidebar.collapsed** Determines if sidebar items with children are open or closed. Set `collapsed` to `false` to set sidebar items as open by default. -[https://vitepress.dev/reference/default-theme-sidebar#collapsible-sidebar-groups](https://vitepress.dev/reference/default-theme-sidebar#collapsible-sidebar-groups) +https://vitepress.dev/reference/default-theme-sidebar#collapsible-sidebar-groups **sidebar.pretty** Pretty format the sidebar JSON. -### Type declaration - -| Name | Type | Default value | -| -------------- | ------------------------------------------------- | ------------------------------------------------- | -| `help` | `string` | 'Configures the autogenerated VitePress sidebar.' | -| `type` | `ParameterType` | ParameterType.Mixed | -| `defaultValue` | [`Sidebar`](../../../types/interfaces/Sidebar.md) | DEFAULT\_SIDEBAR\_OPTIONS | - -### Defined in +#### Type declaration -[options/declarations.ts:54](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-vitepress-theme/src/options/declarations.ts#L54) +| Name | Type | Default value | +| ------ | ------ | ------ | +| `help` | `string` | 'Configures the autogenerated VitePress sidebar.' | +| `type` | `ParameterType` | ParameterType.Mixed | +| `defaultValue` | [`Sidebar`](../../../types/interfaces/Sidebar.md) | DEFAULT\_SIDEBAR\_OPTIONS | diff --git a/devguide/typedoc-vitepress-theme/options/namespaces/presets/README.md b/devguide/typedoc-vitepress-theme/options/namespaces/presets/README.md index ebfd9ae8f..5fef4e61c 100644 --- a/devguide/typedoc-vitepress-theme/options/namespaces/presets/README.md +++ b/devguide/typedoc-vitepress-theme/options/namespaces/presets/README.md @@ -2,18 +2,18 @@ # presets -## presets +## Variables -> `const` **presets**: `object` +### presets -### Type declaration +> `const` **presets**: `object` -| Name | Type | Default value | -| ---------------- | --------- | ------------- | -| `hidePageHeader` | `boolean` | true | -| `entryFileName` | `string` | 'index.md' | -| `out` | `string` | './api' | +**Defined in**: [options/presets.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-vitepress-theme/src/options/presets.ts#L1) -### Defined in +#### Type declaration -[options/presets.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-vitepress-theme/src/options/presets.ts#L1) +| Name | Type | Default value | +| ------ | ------ | ------ | +| `hidePageHeader` | `boolean` | true | +| `entryFileName` | `string` | 'index.md' | +| `out` | `string` | './api' | diff --git a/devguide/typedoc-vitepress-theme/types/README.md b/devguide/typedoc-vitepress-theme/types/README.md index a0899d0d8..db22ca9a4 100644 --- a/devguide/typedoc-vitepress-theme/types/README.md +++ b/devguide/typedoc-vitepress-theme/types/README.md @@ -4,11 +4,9 @@ All plugin types are exported from this module. -## Index +## Interfaces -### Interfaces - -| Interface | Description | -| -------------------------------------------- | --------------------------------------------- | +| Interface | Description | +| ------ | ------ | | [PluginOptions](interfaces/PluginOptions.md) | Describes the options declared by the plugin. | -| [Sidebar](interfaces/Sidebar.md) | - | +| [Sidebar](interfaces/Sidebar.md) | - | diff --git a/devguide/typedoc-vitepress-theme/types/interfaces/PluginOptions.md b/devguide/typedoc-vitepress-theme/types/interfaces/PluginOptions.md index 6c9b6e995..69f47ff05 100644 --- a/devguide/typedoc-vitepress-theme/types/interfaces/PluginOptions.md +++ b/devguide/typedoc-vitepress-theme/types/interfaces/PluginOptions.md @@ -2,6 +2,8 @@ # Interface: PluginOptions +**Defined in**: [types/options.ts:7](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-vitepress-theme/src/types/options.ts#L7) + Describes the options declared by the plugin. ## Properties @@ -10,11 +12,9 @@ Describes the options declared by the plugin. > **docsRoot**: `string` -The path to the VitePress project root. - -#### Defined in +**Defined in**: [types/options.ts:11](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-vitepress-theme/src/types/options.ts#L11) -[types/options.ts:11](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-vitepress-theme/src/types/options.ts#L11) +The path to the VitePress project root. *** @@ -22,8 +22,6 @@ The path to the VitePress project root. > **sidebar**: [`Sidebar`](Sidebar.md) -Configures the autogenerated VitePress sidebar. - -#### Defined in +**Defined in**: [types/options.ts:16](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-vitepress-theme/src/types/options.ts#L16) -[types/options.ts:16](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-vitepress-theme/src/types/options.ts#L16) +Configures the autogenerated VitePress sidebar. diff --git a/devguide/typedoc-vitepress-theme/types/interfaces/Sidebar.md b/devguide/typedoc-vitepress-theme/types/interfaces/Sidebar.md index b12f3b7b7..45331b785 100644 --- a/devguide/typedoc-vitepress-theme/types/interfaces/Sidebar.md +++ b/devguide/typedoc-vitepress-theme/types/interfaces/Sidebar.md @@ -2,15 +2,15 @@ # Interface: Sidebar +**Defined in**: [types/options.ts:19](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-vitepress-theme/src/types/options.ts#L19) + ## Properties ### autoConfiguration > **autoConfiguration**: `boolean` -#### Defined in - -[types/options.ts:23](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-vitepress-theme/src/types/options.ts#L23) +**Defined in**: [types/options.ts:20](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-vitepress-theme/src/types/options.ts#L20) *** @@ -18,9 +18,7 @@ > **format**: `string` -#### Defined in - -[types/options.ts:24](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-vitepress-theme/src/types/options.ts#L24) +**Defined in**: [types/options.ts:21](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-vitepress-theme/src/types/options.ts#L21) *** @@ -28,9 +26,7 @@ > **pretty**: `boolean` -#### Defined in - -[types/options.ts:25](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-vitepress-theme/src/types/options.ts#L25) +**Defined in**: [types/options.ts:22](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-vitepress-theme/src/types/options.ts#L22) *** @@ -38,6 +34,4 @@ > **collapsed**: `boolean` -#### Defined in - -[types/options.ts:26](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-vitepress-theme/src/types/options.ts#L26) +**Defined in**: [types/options.ts:23](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-vitepress-theme/src/types/options.ts#L23) diff --git a/packages/docusaurus-plugin-typedoc/OVERVIEW.md b/packages/docusaurus-plugin-typedoc/internal-docs/introduction.md similarity index 91% rename from packages/docusaurus-plugin-typedoc/OVERVIEW.md rename to packages/docusaurus-plugin-typedoc/internal-docs/introduction.md index 6b0636489..1676e18f2 100644 --- a/packages/docusaurus-plugin-typedoc/OVERVIEW.md +++ b/packages/docusaurus-plugin-typedoc/internal-docs/introduction.md @@ -2,7 +2,7 @@ "docusaurus-plugin-typedoc" is a Docusaurus plugin that bootstraps TypeDoc within the Docusaurus eco-system. -## What Does the Package Do? +Package features include: - Presets relevant options of typedoc-plugin-markdown. - Bootstraps TypeDoc from the Docusaurus CLI. diff --git a/packages/docusaurus-plugin-typedoc/src/index.ts b/packages/docusaurus-plugin-typedoc/src/index.ts index 29cd89b07..92d1a9d14 100644 --- a/packages/docusaurus-plugin-typedoc/src/index.ts +++ b/packages/docusaurus-plugin-typedoc/src/index.ts @@ -1,2 +1,5 @@ +/** + * @module core + */ export { PluginOptions } from './models.js'; export { default } from './plugins/docusaurus.js'; diff --git a/packages/typedoc-github-wiki-theme/OVERVIEW.md b/packages/typedoc-github-wiki-theme/internal-docs/introduction.md similarity index 89% rename from packages/typedoc-github-wiki-theme/OVERVIEW.md rename to packages/typedoc-github-wiki-theme/internal-docs/introduction.md index 379b90bcf..b43386f8f 100644 --- a/packages/typedoc-github-wiki-theme/OVERVIEW.md +++ b/packages/typedoc-github-wiki-theme/internal-docs/introduction.md @@ -2,7 +2,7 @@ "typedoc-github-wiki-theme" is a "theme" in the sense that it targets output for GitHub Wiki. -## What Does the Package Do? +Package features include: - Exposes some additional options to TypeDoc. - Presets relevant typedoc-plugin-markdown options. diff --git a/packages/typedoc-github-wiki-theme/src/index.ts b/packages/typedoc-github-wiki-theme/src/index.ts index c1c91a211..5088439fa 100644 --- a/packages/typedoc-github-wiki-theme/src/index.ts +++ b/packages/typedoc-github-wiki-theme/src/index.ts @@ -1,7 +1,7 @@ /** * The plugin entrypoint and bootstrapping of the plugin. * - * @module + * @module core */ import * as fs from 'fs'; import { DeclarationOption, Options, OptionsReader, Reflection } from 'typedoc'; diff --git a/packages/typedoc-gitlab-wiki-theme/OVERVIEW.md b/packages/typedoc-gitlab-wiki-theme/internal-docs/introduction.md similarity index 89% rename from packages/typedoc-gitlab-wiki-theme/OVERVIEW.md rename to packages/typedoc-gitlab-wiki-theme/internal-docs/introduction.md index 00fccc17d..c96fc1494 100644 --- a/packages/typedoc-gitlab-wiki-theme/OVERVIEW.md +++ b/packages/typedoc-gitlab-wiki-theme/internal-docs/introduction.md @@ -2,7 +2,7 @@ "typedoc-gitlab-wiki-theme" is a "theme" in the sense that it targets output for GitLab Wiki. -## What Does the Package Do? +Package features include: - Exposes some additional options to TypeDoc. - Presets relevant typedoc-plugin-markdown options. diff --git a/packages/typedoc-gitlab-wiki-theme/src/index.ts b/packages/typedoc-gitlab-wiki-theme/src/index.ts index 20eae4da9..cee5c744c 100644 --- a/packages/typedoc-gitlab-wiki-theme/src/index.ts +++ b/packages/typedoc-gitlab-wiki-theme/src/index.ts @@ -1,7 +1,7 @@ /** * The plugin entrypoint and bootstrapping of the plugin. * - * @module + * @module core */ import * as fs from 'fs'; import { DeclarationOption, Options, OptionsReader, Reflection } from 'typedoc'; diff --git a/packages/typedoc-plugin-frontmatter/OVERVIEW.md b/packages/typedoc-plugin-frontmatter/internal-docs/introduction.md similarity index 87% rename from packages/typedoc-plugin-frontmatter/OVERVIEW.md rename to packages/typedoc-plugin-frontmatter/internal-docs/introduction.md index a1427d41b..85cac0110 100644 --- a/packages/typedoc-plugin-frontmatter/OVERVIEW.md +++ b/packages/typedoc-plugin-frontmatter/internal-docs/introduction.md @@ -2,7 +2,7 @@ "typedoc-plugin-frontmatter" is a utility package the prepends frontmatter to pages. -## What Does the Package Do? +Package features includes: - Exposes some additional options to TypeDoc. - Prepends a YAML block to pages. diff --git a/packages/typedoc-plugin-frontmatter/src/index.ts b/packages/typedoc-plugin-frontmatter/src/index.ts index 3b51b84ac..de09f849e 100644 --- a/packages/typedoc-plugin-frontmatter/src/index.ts +++ b/packages/typedoc-plugin-frontmatter/src/index.ts @@ -1,7 +1,7 @@ /** * The plugin entrypoint and bootstrapping of the plugin. * - * @module + * @module core */ import * as path from 'path'; import { @@ -68,4 +68,7 @@ export function load(app: MarkdownApplication) { ); } -export { PluginOptions } from './types/options.js'; +/** + * Export anything that is available publicly + */ +export * from './public-api.js'; diff --git a/packages/typedoc-plugin-frontmatter/src/options/declarations.ts b/packages/typedoc-plugin-frontmatter/src/options/declarations.ts index ab620ba93..a1d8472c6 100644 --- a/packages/typedoc-plugin-frontmatter/src/options/declarations.ts +++ b/packages/typedoc-plugin-frontmatter/src/options/declarations.ts @@ -1,3 +1,9 @@ +/** + * Typedoc options declarations. + * + * @module + */ + import { DeclarationOption, ParameterType } from 'typedoc'; import { FrontmatterNamingConvention } from './maps.js'; diff --git a/packages/typedoc-plugin-frontmatter/src/options/maps.ts b/packages/typedoc-plugin-frontmatter/src/options/maps.ts index 01b6b30e8..8189b0016 100644 --- a/packages/typedoc-plugin-frontmatter/src/options/maps.ts +++ b/packages/typedoc-plugin-frontmatter/src/options/maps.ts @@ -1,3 +1,9 @@ +/** + * Defines option maps TypeDoc parameter Map types. + * + * @module + */ + export enum FrontmatterNamingConvention { CamelCase = 'camelCase', SnakeCase = 'snakeCase', diff --git a/packages/typedoc-plugin-frontmatter/src/public-api.ts b/packages/typedoc-plugin-frontmatter/src/public-api.ts new file mode 100644 index 000000000..29a0c41c5 --- /dev/null +++ b/packages/typedoc-plugin-frontmatter/src/public-api.ts @@ -0,0 +1 @@ +export { PluginOptions } from './types/options.js'; diff --git a/packages/typedoc-plugin-frontmatter/typedoc.json b/packages/typedoc-plugin-frontmatter/typedoc.json index b723f987e..be1af4dab 100644 --- a/packages/typedoc-plugin-frontmatter/typedoc.json +++ b/packages/typedoc-plugin-frontmatter/typedoc.json @@ -4,5 +4,6 @@ "./src/options", "./src/tags.ts", "./src/types" - ] + ], + "exclude": ["./src/public-api.ts"] } diff --git a/packages/typedoc-plugin-markdown/supporting-docs/adding-options.md b/packages/typedoc-plugin-markdown/internal-docs/adding-options.md similarity index 100% rename from packages/typedoc-plugin-markdown/supporting-docs/adding-options.md rename to packages/typedoc-plugin-markdown/internal-docs/adding-options.md diff --git a/packages/typedoc-plugin-markdown/supporting-docs/custom-theme.md b/packages/typedoc-plugin-markdown/internal-docs/custom-theme.md similarity index 100% rename from packages/typedoc-plugin-markdown/supporting-docs/custom-theme.md rename to packages/typedoc-plugin-markdown/internal-docs/custom-theme.md diff --git a/packages/typedoc-plugin-markdown/supporting-docs/getting-started.md b/packages/typedoc-plugin-markdown/internal-docs/getting-started.md similarity index 100% rename from packages/typedoc-plugin-markdown/supporting-docs/getting-started.md rename to packages/typedoc-plugin-markdown/internal-docs/getting-started.md diff --git a/packages/typedoc-plugin-markdown/OVERVIEW.md b/packages/typedoc-plugin-markdown/internal-docs/introduction.md similarity index 92% rename from packages/typedoc-plugin-markdown/OVERVIEW.md rename to packages/typedoc-plugin-markdown/internal-docs/introduction.md index 967fb579f..27019bc7e 100644 --- a/packages/typedoc-plugin-markdown/OVERVIEW.md +++ b/packages/typedoc-plugin-markdown/internal-docs/introduction.md @@ -2,7 +2,7 @@ The core package of this monorepo and is the package that is used to generate the markdown documentation. -## What Does the Package Do? +Package features include: - Extends some methods on the TypeDoc renderer to make compatible with Markdown output. - Exposes some additional options to TypeDoc. diff --git a/packages/typedoc-plugin-markdown/supporting-docs/test-and-validation.md b/packages/typedoc-plugin-markdown/internal-docs/test-and-validation.md similarity index 100% rename from packages/typedoc-plugin-markdown/supporting-docs/test-and-validation.md rename to packages/typedoc-plugin-markdown/internal-docs/test-and-validation.md diff --git a/packages/typedoc-plugin-markdown/src/options/index.ts b/packages/typedoc-plugin-markdown/src/options/index.ts index c42b2799c..6007f668b 100644 --- a/packages/typedoc-plugin-markdown/src/options/index.ts +++ b/packages/typedoc-plugin-markdown/src/options/index.ts @@ -1,7 +1,7 @@ /** * Contains all the option declarations and types used in the plugin. * - * @document ../../supporting-docs/adding-options.md + * @document ../../internal-docs/adding-options.md * * @module */ diff --git a/packages/typedoc-plugin-markdown/src/options/maps.ts b/packages/typedoc-plugin-markdown/src/options/maps.ts index 8227e2502..8c52ff22a 100644 --- a/packages/typedoc-plugin-markdown/src/options/maps.ts +++ b/packages/typedoc-plugin-markdown/src/options/maps.ts @@ -1,5 +1,5 @@ /** - * Maps a given value to the option type. + * Defines option maps TypeDoc parameter Map types. * * @module */ diff --git a/packages/typedoc-plugin-markdown/src/theme/index.ts b/packages/typedoc-plugin-markdown/src/theme/index.ts index 17c3c0683..26005b9e7 100644 --- a/packages/typedoc-plugin-markdown/src/theme/index.ts +++ b/packages/typedoc-plugin-markdown/src/theme/index.ts @@ -1,7 +1,7 @@ /** * Contains all functionality relevant to the markdown theme. * - * @document ../../supporting-docs/custom-theme.md + * @document ../../internal-docs/custom-theme.md * * @module */ diff --git a/packages/typedoc-plugin-markdown/typedoc.json b/packages/typedoc-plugin-markdown/typedoc.json index 492692078..caca61111 100644 --- a/packages/typedoc-plugin-markdown/typedoc.json +++ b/packages/typedoc-plugin-markdown/typedoc.json @@ -11,5 +11,5 @@ ], "exclude": ["./src/public-api.ts"], "categoryOrder": ["File", "Display", "Utility", "Functions", "Locales"], - "projectDocuments": ["./supporting-docs/test-and-validation.md"] + "projectDocuments": ["./internal-docs/test-and-validation.md"] } diff --git a/packages/typedoc-plugin-remark/OVERVIEW.md b/packages/typedoc-plugin-remark/internal-docs/introduction.md similarity index 89% rename from packages/typedoc-plugin-remark/OVERVIEW.md rename to packages/typedoc-plugin-remark/internal-docs/introduction.md index ba0dde736..00510bd64 100644 --- a/packages/typedoc-plugin-remark/OVERVIEW.md +++ b/packages/typedoc-plugin-remark/internal-docs/introduction.md @@ -2,7 +2,7 @@ "typedoc-plugin-remark" is a utility package that pipes output though specified remark plugins. -## What Does the Package Do? +Package features include: - Exposes some additional options to TypeDoc. - Initializes a new remark processor and transform that syntax tree (mdast) using plugins. diff --git a/packages/typedoc-plugin-remark/src/index.ts b/packages/typedoc-plugin-remark/src/index.ts index ba4162cf4..065e6bcd1 100644 --- a/packages/typedoc-plugin-remark/src/index.ts +++ b/packages/typedoc-plugin-remark/src/index.ts @@ -1,7 +1,7 @@ /** * The plugin entrypoint and bootstrapping of the plugin. * - * @module + * @module core */ import * as path from 'path'; diff --git a/packages/typedoc-vitepress-theme/OVERVIEW.md b/packages/typedoc-vitepress-theme/internal-docs/introduction.md similarity index 89% rename from packages/typedoc-vitepress-theme/OVERVIEW.md rename to packages/typedoc-vitepress-theme/internal-docs/introduction.md index b5c1c03eb..e38347d80 100644 --- a/packages/typedoc-vitepress-theme/OVERVIEW.md +++ b/packages/typedoc-vitepress-theme/internal-docs/introduction.md @@ -2,7 +2,7 @@ "typedoc-vitepress-theme" is a "theme" in the sense that it targets output for VitePress. -## What Does the Package Do? +Package features include: - Exposes some additional options to TypeDoc. - Presets relevant typedoc-plugin-markdown options. diff --git a/packages/typedoc-vitepress-theme/src/index.ts b/packages/typedoc-vitepress-theme/src/index.ts index 8bf4965a4..0c58773b0 100644 --- a/packages/typedoc-vitepress-theme/src/index.ts +++ b/packages/typedoc-vitepress-theme/src/index.ts @@ -1,7 +1,7 @@ /** * The plugin entrypoint and bootstrapping of the plugin. * - * @module + * @module core */ import * as fs from 'fs'; import * as path from 'path'; diff --git a/typedoc.json b/typedoc.json index d5ef18139..a0cd72f26 100644 --- a/typedoc.json +++ b/typedoc.json @@ -37,7 +37,7 @@ "packageOptions": { "includeVersion": false, "excludePrivate": false, - "readme": "none", + "readme": "./internal-docs/introduction.md", "sortEntryPoints": false, "sort": "source-order", "excludeExternals": true, @@ -45,7 +45,7 @@ }, // typedoc-plugin-markdown options - "mergeReadme": false, + "mergeReadme": true, "outputFileStrategy": "members", "membersWithOwnFile": ["Class", "Interface"], "hidePageHeader": true,