From 2cb3a6bdda9e67ddf46e3091e1c7900d61ed728c Mon Sep 17 00:00:00 2001 From: tgreyuk Date: Fri, 21 Jun 2024 08:40:40 +0100 Subject: [PATCH] chore(docs): documentation updates --- .../docusaurus-plugin-typedoc/index/README.md | 2 +- .../index/interfaces/PluginOptions.md | 4 +- .../options/namespaces/declarations/README.md | 2 +- .../options/namespaces/presets/README.md | 2 +- .../types/interfaces/PluginOptions.md | 2 +- .../types/interfaces/Sidebar.md | 4 +- .../typedoc-github-wiki-theme/index/README.md | 4 +- .../options/namespaces/declarations/README.md | 2 +- .../options/namespaces/presets/README.md | 2 +- .../types/interfaces/PluginOptions.md | 2 +- .../types/interfaces/Sidebar.md | 4 +- .../typedoc-gitlab-wiki-theme/index/README.md | 2 +- .../options/namespaces/declarations/README.md | 2 +- .../options/namespaces/presets/README.md | 2 +- .../types/interfaces/PluginOptions.md | 2 +- .../types/interfaces/Sidebar.md | 4 +- .../index/README.md | 2 +- .../options/namespaces/declarations/README.md | 12 ++-- .../typedoc-plugin-frontmatter/tags/README.md | 4 +- .../types/interfaces/PluginOptions.md | 12 ++-- .../events/classes/MarkdownPageEvent.md | 16 ++--- .../events/classes/MarkdownRendererEvent.md | 12 ++-- .../typedoc-plugin-markdown/index/README.md | 2 +- .../internationalization/README.md | 10 +-- .../libs/namespaces/markdown/README.md | 26 ++++---- .../libs/namespaces/utils/README.md | 26 ++++---- .../options/namespaces/constants/README.md | 4 +- .../options/namespaces/declarations/README.md | 60 ++++++++--------- .../renderer/README.md | 6 +- .../theme/classes/MarkdownTheme.md | 20 +++--- .../theme/classes/MarkdownThemeContext.md | 26 ++++---- .../types/interfaces/MarkdownApplication.md | 2 +- .../types/interfaces/MarkdownRenderer.md | 10 +-- .../types/interfaces/MarkdownRendererHooks.md | 10 +-- .../types/interfaces/NavigationItem.md | 8 +-- .../types/interfaces/PackageMetaData.md | 4 +- .../types/interfaces/PluginOptions.md | 64 +++++++++---------- .../types/interfaces/TemplateMapping.md | 6 +- .../types/interfaces/TranslatableStrings.md | 38 +++++++---- .../types/interfaces/UrlMapping.md | 6 +- .../types/interfaces/UrlOption.md | 12 ++-- .../types/type-aliases/RenderTemplate.md | 2 +- .../typedoc-plugin-remark/index/README.md | 2 +- .../options/namespaces/declarations/README.md | 4 +- .../options/namespaces/helpers/README.md | 2 +- .../types/interfaces/PluginOptions.md | 4 +- .../typedoc-vitepress-theme/index/README.md | 2 +- .../options/namespaces/declarations/README.md | 22 +++---- .../options/namespaces/presets/README.md | 2 +- .../types/interfaces/PluginOptions.md | 4 +- .../types/interfaces/Sidebar.md | 8 +-- docs/pages/plugins/vitepress/options.mdx | 18 +++--- .../src/internationalization/locales/index.ts | 2 +- .../src/options/declarations.ts | 18 +++--- typedoc.json | 3 +- 55 files changed, 269 insertions(+), 264 deletions(-) diff --git a/devguide/docusaurus-plugin-typedoc/index/README.md b/devguide/docusaurus-plugin-typedoc/index/README.md index 4c7a0f64..fb42d151 100644 --- a/devguide/docusaurus-plugin-typedoc/index/README.md +++ b/devguide/docusaurus-plugin-typedoc/index/README.md @@ -38,4 +38,4 @@ ### Defined in -[docusaurus-plugin-typedoc/src/plugin.ts:13](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/docusaurus-plugin-typedoc/src/plugin.ts#L13) +[docusaurus-plugin-typedoc/src/plugin.ts:13](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/docusaurus-plugin-typedoc/src/plugin.ts#L13) diff --git a/devguide/docusaurus-plugin-typedoc/index/interfaces/PluginOptions.md b/devguide/docusaurus-plugin-typedoc/index/interfaces/PluginOptions.md index 60b5c4d9..959a71e2 100644 --- a/devguide/docusaurus-plugin-typedoc/index/interfaces/PluginOptions.md +++ b/devguide/docusaurus-plugin-typedoc/index/interfaces/PluginOptions.md @@ -105,7 +105,7 @@ Describes the options declared by the plugin. #### Defined in -[docusaurus-plugin-typedoc/src/models.ts:7](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/docusaurus-plugin-typedoc/src/models.ts#L7) +[docusaurus-plugin-typedoc/src/models.ts:7](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/docusaurus-plugin-typedoc/src/models.ts#L7) *** @@ -121,7 +121,7 @@ Configures the autogenerated Docusaurus sidebar. #### Defined in -[docusaurus-plugin-typedoc/src/types/options.ts:11](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/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) *** diff --git a/devguide/docusaurus-plugin-typedoc/options/namespaces/declarations/README.md b/devguide/docusaurus-plugin-typedoc/options/namespaces/declarations/README.md index 694809a6..f2bf6b7a 100644 --- a/devguide/docusaurus-plugin-typedoc/options/namespaces/declarations/README.md +++ b/devguide/docusaurus-plugin-typedoc/options/namespaces/declarations/README.md @@ -28,4 +28,4 @@ Please see the [sidebar guide](/plugins/docusaurus/guide/sidebar) for additional ### Defined in -[docusaurus-plugin-typedoc/src/options/declarations.ts:16](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/docusaurus-plugin-typedoc/src/options/declarations.ts#L16) +[docusaurus-plugin-typedoc/src/options/declarations.ts:16](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/docusaurus-plugin-typedoc/src/options/declarations.ts#L16) diff --git a/devguide/docusaurus-plugin-typedoc/options/namespaces/presets/README.md b/devguide/docusaurus-plugin-typedoc/options/namespaces/presets/README.md index 9f1bc84f..4bd97911 100644 --- a/devguide/docusaurus-plugin-typedoc/options/namespaces/presets/README.md +++ b/devguide/docusaurus-plugin-typedoc/options/namespaces/presets/README.md @@ -18,4 +18,4 @@ ### Defined in -[docusaurus-plugin-typedoc/src/options/presets.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/docusaurus-plugin-typedoc/src/options/presets.ts#L1) +[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) diff --git a/devguide/docusaurus-plugin-typedoc/types/interfaces/PluginOptions.md b/devguide/docusaurus-plugin-typedoc/types/interfaces/PluginOptions.md index f32209ee..fc7e6067 100644 --- a/devguide/docusaurus-plugin-typedoc/types/interfaces/PluginOptions.md +++ b/devguide/docusaurus-plugin-typedoc/types/interfaces/PluginOptions.md @@ -24,4 +24,4 @@ Configures the autogenerated Docusaurus sidebar. #### Defined in -[docusaurus-plugin-typedoc/src/types/options.ts:11](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/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) diff --git a/devguide/docusaurus-plugin-typedoc/types/interfaces/Sidebar.md b/devguide/docusaurus-plugin-typedoc/types/interfaces/Sidebar.md index 1a66ea6c..43218d68 100644 --- a/devguide/docusaurus-plugin-typedoc/types/interfaces/Sidebar.md +++ b/devguide/docusaurus-plugin-typedoc/types/interfaces/Sidebar.md @@ -10,7 +10,7 @@ #### Defined in -[docusaurus-plugin-typedoc/src/types/options.ts:18](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/docusaurus-plugin-typedoc/src/types/options.ts#L18) +[docusaurus-plugin-typedoc/src/types/options.ts:18](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/docusaurus-plugin-typedoc/src/types/options.ts#L18) *** @@ -20,4 +20,4 @@ #### Defined in -[docusaurus-plugin-typedoc/src/types/options.ts:19](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/docusaurus-plugin-typedoc/src/types/options.ts#L19) +[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) diff --git a/devguide/typedoc-github-wiki-theme/index/README.md b/devguide/typedoc-github-wiki-theme/index/README.md index 5f351b09..4b3182ad 100644 --- a/devguide/typedoc-github-wiki-theme/index/README.md +++ b/devguide/typedoc-github-wiki-theme/index/README.md @@ -25,7 +25,7 @@ The plugin entrypoint and bootstrapping of the plugin. ### Defined in -[index.ts:23](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-github-wiki-theme/src/index.ts#L23) +[index.ts:23](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-github-wiki-theme/src/index.ts#L23) *** @@ -45,4 +45,4 @@ The plugin entrypoint and bootstrapping of the plugin. ### Defined in -[index.ts:78](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-github-wiki-theme/src/index.ts#L78) +[index.ts:78](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-github-wiki-theme/src/index.ts#L78) 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 642c6c03..ca466aed 100644 --- a/devguide/typedoc-github-wiki-theme/options/namespaces/declarations/README.md +++ b/devguide/typedoc-github-wiki-theme/options/namespaces/declarations/README.md @@ -24,4 +24,4 @@ The heading displayed above the sidebar. ### Defined in -[options/declarations.ts:14](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-github-wiki-theme/src/options/declarations.ts#L14) +[options/declarations.ts:14](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-github-wiki-theme/src/options/declarations.ts#L14) 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 b717e0d7..4129dd89 100644 --- a/devguide/typedoc-github-wiki-theme/options/namespaces/presets/README.md +++ b/devguide/typedoc-github-wiki-theme/options/namespaces/presets/README.md @@ -16,4 +16,4 @@ ### Defined in -[options/presets.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-github-wiki-theme/src/options/presets.ts#L1) +[options/presets.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-github-wiki-theme/src/options/presets.ts#L1) diff --git a/devguide/typedoc-github-wiki-theme/types/interfaces/PluginOptions.md b/devguide/typedoc-github-wiki-theme/types/interfaces/PluginOptions.md index a01a8867..614680e5 100644 --- a/devguide/typedoc-github-wiki-theme/types/interfaces/PluginOptions.md +++ b/devguide/typedoc-github-wiki-theme/types/interfaces/PluginOptions.md @@ -14,4 +14,4 @@ Configures the autogenerated `_sidebar.md file`. #### Defined in -[types/options.ts:11](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/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) diff --git a/devguide/typedoc-github-wiki-theme/types/interfaces/Sidebar.md b/devguide/typedoc-github-wiki-theme/types/interfaces/Sidebar.md index 1293afdf..31572701 100644 --- a/devguide/typedoc-github-wiki-theme/types/interfaces/Sidebar.md +++ b/devguide/typedoc-github-wiki-theme/types/interfaces/Sidebar.md @@ -10,7 +10,7 @@ #### Defined in -[types/options.ts:18](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-github-wiki-theme/src/types/options.ts#L18) +[types/options.ts:18](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-github-wiki-theme/src/types/options.ts#L18) *** @@ -20,4 +20,4 @@ #### Defined in -[types/options.ts:19](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-github-wiki-theme/src/types/options.ts#L19) +[types/options.ts:19](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-github-wiki-theme/src/types/options.ts#L19) diff --git a/devguide/typedoc-gitlab-wiki-theme/index/README.md b/devguide/typedoc-gitlab-wiki-theme/index/README.md index 84367910..2a15d4ae 100644 --- a/devguide/typedoc-gitlab-wiki-theme/index/README.md +++ b/devguide/typedoc-gitlab-wiki-theme/index/README.md @@ -20,4 +20,4 @@ The plugin entrypoint and bootstrapping of the plugin. ### Defined in -[index.ts:23](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-gitlab-wiki-theme/src/index.ts#L23) +[index.ts:23](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-gitlab-wiki-theme/src/index.ts#L23) 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 3a522f2e..adbb7cdc 100644 --- a/devguide/typedoc-gitlab-wiki-theme/options/namespaces/declarations/README.md +++ b/devguide/typedoc-gitlab-wiki-theme/options/namespaces/declarations/README.md @@ -24,4 +24,4 @@ The heading displayed above the sidebar. ### Defined in -[options/declarations.ts:14](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-gitlab-wiki-theme/src/options/declarations.ts#L14) +[options/declarations.ts:14](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-gitlab-wiki-theme/src/options/declarations.ts#L14) 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 cf99a4cf..b3c55650 100644 --- a/devguide/typedoc-gitlab-wiki-theme/options/namespaces/presets/README.md +++ b/devguide/typedoc-gitlab-wiki-theme/options/namespaces/presets/README.md @@ -15,4 +15,4 @@ ### Defined in -[options/presets.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-gitlab-wiki-theme/src/options/presets.ts#L1) +[options/presets.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-gitlab-wiki-theme/src/options/presets.ts#L1) diff --git a/devguide/typedoc-gitlab-wiki-theme/types/interfaces/PluginOptions.md b/devguide/typedoc-gitlab-wiki-theme/types/interfaces/PluginOptions.md index 9cad8305..da992513 100644 --- a/devguide/typedoc-gitlab-wiki-theme/types/interfaces/PluginOptions.md +++ b/devguide/typedoc-gitlab-wiki-theme/types/interfaces/PluginOptions.md @@ -14,4 +14,4 @@ Configures the autogenerated `_Sidebar.md file`. #### Defined in -[types/options.ts:11](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/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) diff --git a/devguide/typedoc-gitlab-wiki-theme/types/interfaces/Sidebar.md b/devguide/typedoc-gitlab-wiki-theme/types/interfaces/Sidebar.md index 34aa9eeb..5cd70f63 100644 --- a/devguide/typedoc-gitlab-wiki-theme/types/interfaces/Sidebar.md +++ b/devguide/typedoc-gitlab-wiki-theme/types/interfaces/Sidebar.md @@ -10,7 +10,7 @@ #### Defined in -[types/options.ts:18](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-gitlab-wiki-theme/src/types/options.ts#L18) +[types/options.ts:18](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-gitlab-wiki-theme/src/types/options.ts#L18) *** @@ -20,4 +20,4 @@ #### Defined in -[types/options.ts:19](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-gitlab-wiki-theme/src/types/options.ts#L19) +[types/options.ts:19](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-gitlab-wiki-theme/src/types/options.ts#L19) diff --git a/devguide/typedoc-plugin-frontmatter/index/README.md b/devguide/typedoc-plugin-frontmatter/index/README.md index 5cfebc16..18011a94 100644 --- a/devguide/typedoc-plugin-frontmatter/index/README.md +++ b/devguide/typedoc-plugin-frontmatter/index/README.md @@ -20,4 +20,4 @@ The plugin entrypoint and bootstrapping of the plugin. ### Defined in -[index.ts:18](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-frontmatter/src/index.ts#L18) +[index.ts:18](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-frontmatter/src/index.ts#L18) diff --git a/devguide/typedoc-plugin-frontmatter/options/namespaces/declarations/README.md b/devguide/typedoc-plugin-frontmatter/options/namespaces/declarations/README.md index 59a751db..a5aa33be 100644 --- a/devguide/typedoc-plugin-frontmatter/options/namespaces/declarations/README.md +++ b/devguide/typedoc-plugin-frontmatter/options/namespaces/declarations/README.md @@ -40,7 +40,7 @@ sidebar: true ### Defined in -[options/declarations.ts:15](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-frontmatter/src/options/declarations.ts#L15) +[options/declarations.ts:15](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-frontmatter/src/options/declarations.ts#L15) *** @@ -66,7 +66,7 @@ sidebar: true ### Defined in -[options/declarations.ts:24](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-frontmatter/src/options/declarations.ts#L24) +[options/declarations.ts:24](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-frontmatter/src/options/declarations.ts#L24) *** @@ -92,7 +92,7 @@ sidebar: true ### Defined in -[options/declarations.ts:33](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-frontmatter/src/options/declarations.ts#L33) +[options/declarations.ts:33](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-frontmatter/src/options/declarations.ts#L33) *** @@ -136,7 +136,7 @@ description: A description that will be added to frontmatter. ### Defined in -[options/declarations.ts:61](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-frontmatter/src/options/declarations.ts#L61) +[options/declarations.ts:61](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-frontmatter/src/options/declarations.ts#L61) *** @@ -156,7 +156,7 @@ description: A description that will be added to frontmatter. ### Defined in -[options/declarations.ts:66](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-frontmatter/src/options/declarations.ts#L66) +[options/declarations.ts:66](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-frontmatter/src/options/declarations.ts#L66) *** @@ -181,4 +181,4 @@ This option can configure the output style of frontmatter variables when written ### Defined in -[options/declarations.ts:77](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-frontmatter/src/options/declarations.ts#L77) +[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/tags/README.md b/devguide/typedoc-plugin-frontmatter/tags/README.md index cb42fcec..91202efc 100644 --- a/devguide/typedoc-plugin-frontmatter/tags/README.md +++ b/devguide/typedoc-plugin-frontmatter/tags/README.md @@ -26,7 +26,7 @@ Functionality to map options to tags. ### Defined in -[tags.ts:9](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-frontmatter/src/tags.ts#L9) +[tags.ts:9](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-frontmatter/src/tags.ts#L9) *** @@ -48,4 +48,4 @@ Functionality to map options to tags. ### Defined in -[tags.ts:33](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-frontmatter/src/tags.ts#L33) +[tags.ts:33](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-frontmatter/src/tags.ts#L33) diff --git a/devguide/typedoc-plugin-frontmatter/types/interfaces/PluginOptions.md b/devguide/typedoc-plugin-frontmatter/types/interfaces/PluginOptions.md index 191bb8ce..1c2e694b 100644 --- a/devguide/typedoc-plugin-frontmatter/types/interfaces/PluginOptions.md +++ b/devguide/typedoc-plugin-frontmatter/types/interfaces/PluginOptions.md @@ -14,7 +14,7 @@ Specify which comment block tags should be added to frontmatter. #### Defined in -[types/options.ts:11](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-frontmatter/src/types/options.ts#L11) +[types/options.ts:11](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-frontmatter/src/types/options.ts#L11) *** @@ -26,7 +26,7 @@ Specify static variables to be added to all frontmatter blocks. #### Defined in -[types/options.ts:16](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-frontmatter/src/types/options.ts#L16) +[types/options.ts:16](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-frontmatter/src/types/options.ts#L16) *** @@ -38,7 +38,7 @@ The naming convention that variables should be output as. #### Defined in -[types/options.ts:21](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-frontmatter/src/types/options.ts#L21) +[types/options.ts:21](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-frontmatter/src/types/options.ts#L21) *** @@ -50,7 +50,7 @@ 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/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-frontmatter/src/types/options.ts#L26) +[types/options.ts:26](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-frontmatter/src/types/options.ts#L26) *** @@ -62,7 +62,7 @@ Preserve tags defined in frontmatter block tags in output. #### Defined in -[types/options.ts:31](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-frontmatter/src/types/options.ts#L31) +[types/options.ts:31](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-frontmatter/src/types/options.ts#L31) *** @@ -74,4 +74,4 @@ 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/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-frontmatter/src/types/options.ts#L36) +[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-markdown/events/classes/MarkdownPageEvent.md b/devguide/typedoc-plugin-markdown/events/classes/MarkdownPageEvent.md index 2682e999..9a38032d 100644 --- a/devguide/typedoc-plugin-markdown/events/classes/MarkdownPageEvent.md +++ b/devguide/typedoc-plugin-markdown/events/classes/MarkdownPageEvent.md @@ -39,7 +39,7 @@ The [`ProjectReflection`](https://typedoc.org/api/classes/Models.ProjectReflecti #### Defined in -[events/markdown-page-event.ts:14](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/events/markdown-page-event.ts#L14) +[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) *** @@ -52,7 +52,7 @@ Either a [`DeclarationReflection`](https://typedoc.org/api/classes/Models.Declar #### Defined in -[events/markdown-page-event.ts:20](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/events/markdown-page-event.ts#L20) +[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) *** @@ -66,7 +66,7 @@ Should be rendered by layout templates and can be modified by plugins. #### Defined in -[events/markdown-page-event.ts:27](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/events/markdown-page-event.ts#L27) +[events/markdown-page-event.ts:27](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/events/markdown-page-event.ts#L27) *** @@ -78,7 +78,7 @@ The url `string` of the page. #### Defined in -[events/markdown-page-event.ts:32](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/events/markdown-page-event.ts#L32) +[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) *** @@ -90,7 +90,7 @@ The complete `string` filename where the file will be written.. #### Defined in -[events/markdown-page-event.ts:37](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/events/markdown-page-event.ts#L37) +[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) *** @@ -102,7 +102,7 @@ The frontmatter of this page represented as a key value object. This property ca #### Defined in -[events/markdown-page-event.ts:42](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/events/markdown-page-event.ts#L42) +[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) ## Events @@ -114,7 +114,7 @@ Triggered before a document will be rendered. #### Defined in -[events/markdown-page-event.ts:54](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/events/markdown-page-event.ts#L54) +[events/markdown-page-event.ts:54](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/events/markdown-page-event.ts#L54) *** @@ -126,4 +126,4 @@ Triggered after a document has been rendered, just before it is written to disc. #### Defined in -[events/markdown-page-event.ts:60](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/events/markdown-page-event.ts#L60) +[events/markdown-page-event.ts:60](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/events/markdown-page-event.ts#L60) diff --git a/devguide/typedoc-plugin-markdown/events/classes/MarkdownRendererEvent.md b/devguide/typedoc-plugin-markdown/events/classes/MarkdownRendererEvent.md index 08d2fceb..cf115dc0 100644 --- a/devguide/typedoc-plugin-markdown/events/classes/MarkdownRendererEvent.md +++ b/devguide/typedoc-plugin-markdown/events/classes/MarkdownRendererEvent.md @@ -30,7 +30,7 @@ The project the renderer is currently processing. #### Defined in -[events/markdown-renderer-event.ts:15](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/events/markdown-renderer-event.ts#L15) +[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) *** @@ -42,7 +42,7 @@ The path of the directory the documentation should be written to. #### Defined in -[events/markdown-renderer-event.ts:20](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/events/markdown-renderer-event.ts#L20) +[events/markdown-renderer-event.ts:20](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/events/markdown-renderer-event.ts#L20) *** @@ -54,7 +54,7 @@ A list of all pages that should be generated. #### Defined in -[events/markdown-renderer-event.ts:25](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/events/markdown-renderer-event.ts#L25) +[events/markdown-renderer-event.ts:25](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/events/markdown-renderer-event.ts#L25) *** @@ -66,7 +66,7 @@ The navigation structure of the project that can be utilised by plugins. #### Defined in -[events/markdown-renderer-event.ts:30](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/events/markdown-renderer-event.ts#L30) +[events/markdown-renderer-event.ts:30](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/events/markdown-renderer-event.ts#L30) ## Events @@ -78,7 +78,7 @@ Triggered before the renderer starts rendering a project. #### Defined in -[events/markdown-renderer-event.ts:36](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/events/markdown-renderer-event.ts#L36) +[events/markdown-renderer-event.ts:36](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/events/markdown-renderer-event.ts#L36) *** @@ -90,4 +90,4 @@ Triggered after the renderer has written all documents. #### Defined in -[events/markdown-renderer-event.ts:42](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/events/markdown-renderer-event.ts#L42) +[events/markdown-renderer-event.ts:42](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/events/markdown-renderer-event.ts#L42) diff --git a/devguide/typedoc-plugin-markdown/index/README.md b/devguide/typedoc-plugin-markdown/index/README.md index 314a6542..5ff7efd6 100644 --- a/devguide/typedoc-plugin-markdown/index/README.md +++ b/devguide/typedoc-plugin-markdown/index/README.md @@ -30,4 +30,4 @@ This method is not intended to be consumed in any other context that via the `pl ### Defined in -[index.ts:30](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/index.ts#L30) +[index.ts:30](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/index.ts#L30) diff --git a/devguide/typedoc-plugin-markdown/internationalization/README.md b/devguide/typedoc-plugin-markdown/internationalization/README.md index 96360413..e0799389 100644 --- a/devguide/typedoc-plugin-markdown/internationalization/README.md +++ b/devguide/typedoc-plugin-markdown/internationalization/README.md @@ -40,7 +40,7 @@ These will then be merged with the main set of TypeDoc string. #### Defined in -[internationalization/translatable.ts:16](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/internationalization/translatable.ts#L16) +[internationalization/translatable.ts:16](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/internationalization/translatable.ts#L16) ## Locales @@ -74,7 +74,7 @@ Translations for 'en' locale. #### Defined in -[internationalization/locales/en.ts:7](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/internationalization/locales/en.ts#L7) +[internationalization/locales/en.ts:7](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/internationalization/locales/en.ts#L7) *** @@ -108,7 +108,7 @@ Translations for 'jp' locale. #### Defined in -[internationalization/locales/jp.ts:8](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/internationalization/locales/jp.ts#L8) +[internationalization/locales/jp.ts:8](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/internationalization/locales/jp.ts#L8) *** @@ -142,7 +142,7 @@ Translations for 'ko' locale. #### Defined in -[internationalization/locales/ko.ts:7](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/internationalization/locales/ko.ts#L7) +[internationalization/locales/ko.ts:7](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/internationalization/locales/ko.ts#L7) *** @@ -176,4 +176,4 @@ Translations for 'zh' locale. #### Defined in -[internationalization/locales/zh.ts:7](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/internationalization/locales/zh.ts#L7) +[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/namespaces/markdown/README.md b/devguide/typedoc-plugin-markdown/libs/namespaces/markdown/README.md index eb1b3e7d..79b07674 100644 --- a/devguide/typedoc-plugin-markdown/libs/namespaces/markdown/README.md +++ b/devguide/typedoc-plugin-markdown/libs/namespaces/markdown/README.md @@ -39,7 +39,7 @@ If the input string itself contains a backtick, pipe, or backslash (which can re ### Defined in -[libs/markdown/back-ticks.ts:7](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/libs/markdown/back-ticks.ts#L7) +[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) *** @@ -59,7 +59,7 @@ If the input string itself contains a backtick, pipe, or backslash (which can re ### Defined in -[libs/markdown/block-quote-block.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/libs/markdown/block-quote-block.ts#L1) +[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) *** @@ -79,7 +79,7 @@ If the input string itself contains a backtick, pipe, or backslash (which can re ### Defined in -[libs/markdown/bold.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/libs/markdown/bold.ts#L1) +[libs/markdown/bold.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/libs/markdown/bold.ts#L1) *** @@ -99,7 +99,7 @@ If the input string itself contains a backtick, pipe, or backslash (which can re ### Defined in -[libs/markdown/code-block.ts:3](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/libs/markdown/code-block.ts#L3) +[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) *** @@ -122,7 +122,7 @@ Returns a heading in markdown format ### Defined in -[libs/markdown/heading.ts:6](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/libs/markdown/heading.ts#L6) +[libs/markdown/heading.ts:6](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/libs/markdown/heading.ts#L6) *** @@ -136,7 +136,7 @@ Returns a heading in markdown format ### Defined in -[libs/markdown/horizontal-rule.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/libs/markdown/horizontal-rule.ts#L1) +[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) *** @@ -158,7 +158,7 @@ Returns a heading in markdown format ### Defined in -[libs/markdown/html-table.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/libs/markdown/html-table.ts#L1) +[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) *** @@ -178,7 +178,7 @@ Returns a heading in markdown format ### Defined in -[libs/markdown/indent-block.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/libs/markdown/indent-block.ts#L1) +[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) *** @@ -198,7 +198,7 @@ Returns a heading in markdown format ### Defined in -[libs/markdown/italic.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/libs/markdown/italic.ts#L1) +[libs/markdown/italic.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/libs/markdown/italic.ts#L1) *** @@ -221,7 +221,7 @@ The link element ### Defined in -[libs/markdown/link.ts:6](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/libs/markdown/link.ts#L6) +[libs/markdown/link.ts:6](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/libs/markdown/link.ts#L6) *** @@ -241,7 +241,7 @@ The link element ### Defined in -[libs/markdown/strike-through.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/libs/markdown/strike-through.ts#L1) +[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) *** @@ -265,7 +265,7 @@ Comments for table ### Defined in -[libs/markdown/table.ts:7](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/libs/markdown/table.ts#L7) +[libs/markdown/table.ts:7](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/libs/markdown/table.ts#L7) *** @@ -285,4 +285,4 @@ Comments for table ### Defined in -[libs/markdown/unordered-list.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/libs/markdown/unordered-list.ts#L1) +[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) diff --git a/devguide/typedoc-plugin-markdown/libs/namespaces/utils/README.md b/devguide/typedoc-plugin-markdown/libs/namespaces/utils/README.md index 76e5eae7..df6b1183 100644 --- a/devguide/typedoc-plugin-markdown/libs/namespaces/utils/README.md +++ b/devguide/typedoc-plugin-markdown/libs/namespaces/utils/README.md @@ -36,7 +36,7 @@ General utility pure functions. ### Defined in -[libs/utils/camel-to-title-case.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/libs/utils/camel-to-title-case.ts#L1) +[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) *** @@ -56,7 +56,7 @@ General utility pure functions. ### Defined in -[libs/utils/escape-chars.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/libs/utils/escape-chars.ts#L1) +[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) *** @@ -76,7 +76,7 @@ General utility pure functions. ### Defined in -[libs/utils/format-markdown.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/libs/utils/format-markdown.ts#L1) +[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) *** @@ -100,7 +100,7 @@ General utility pure functions. ### Defined in -[libs/utils/format-table-cell.ts:6](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/libs/utils/format-table-cell.ts#L6) +[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) *** @@ -123,7 +123,7 @@ Returns a filename with extension while normalizing both the input name and inpu ### Defined in -[libs/utils/get-file-name-with-extension.ts:6](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/libs/utils/get-file-name-with-extension.ts#L6) +[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) *** @@ -143,7 +143,7 @@ Returns a filename with extension while normalizing both the input name and inpu ### Defined in -[libs/utils/is-quoted.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/libs/utils/is-quoted.ts#L1) +[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) *** @@ -163,7 +163,7 @@ Returns a filename with extension while normalizing both the input name and inpu ### Defined in -[libs/utils/normalize-line-breaks.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/libs/utils/normalize-line-breaks.ts#L1) +[libs/utils/normalize-line-breaks.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/libs/utils/normalize-line-breaks.ts#L1) *** @@ -183,7 +183,7 @@ Returns a filename with extension while normalizing both the input name and inpu ### Defined in -[libs/utils/remove-first-scoped-directory.ts:3](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/libs/utils/remove-first-scoped-directory.ts#L3) +[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) *** @@ -203,7 +203,7 @@ Returns a filename with extension while normalizing both the input name and inpu ### Defined in -[libs/utils/remove-line-breaks.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/libs/utils/remove-line-breaks.ts#L1) +[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) *** @@ -223,7 +223,7 @@ Returns a filename with extension while normalizing both the input name and inpu ### Defined in -[libs/utils/sanitize-comments.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/libs/utils/sanitize-comments.ts#L1) +[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) *** @@ -243,7 +243,7 @@ Returns a filename with extension while normalizing both the input name and inpu ### Defined in -[libs/utils/slugify.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/libs/utils/slugify.ts#L1) +[libs/utils/slugify.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/libs/utils/slugify.ts#L1) *** @@ -263,7 +263,7 @@ Returns a filename with extension while normalizing both the input name and inpu ### Defined in -[libs/utils/to-pascal-case.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/libs/utils/to-pascal-case.ts#L1) +[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) *** @@ -283,4 +283,4 @@ Returns a filename with extension while normalizing both the input name and inpu ### Defined in -[libs/utils/un-escape-chars.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/libs/utils/un-escape-chars.ts#L1) +[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) diff --git a/devguide/typedoc-plugin-markdown/options/namespaces/constants/README.md b/devguide/typedoc-plugin-markdown/options/namespaces/constants/README.md index e2ab53cb..08d8b580 100644 --- a/devguide/typedoc-plugin-markdown/options/namespaces/constants/README.md +++ b/devguide/typedoc-plugin-markdown/options/namespaces/constants/README.md @@ -30,7 +30,7 @@ Default values for `membersWithOwnFile` option. ### Defined in -[options/constants.ts:12](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/options/constants.ts#L12) +[options/constants.ts:12](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/options/constants.ts#L12) *** @@ -53,4 +53,4 @@ Default values for `textContentMappings` option. ### Defined in -[options/constants.ts:24](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/options/constants.ts#L24) +[options/constants.ts:24](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/options/constants.ts#L24) diff --git a/devguide/typedoc-plugin-markdown/options/namespaces/declarations/README.md b/devguide/typedoc-plugin-markdown/options/namespaces/declarations/README.md index 20051429..5d4a943d 100644 --- a/devguide/typedoc-plugin-markdown/options/namespaces/declarations/README.md +++ b/devguide/typedoc-plugin-markdown/options/namespaces/declarations/README.md @@ -102,7 +102,7 @@ Generates a single file for every Module or Namespace where all members are hois #### Defined in -[options/declarations.ts:66](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/options/declarations.ts#L66) +[options/declarations.ts:66](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/options/declarations.ts#L66) *** @@ -140,7 +140,7 @@ Ignored when `--outputFileStrategy` is equal to `"modules"` #### Defined in -[options/declarations.ts:82](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/options/declarations.ts#L82) +[options/declarations.ts:82](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/options/declarations.ts#L82) *** @@ -162,7 +162,7 @@ By default output files are generated in a directory structure that mirrors the #### Defined in -[options/declarations.ts:105](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/options/declarations.ts#L105) +[options/declarations.ts:105](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/options/declarations.ts#L105) *** @@ -195,7 +195,7 @@ Typically markdown files are recognised by the `.md` or `.markdown` file extensi #### Defined in -[options/declarations.ts:118](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/options/declarations.ts#L118) +[options/declarations.ts:118](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/options/declarations.ts#L118) *** @@ -232,7 +232,7 @@ The content of root documentation file will be resolved in the following order: #### Defined in -[options/declarations.ts:148](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/options/declarations.ts#L148) +[options/declarations.ts:148](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/options/declarations.ts#L148) *** @@ -263,7 +263,7 @@ Please note a separate modules index page will not be generated, therefore would #### Defined in -[options/declarations.ts:165](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/options/declarations.ts#L165) +[options/declarations.ts:165](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/options/declarations.ts#L165) *** @@ -291,7 +291,7 @@ Ignored if `flattenOutputFiles` is set to `true`. #### Defined in -[options/declarations.ts:181](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/options/declarations.ts#L181) +[options/declarations.ts:181](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/options/declarations.ts#L181) *** @@ -316,7 +316,7 @@ This option has no effect when [`--readme`](https://typedoc.org/options/input/#r #### Defined in -[options/declarations.ts:195](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/options/declarations.ts#L195) +[options/declarations.ts:195](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/options/declarations.ts#L195) ## Display @@ -338,7 +338,7 @@ Options that are used to configure how the output is structured and displayed. #### Defined in -[options/declarations.ts:204](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/options/declarations.ts#L204) +[options/declarations.ts:204](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/options/declarations.ts#L204) *** @@ -358,7 +358,7 @@ Options that are used to configure how the output is structured and displayed. #### Defined in -[options/declarations.ts:213](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/options/declarations.ts#L213) +[options/declarations.ts:213](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/options/declarations.ts#L213) *** @@ -378,7 +378,7 @@ Options that are used to configure how the output is structured and displayed. #### Defined in -[options/declarations.ts:222](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/options/declarations.ts#L222) +[options/declarations.ts:222](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/options/declarations.ts#L222) *** @@ -402,7 +402,7 @@ This creates a flat structure where all members are displayed at the same headin #### Defined in -[options/declarations.ts:235](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/options/declarations.ts#L235) +[options/declarations.ts:235](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/options/declarations.ts#L235) *** @@ -428,7 +428,7 @@ As a work around the [`@link`](https://typedoc.org/tags/link/) tag can be be use #### Defined in -[options/declarations.ts:261](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/options/declarations.ts#L261) +[options/declarations.ts:261](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/options/declarations.ts#L261) *** @@ -452,7 +452,7 @@ This option should be set when a full object representation is preferred. #### Defined in -[options/declarations.ts:274](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/options/declarations.ts#L274) +[options/declarations.ts:274](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/options/declarations.ts#L274) *** @@ -476,7 +476,7 @@ This option should be set when a full type representation is preferred. #### Defined in -[options/declarations.ts:287](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/options/declarations.ts#L287) +[options/declarations.ts:287](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/options/declarations.ts#L287) *** @@ -505,7 +505,7 @@ When table style is selected the following will be the behaviour: #### Defined in -[options/declarations.ts:304](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/options/declarations.ts#L304) +[options/declarations.ts:304](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/options/declarations.ts#L304) *** @@ -532,7 +532,7 @@ This option specifies the output format for parameters and type parameters of fu #### Defined in -[options/declarations.ts:320](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/options/declarations.ts#L320) +[options/declarations.ts:320](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/options/declarations.ts#L320) *** @@ -559,7 +559,7 @@ This option specifies the output format for interface properties: #### Defined in -[options/declarations.ts:336](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/options/declarations.ts#L336) +[options/declarations.ts:336](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/options/declarations.ts#L336) *** @@ -586,7 +586,7 @@ This option specifies the output format for class properties: #### Defined in -[options/declarations.ts:352](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/options/declarations.ts#L352) +[options/declarations.ts:352](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/options/declarations.ts#L352) *** @@ -613,7 +613,7 @@ This option specifies the output format for enumeration members: #### Defined in -[options/declarations.ts:368](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/options/declarations.ts#L368) +[options/declarations.ts:368](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/options/declarations.ts#L368) *** @@ -640,7 +640,7 @@ This option specifies the output format for type declaration of variables and ty #### Defined in -[options/declarations.ts:384](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/options/declarations.ts#L384) +[options/declarations.ts:384](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/options/declarations.ts#L384) *** @@ -669,7 +669,7 @@ Note this options will only take effect when `propertiesFormat` is set to `list` #### Defined in -[options/declarations.ts:402](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/options/declarations.ts#L402) +[options/declarations.ts:402](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/options/declarations.ts#L402) *** @@ -703,7 +703,7 @@ In addition you can control the alignment of the header text. #### Defined in -[options/declarations.ts:432](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/options/declarations.ts#L432) +[options/declarations.ts:432](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/options/declarations.ts#L432) ## Utility @@ -733,7 +733,7 @@ If undefined all urls will be relative. #### Defined in -[options/declarations.ts:453](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/options/declarations.ts#L453) +[options/declarations.ts:453](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/options/declarations.ts#L453) *** @@ -765,7 +765,7 @@ This option would typically be used when source code comes from an external libr #### Defined in -[options/declarations.ts:474](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/options/declarations.ts#L474) +[options/declarations.ts:474](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/options/declarations.ts#L474) *** @@ -793,7 +793,7 @@ This option should be used when parsers require a custom anchor prefix. #### Defined in -[options/declarations.ts:487](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/options/declarations.ts#L487) +[options/declarations.ts:487](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/options/declarations.ts#L487) *** @@ -818,7 +818,7 @@ This option should be used if there are issues with anchoring to symbols within #### Defined in -[options/declarations.ts:501](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/options/declarations.ts#L501) +[options/declarations.ts:501](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/options/declarations.ts#L501) *** @@ -842,7 +842,7 @@ This option can be used for engines that require the preservation of anchor link #### Defined in -[options/declarations.ts:514](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/options/declarations.ts#L514) +[options/declarations.ts:514](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/options/declarations.ts#L514) *** @@ -883,7 +883,7 @@ If you are looking for general localization support please see [localization](). #### Defined in -[options/declarations.ts:534](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/options/declarations.ts#L534) +[options/declarations.ts:534](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/options/declarations.ts#L534) *** @@ -933,4 +933,4 @@ export function load(app: MarkdownApplication) { #### Defined in -[options/declarations.ts:584](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/options/declarations.ts#L584) +[options/declarations.ts:584](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/options/declarations.ts#L584) diff --git a/devguide/typedoc-plugin-markdown/renderer/README.md b/devguide/typedoc-plugin-markdown/renderer/README.md index 137ddbf4..9d984d8f 100644 --- a/devguide/typedoc-plugin-markdown/renderer/README.md +++ b/devguide/typedoc-plugin-markdown/renderer/README.md @@ -29,7 +29,7 @@ Replacement of TypeDoc's Application.generateDocs method to decouple HTML logic. ### Defined in -[renderer/overrides.ts:16](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/renderer/overrides.ts#L16) +[renderer/overrides.ts:16](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/renderer/overrides.ts#L16) *** @@ -58,7 +58,7 @@ This is essentially a copy of the base method with a few tweaks. ### Defined in -[renderer/overrides.ts:38](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/renderer/overrides.ts#L38) +[renderer/overrides.ts:38](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/renderer/overrides.ts#L38) *** @@ -84,4 +84,4 @@ By intercepting the package options set in the converter and storing them on the ### Defined in -[renderer/packages.ts:11](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/renderer/packages.ts#L11) +[renderer/packages.ts:11](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/renderer/packages.ts#L11) diff --git a/devguide/typedoc-plugin-markdown/theme/classes/MarkdownTheme.md b/devguide/typedoc-plugin-markdown/theme/classes/MarkdownTheme.md index 48ad03a0..7ae0ba48 100644 --- a/devguide/typedoc-plugin-markdown/theme/classes/MarkdownTheme.md +++ b/devguide/typedoc-plugin-markdown/theme/classes/MarkdownTheme.md @@ -52,7 +52,7 @@ The API follows the implementation of [TypeDoc's custom theming](https://github. #### Defined in -[theme/markdown-theme.ts:29](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts#L29) +[theme/markdown-theme.ts:29](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts#L29) ## Methods @@ -81,7 +81,7 @@ Renders a template and page model to a string. #### Defined in -[theme/markdown-theme.ts:38](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts#L38) +[theme/markdown-theme.ts:38](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts#L38) *** @@ -105,7 +105,7 @@ This method can be overridden to provide an alternative theme context. #### Defined in -[theme/markdown-theme.ts:55](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts#L55) +[theme/markdown-theme.ts:55](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts#L55) *** @@ -131,7 +131,7 @@ Maps the models of the given project to the desired output files. #### Defined in -[theme/markdown-theme.ts:62](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts#L62) +[theme/markdown-theme.ts:62](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts#L62) *** @@ -153,7 +153,7 @@ Map the models of the given project to a navigation structure. #### Defined in -[theme/markdown-theme.ts:69](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts#L69) +[theme/markdown-theme.ts:69](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts#L69) *** @@ -176,7 +176,7 @@ Map the models of the given project to a navigation structure. #### Defined in -[theme/markdown-theme.ts:76](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts#L76) +[theme/markdown-theme.ts:76](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts#L76) *** @@ -198,7 +198,7 @@ Map the models of the given project to a navigation structure. #### Defined in -[theme/markdown-theme.ts:200](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts#L200) +[theme/markdown-theme.ts:200](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts#L200) *** @@ -220,7 +220,7 @@ Map the models of the given project to a navigation structure. #### Defined in -[theme/markdown-theme.ts:207](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts#L207) +[theme/markdown-theme.ts:207](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts#L207) *** @@ -242,7 +242,7 @@ Map the models of the given project to a navigation structure. #### Defined in -[theme/markdown-theme.ts:214](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts#L214) +[theme/markdown-theme.ts:214](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts#L214) *** @@ -264,4 +264,4 @@ Map the models of the given project to a navigation structure. #### Defined in -[theme/markdown-theme.ts:221](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts#L221) +[theme/markdown-theme.ts:221](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts#L221) diff --git a/devguide/typedoc-plugin-markdown/theme/classes/MarkdownThemeContext.md b/devguide/typedoc-plugin-markdown/theme/classes/MarkdownThemeContext.md index 774dbd88..7a0a1b99 100644 --- a/devguide/typedoc-plugin-markdown/theme/classes/MarkdownThemeContext.md +++ b/devguide/typedoc-plugin-markdown/theme/classes/MarkdownThemeContext.md @@ -129,7 +129,7 @@ This class can be used to customize the theme output by extending the class and #### Defined in -[theme/markdown-themeContext.ts:48](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/theme/markdown-themeContext.ts#L48) +[theme/markdown-themeContext.ts:48](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/theme/markdown-themeContext.ts#L48) ## Properties @@ -141,7 +141,7 @@ Properties are passed into the constructor and are used to provide context to th #### Defined in -[theme/markdown-themeContext.ts:42](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/theme/markdown-themeContext.ts#L42) +[theme/markdown-themeContext.ts:42](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/theme/markdown-themeContext.ts#L42) *** @@ -151,7 +151,7 @@ Properties are passed into the constructor and are used to provide context to th #### Defined in -[theme/markdown-themeContext.ts:43](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/theme/markdown-themeContext.ts#L43) +[theme/markdown-themeContext.ts:43](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/theme/markdown-themeContext.ts#L43) *** @@ -163,7 +163,7 @@ The theme instance. #### Defined in -[theme/markdown-themeContext.ts:52](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/theme/markdown-themeContext.ts#L52) +[theme/markdown-themeContext.ts:52](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/theme/markdown-themeContext.ts#L52) *** @@ -175,7 +175,7 @@ The current page event. #### Defined in -[theme/markdown-themeContext.ts:56](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/theme/markdown-themeContext.ts#L56) +[theme/markdown-themeContext.ts:56](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/theme/markdown-themeContext.ts#L56) *** @@ -187,7 +187,7 @@ The options provided to the application. #### Defined in -[theme/markdown-themeContext.ts:60](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/theme/markdown-themeContext.ts#L60) +[theme/markdown-themeContext.ts:60](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/theme/markdown-themeContext.ts#L60) *** @@ -201,7 +201,7 @@ This is required for generating package specific documentation. #### Defined in -[theme/markdown-themeContext.ts:72](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/theme/markdown-themeContext.ts#L72) +[theme/markdown-themeContext.ts:72](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/theme/markdown-themeContext.ts#L72) ## Methods @@ -227,7 +227,7 @@ Returns the package meta data for a given package name when entrypointStrategy i #### Defined in -[theme/markdown-themeContext.ts:122](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/theme/markdown-themeContext.ts#L122) +[theme/markdown-themeContext.ts:122](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/theme/markdown-themeContext.ts#L122) *** @@ -252,7 +252,7 @@ If public path is set, it will be used as the base URL. #### Defined in -[theme/markdown-themeContext.ts:134](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/theme/markdown-themeContext.ts#L134) +[theme/markdown-themeContext.ts:134](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/theme/markdown-themeContext.ts#L134) *** @@ -276,7 +276,7 @@ Hook into the TypeDoc rendering system. #### Defined in -[theme/markdown-themeContext.ts:164](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/theme/markdown-themeContext.ts#L164) +[theme/markdown-themeContext.ts:164](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/theme/markdown-themeContext.ts#L164) ## Resources @@ -356,7 +356,7 @@ Template that maps to individual reflection models. #### Defined in -[theme/markdown-themeContext.ts:80](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/theme/markdown-themeContext.ts#L80) +[theme/markdown-themeContext.ts:80](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/theme/markdown-themeContext.ts#L80) *** @@ -1270,7 +1270,7 @@ There is no association list partial for properties as these are handled as a st #### Defined in -[theme/markdown-themeContext.ts:100](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/theme/markdown-themeContext.ts#L100) +[theme/markdown-themeContext.ts:100](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/theme/markdown-themeContext.ts#L100) *** @@ -1533,4 +1533,4 @@ Please note that partials: #### Defined in -[theme/markdown-themeContext.ts:113](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/theme/markdown-themeContext.ts#L113) +[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/types/interfaces/MarkdownApplication.md b/devguide/typedoc-plugin-markdown/types/interfaces/MarkdownApplication.md index f0c433b0..00a339fd 100644 --- a/devguide/typedoc-plugin-markdown/types/interfaces/MarkdownApplication.md +++ b/devguide/typedoc-plugin-markdown/types/interfaces/MarkdownApplication.md @@ -28,4 +28,4 @@ Re-types the `renderer` instance to [`MarkdownRenderer`](MarkdownRenderer.md). #### Defined in -[types/markdown-application.ts:11](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/types/markdown-application.ts#L11) +[types/markdown-application.ts:11](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/markdown-application.ts#L11) diff --git a/devguide/typedoc-plugin-markdown/types/interfaces/MarkdownRenderer.md b/devguide/typedoc-plugin-markdown/types/interfaces/MarkdownRenderer.md index 2d460ddd..feb83e3f 100644 --- a/devguide/typedoc-plugin-markdown/types/interfaces/MarkdownRenderer.md +++ b/devguide/typedoc-plugin-markdown/types/interfaces/MarkdownRenderer.md @@ -28,7 +28,7 @@ Replaces the event hooks typings the [`MarkdownRendererHooks`](MarkdownRendererH #### Defined in -[types/markdown-renderer.ts:13](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/types/markdown-renderer.ts#L13) +[types/markdown-renderer.ts:13](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/markdown-renderer.ts#L13) *** @@ -40,7 +40,7 @@ Replaces the event hooks typings the [`MarkdownRendererHooks`](MarkdownRendererH #### Defined in -[types/markdown-renderer.ts:15](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/types/markdown-renderer.ts#L15) +[types/markdown-renderer.ts:15](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/markdown-renderer.ts#L15) *** @@ -67,7 +67,7 @@ Replaces the event hooks typings the [`MarkdownRendererHooks`](MarkdownRendererH #### Defined in -[types/markdown-renderer.ts:17](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/types/markdown-renderer.ts#L17) +[types/markdown-renderer.ts:17](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/markdown-renderer.ts#L17) *** @@ -83,7 +83,7 @@ Re-types the returned argument argument to [`MarkdownRendererEvent`](../../event #### Defined in -[types/markdown-renderer.ts:24](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/types/markdown-renderer.ts#L24) +[types/markdown-renderer.ts:24](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/markdown-renderer.ts#L24) *** @@ -99,4 +99,4 @@ Re-types the returned argument argument to [`MarkdownRendererEvent`](../../event #### Defined in -[types/markdown-renderer.ts:28](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/types/markdown-renderer.ts#L28) +[types/markdown-renderer.ts:28](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/markdown-renderer.ts#L28) diff --git a/devguide/typedoc-plugin-markdown/types/interfaces/MarkdownRendererHooks.md b/devguide/typedoc-plugin-markdown/types/interfaces/MarkdownRendererHooks.md index 3bba453c..3225fa29 100644 --- a/devguide/typedoc-plugin-markdown/types/interfaces/MarkdownRendererHooks.md +++ b/devguide/typedoc-plugin-markdown/types/interfaces/MarkdownRendererHooks.md @@ -14,7 +14,7 @@ Applied at the start of the markdown output. #### Defined in -[types/markdown-renderer-hooks.ts:12](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/types/markdown-renderer-hooks.ts#L12) +[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) *** @@ -26,7 +26,7 @@ Applied at the end of the markdown output. #### Defined in -[types/markdown-renderer-hooks.ts:19](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/types/markdown-renderer-hooks.ts#L19) +[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) *** @@ -38,7 +38,7 @@ Applied before the main markdown content is rendered. #### Defined in -[types/markdown-renderer-hooks.ts:26](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/types/markdown-renderer-hooks.ts#L26) +[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) *** @@ -50,7 +50,7 @@ Applied at the start of the markdown output on the index page. #### Defined in -[types/markdown-renderer-hooks.ts:33](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/types/markdown-renderer-hooks.ts#L33) +[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) *** @@ -62,4 +62,4 @@ Applied at the end of the markdown output on the index page. #### Defined in -[types/markdown-renderer-hooks.ts:40](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/types/markdown-renderer-hooks.ts#L40) +[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) diff --git a/devguide/typedoc-plugin-markdown/types/interfaces/NavigationItem.md b/devguide/typedoc-plugin-markdown/types/interfaces/NavigationItem.md index 96116fda..5ecd58bd 100644 --- a/devguide/typedoc-plugin-markdown/types/interfaces/NavigationItem.md +++ b/devguide/typedoc-plugin-markdown/types/interfaces/NavigationItem.md @@ -12,7 +12,7 @@ The model used to define the navigation structure. #### Defined in -[types/theme.ts:29](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/types/theme.ts#L29) +[types/theme.ts:29](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/theme.ts#L29) *** @@ -22,7 +22,7 @@ The model used to define the navigation structure. #### Defined in -[types/theme.ts:30](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/types/theme.ts#L30) +[types/theme.ts:30](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/theme.ts#L30) *** @@ -32,7 +32,7 @@ The model used to define the navigation structure. #### Defined in -[types/theme.ts:31](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/types/theme.ts#L31) +[types/theme.ts:31](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/theme.ts#L31) *** @@ -42,4 +42,4 @@ The model used to define the navigation structure. #### Defined in -[types/theme.ts:32](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/types/theme.ts#L32) +[types/theme.ts:32](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/theme.ts#L32) diff --git a/devguide/typedoc-plugin-markdown/types/interfaces/PackageMetaData.md b/devguide/typedoc-plugin-markdown/types/interfaces/PackageMetaData.md index 0eef08da..4b42ed4b 100644 --- a/devguide/typedoc-plugin-markdown/types/interfaces/PackageMetaData.md +++ b/devguide/typedoc-plugin-markdown/types/interfaces/PackageMetaData.md @@ -12,7 +12,7 @@ The model used to define the package metadata when in packages mode. #### Defined in -[types/theme.ts:10](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/types/theme.ts#L10) +[types/theme.ts:10](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/theme.ts#L10) *** @@ -22,4 +22,4 @@ The model used to define the package metadata when in packages mode. #### Defined in -[types/theme.ts:11](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/types/theme.ts#L11) +[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 8b2f0058..70d09082 100644 --- a/devguide/typedoc-plugin-markdown/types/interfaces/PluginOptions.md +++ b/devguide/typedoc-plugin-markdown/types/interfaces/PluginOptions.md @@ -70,7 +70,7 @@ Custom anchor prefix when anchoring to in-page symbols. #### Defined in -[types/options.ts:11](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/types/options.ts#L11) +[types/options.ts:11](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/options.ts#L11) *** @@ -82,7 +82,7 @@ Sets the format of property groups for classes. #### Defined in -[types/options.ts:16](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/types/options.ts#L16) +[types/options.ts:16](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/options.ts#L16) *** @@ -94,7 +94,7 @@ The file name of the entry page. #### Defined in -[types/options.ts:21](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/types/options.ts#L21) +[types/options.ts:21](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/options.ts#L21) *** @@ -106,7 +106,7 @@ The name of a module that should act as the root page for the documentation. #### Defined in -[types/options.ts:26](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/types/options.ts#L26) +[types/options.ts:26](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/options.ts#L26) *** @@ -118,7 +118,7 @@ Sets the format of enumeration members. #### Defined in -[types/options.ts:31](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/types/options.ts#L31) +[types/options.ts:31](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/options.ts#L31) *** @@ -132,7 +132,7 @@ This option has been renamed hideGroupHeadings to better reflect its purpose. #### Defined in -[types/options.ts:36](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/types/options.ts#L36) +[types/options.ts:36](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/options.ts#L36) *** @@ -144,7 +144,7 @@ Exclude writing @ scope directories in paths. #### Defined in -[types/options.ts:41](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/types/options.ts#L41) +[types/options.ts:41](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/options.ts#L41) *** @@ -156,7 +156,7 @@ Expand objects inside declarations. #### Defined in -[types/options.ts:46](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/types/options.ts#L46) +[types/options.ts:46](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/options.ts#L46) *** @@ -168,7 +168,7 @@ Expand parameters in signature parentheses to display type information. #### Defined in -[types/options.ts:51](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/types/options.ts#L51) +[types/options.ts:51](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/options.ts#L51) *** @@ -180,7 +180,7 @@ Specify the file extension for generated output files. #### Defined in -[types/options.ts:56](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/types/options.ts#L56) +[types/options.ts:56](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/options.ts#L56) *** @@ -192,7 +192,7 @@ Flatten output files to a single directory. #### Defined in -[types/options.ts:61](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/types/options.ts#L61) +[types/options.ts:61](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/options.ts#L61) *** @@ -204,7 +204,7 @@ Do not print breadcrumbs. #### Defined in -[types/options.ts:66](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/types/options.ts#L66) +[types/options.ts:66](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/options.ts#L66) *** @@ -216,7 +216,7 @@ Excludes grouping by kind so all members are rendered and sorted at the same lev #### Defined in -[types/options.ts:71](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/types/options.ts#L71) +[types/options.ts:71](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/options.ts#L71) *** @@ -228,7 +228,7 @@ Do not print page header. #### Defined in -[types/options.ts:76](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/types/options.ts#L76) +[types/options.ts:76](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/options.ts#L76) *** @@ -240,7 +240,7 @@ Do not print page title. #### Defined in -[types/options.ts:81](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/types/options.ts#L81) +[types/options.ts:81](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/options.ts#L81) *** @@ -252,7 +252,7 @@ Sets the format of index items. #### Defined in -[types/options.ts:86](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/types/options.ts#L86) +[types/options.ts:86](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/options.ts#L86) *** @@ -264,7 +264,7 @@ Sets the format of property groups for interfaces. #### Defined in -[types/options.ts:91](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/types/options.ts#L91) +[types/options.ts:91](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/options.ts#L91) *** @@ -276,7 +276,7 @@ Determines which members are exported to their own file when `outputFileStrategy #### Defined in -[types/options.ts:96](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/types/options.ts#L96) +[types/options.ts:96](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/options.ts#L96) *** @@ -288,7 +288,7 @@ Merges the resolved readme into the project index page. #### Defined in -[types/options.ts:108](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/types/options.ts#L108) +[types/options.ts:108](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/options.ts#L108) *** @@ -312,7 +312,7 @@ Configures how the navigation model will be generated. #### Defined in -[types/options.ts:113](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/types/options.ts#L113) +[types/options.ts:113](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/options.ts#L113) *** @@ -324,7 +324,7 @@ Determines how output files are generated. #### Defined in -[types/options.ts:122](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/types/options.ts#L122) +[types/options.ts:122](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/options.ts#L122) *** @@ -336,7 +336,7 @@ Sets the format of parameter and type parameter groups. #### Defined in -[types/options.ts:127](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/types/options.ts#L127) +[types/options.ts:127](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/options.ts#L127) *** @@ -348,7 +348,7 @@ Preserve anchor casing when generating link to symbols. #### Defined in -[types/options.ts:132](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/types/options.ts#L132) +[types/options.ts:132](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/options.ts#L132) *** @@ -360,7 +360,7 @@ Sets the format of property groups for interfaces and classes. #### Defined in -[types/options.ts:137](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/types/options.ts#L137) +[types/options.ts:137](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/options.ts#L137) *** @@ -372,7 +372,7 @@ Sets the format of style for property members for interfaces and classes. #### Defined in -[types/options.ts:142](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/types/options.ts#L142) +[types/options.ts:142](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/options.ts#L142) *** @@ -384,7 +384,7 @@ Specify the base path for all urls. #### Defined in -[types/options.ts:147](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/types/options.ts#L147) +[types/options.ts:147](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/options.ts#L147) *** @@ -396,7 +396,7 @@ Sanitize HTML and JSX inside JsDoc comments. #### Defined in -[types/options.ts:152](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/types/options.ts#L152) +[types/options.ts:152](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/options.ts#L152) *** @@ -436,7 +436,7 @@ Control how table columns are configured and displayed. #### Defined in -[types/options.ts:157](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/types/options.ts#L157) +[types/options.ts:157](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/options.ts#L157) *** @@ -472,7 +472,7 @@ Change specific text placeholders in the template. #### Defined in -[types/options.ts:170](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/types/options.ts#L170) +[types/options.ts:170](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/options.ts#L170) *** @@ -484,7 +484,7 @@ Sets the format of style for type declaration members. #### Defined in -[types/options.ts:182](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/types/options.ts#L182) +[types/options.ts:182](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/options.ts#L182) *** @@ -496,7 +496,7 @@ Wraps signatures and declarations in code blocks. #### Defined in -[types/options.ts:187](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/types/options.ts#L187) +[types/options.ts:187](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/options.ts#L187) *** @@ -508,4 +508,4 @@ Add HTML named anchors to headings and table rows. #### Defined in -[types/options.ts:192](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/types/options.ts#L192) +[types/options.ts:192](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/options.ts#L192) diff --git a/devguide/typedoc-plugin-markdown/types/interfaces/TemplateMapping.md b/devguide/typedoc-plugin-markdown/types/interfaces/TemplateMapping.md index 58944802..1f57a8d2 100644 --- a/devguide/typedoc-plugin-markdown/types/interfaces/TemplateMapping.md +++ b/devguide/typedoc-plugin-markdown/types/interfaces/TemplateMapping.md @@ -12,7 +12,7 @@ Defines how reflections are mapped to urls. #### Defined in -[types/theme.ts:39](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/types/theme.ts#L39) +[types/theme.ts:39](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/theme.ts#L39) *** @@ -22,7 +22,7 @@ Defines how reflections are mapped to urls. #### Defined in -[types/theme.ts:40](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/types/theme.ts#L40) +[types/theme.ts:40](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/theme.ts#L40) *** @@ -32,4 +32,4 @@ Defines how reflections are mapped to urls. #### Defined in -[types/theme.ts:41](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/types/theme.ts#L41) +[types/theme.ts:41](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/theme.ts#L41) diff --git a/devguide/typedoc-plugin-markdown/types/interfaces/TranslatableStrings.md b/devguide/typedoc-plugin-markdown/types/interfaces/TranslatableStrings.md index e5ba12f2..7cb37d4c 100644 --- a/devguide/typedoc-plugin-markdown/types/interfaces/TranslatableStrings.md +++ b/devguide/typedoc-plugin-markdown/types/interfaces/TranslatableStrings.md @@ -12,7 +12,7 @@ The model of translatable strings specific to the Markdown theme. #### Defined in -[types/internationalization.ts:11](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/types/internationalization.ts#L11) +[types/internationalization.ts:11](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/internationalization.ts#L11) *** @@ -22,7 +22,7 @@ The model of translatable strings specific to the Markdown theme. #### Defined in -[types/internationalization.ts:12](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/types/internationalization.ts#L12) +[types/internationalization.ts:12](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/internationalization.ts#L12) *** @@ -32,7 +32,7 @@ The model of translatable strings specific to the Markdown theme. #### Defined in -[types/internationalization.ts:13](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/types/internationalization.ts#L13) +[types/internationalization.ts:13](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/internationalization.ts#L13) *** @@ -42,7 +42,7 @@ The model of translatable strings specific to the Markdown theme. #### Defined in -[types/internationalization.ts:14](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/types/internationalization.ts#L14) +[types/internationalization.ts:14](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/internationalization.ts#L14) *** @@ -52,7 +52,7 @@ The model of translatable strings specific to the Markdown theme. #### Defined in -[types/internationalization.ts:15](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/types/internationalization.ts#L15) +[types/internationalization.ts:15](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/internationalization.ts#L15) *** @@ -62,7 +62,17 @@ The model of translatable strings specific to the Markdown theme. #### Defined in -[types/internationalization.ts:16](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/types/internationalization.ts#L16) +[types/internationalization.ts:16](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/internationalization.ts#L16) + +*** + +### theme\_globals + +> **theme\_globals**: `string` + +#### Defined in + +[types/internationalization.ts:17](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/internationalization.ts#L17) *** @@ -72,7 +82,7 @@ The model of translatable strings specific to the Markdown theme. #### Defined in -[types/internationalization.ts:17](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/types/internationalization.ts#L17) +[types/internationalization.ts:18](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/internationalization.ts#L18) *** @@ -82,7 +92,7 @@ The model of translatable strings specific to the Markdown theme. #### Defined in -[types/internationalization.ts:18](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/types/internationalization.ts#L18) +[types/internationalization.ts:19](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/internationalization.ts#L19) *** @@ -92,7 +102,7 @@ The model of translatable strings specific to the Markdown theme. #### Defined in -[types/internationalization.ts:19](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/types/internationalization.ts#L19) +[types/internationalization.ts:20](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/internationalization.ts#L20) *** @@ -102,7 +112,7 @@ The model of translatable strings specific to the Markdown theme. #### Defined in -[types/internationalization.ts:20](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/types/internationalization.ts#L20) +[types/internationalization.ts:21](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/internationalization.ts#L21) *** @@ -112,7 +122,7 @@ The model of translatable strings specific to the Markdown theme. #### Defined in -[types/internationalization.ts:21](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/types/internationalization.ts#L21) +[types/internationalization.ts:22](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/internationalization.ts#L22) *** @@ -122,7 +132,7 @@ The model of translatable strings specific to the Markdown theme. #### Defined in -[types/internationalization.ts:22](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/types/internationalization.ts#L22) +[types/internationalization.ts:23](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/internationalization.ts#L23) *** @@ -132,7 +142,7 @@ The model of translatable strings specific to the Markdown theme. #### Defined in -[types/internationalization.ts:23](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/types/internationalization.ts#L23) +[types/internationalization.ts:24](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/internationalization.ts#L24) *** @@ -142,4 +152,4 @@ The model of translatable strings specific to the Markdown theme. #### Defined in -[types/internationalization.ts:24](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/types/internationalization.ts#L24) +[types/internationalization.ts:25](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/internationalization.ts#L25) diff --git a/devguide/typedoc-plugin-markdown/types/interfaces/UrlMapping.md b/devguide/typedoc-plugin-markdown/types/interfaces/UrlMapping.md index 2a969a18..2411e26e 100644 --- a/devguide/typedoc-plugin-markdown/types/interfaces/UrlMapping.md +++ b/devguide/typedoc-plugin-markdown/types/interfaces/UrlMapping.md @@ -26,7 +26,7 @@ The model used to define the URL mapping structure. #### Defined in -[types/theme.ts:19](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/types/theme.ts#L19) +[types/theme.ts:19](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/theme.ts#L19) *** @@ -36,7 +36,7 @@ The model used to define the URL mapping structure. #### Defined in -[types/theme.ts:20](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/types/theme.ts#L20) +[types/theme.ts:20](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/theme.ts#L20) *** @@ -56,4 +56,4 @@ The model used to define the URL mapping structure. #### Defined in -[types/theme.ts:21](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/types/theme.ts#L21) +[types/theme.ts:21](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/theme.ts#L21) diff --git a/devguide/typedoc-plugin-markdown/types/interfaces/UrlOption.md b/devguide/typedoc-plugin-markdown/types/interfaces/UrlOption.md index e1896070..b40776cd 100644 --- a/devguide/typedoc-plugin-markdown/types/interfaces/UrlOption.md +++ b/devguide/typedoc-plugin-markdown/types/interfaces/UrlOption.md @@ -12,7 +12,7 @@ Used internally when building the URL mapping. #### Defined in -[types/theme.ts:48](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/types/theme.ts#L48) +[types/theme.ts:48](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/theme.ts#L48) *** @@ -22,7 +22,7 @@ Used internally when building the URL mapping. #### Defined in -[types/theme.ts:49](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/types/theme.ts#L49) +[types/theme.ts:49](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/theme.ts#L49) *** @@ -32,7 +32,7 @@ Used internally when building the URL mapping. #### Defined in -[types/theme.ts:50](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/types/theme.ts#L50) +[types/theme.ts:50](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/theme.ts#L50) *** @@ -42,7 +42,7 @@ Used internally when building the URL mapping. #### Defined in -[types/theme.ts:51](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/types/theme.ts#L51) +[types/theme.ts:51](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/theme.ts#L51) *** @@ -52,7 +52,7 @@ Used internally when building the URL mapping. #### Defined in -[types/theme.ts:52](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/types/theme.ts#L52) +[types/theme.ts:52](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/theme.ts#L52) *** @@ -62,4 +62,4 @@ Used internally when building the URL mapping. #### Defined in -[types/theme.ts:53](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/types/theme.ts#L53) +[types/theme.ts:53](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/theme.ts#L53) diff --git a/devguide/typedoc-plugin-markdown/types/type-aliases/RenderTemplate.md b/devguide/typedoc-plugin-markdown/types/type-aliases/RenderTemplate.md index c8f7fedf..365329cd 100644 --- a/devguide/typedoc-plugin-markdown/types/type-aliases/RenderTemplate.md +++ b/devguide/typedoc-plugin-markdown/types/type-aliases/RenderTemplate.md @@ -24,4 +24,4 @@ Defines the template type to use for rendering. ## Defined in -[types/theme.ts:59](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/types/theme.ts#L59) +[types/theme.ts:59](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/theme.ts#L59) diff --git a/devguide/typedoc-plugin-remark/index/README.md b/devguide/typedoc-plugin-remark/index/README.md index e1077a9f..744b4b34 100644 --- a/devguide/typedoc-plugin-remark/index/README.md +++ b/devguide/typedoc-plugin-remark/index/README.md @@ -20,4 +20,4 @@ The plugin entrypoint and bootstrapping of the plugin. ### Defined in -[index.ts:12](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-remark/src/index.ts#L12) +[index.ts:12](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-remark/src/index.ts#L12) diff --git a/devguide/typedoc-plugin-remark/options/namespaces/declarations/README.md b/devguide/typedoc-plugin-remark/options/namespaces/declarations/README.md index a19b7e75..84d980e8 100644 --- a/devguide/typedoc-plugin-remark/options/namespaces/declarations/README.md +++ b/devguide/typedoc-plugin-remark/options/namespaces/declarations/README.md @@ -42,7 +42,7 @@ Please note that `remark-frontmatter`, `remark-gfm`, and `remark-mdx` are always ### Defined in -[options/declarations.ts:14](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-remark/src/options/declarations.ts#L14) +[options/declarations.ts:14](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-remark/src/options/declarations.ts#L14) *** @@ -74,4 +74,4 @@ Please see [https://github.com/remarkjs/remark/tree/main/packages/remark-stringi ### Defined in -[options/declarations.ts:34](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-remark/src/options/declarations.ts#L34) +[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 index 6cbef8e5..26b49259 100644 --- a/devguide/typedoc-plugin-remark/options/namespaces/helpers/README.md +++ b/devguide/typedoc-plugin-remark/options/namespaces/helpers/README.md @@ -21,4 +21,4 @@ ### Defined in -[options/helpers.ts:3](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-remark/src/options/helpers.ts#L3) +[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/interfaces/PluginOptions.md b/devguide/typedoc-plugin-remark/types/interfaces/PluginOptions.md index 92e8f74c..d3a3fd0c 100644 --- a/devguide/typedoc-plugin-remark/types/interfaces/PluginOptions.md +++ b/devguide/typedoc-plugin-remark/types/interfaces/PluginOptions.md @@ -14,7 +14,7 @@ An array of remark plugin names. #### Defined in -[types/options.ts:11](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-remark/src/types/options.ts#L11) +[types/options.ts:11](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-remark/src/types/options.ts#L11) *** @@ -26,4 +26,4 @@ Custom options for the remark-stringify plugin. #### Defined in -[types/options.ts:16](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-remark/src/types/options.ts#L16) +[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/index/README.md b/devguide/typedoc-vitepress-theme/index/README.md index 0d246557..504833e0 100644 --- a/devguide/typedoc-vitepress-theme/index/README.md +++ b/devguide/typedoc-vitepress-theme/index/README.md @@ -20,4 +20,4 @@ The plugin entrypoint and bootstrapping of the plugin. ### Defined in -[index.ts:18](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-vitepress-theme/src/index.ts#L18) +[index.ts:18](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-vitepress-theme/src/index.ts#L18) diff --git a/devguide/typedoc-vitepress-theme/options/namespaces/declarations/README.md b/devguide/typedoc-vitepress-theme/options/namespaces/declarations/README.md index 430a022b..c0eab503 100644 --- a/devguide/typedoc-vitepress-theme/options/namespaces/declarations/README.md +++ b/devguide/typedoc-vitepress-theme/options/namespaces/declarations/README.md @@ -15,16 +15,14 @@ If TypeDoc is run from outside of the VitePress project root directory, then `do e.g. the following file structure: -\ -\ -\ -\ -\\ -\ -\ -\ -\ -\ +``` + ├── package.json + ├── typedoc.json + └── docs/ + └── .vitepress/ + └── typedoc-api/ + └── index.md +``` Requires the following config: @@ -45,7 +43,7 @@ Requires the following config: ### Defined in -[options/declarations.ts:30](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-vitepress-theme/src/options/declarations.ts#L30) +[options/declarations.ts:28](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-vitepress-theme/src/options/declarations.ts#L28) *** @@ -81,4 +79,4 @@ Pretty format the sidebar JSON. ### Defined in -[options/declarations.ts:56](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-vitepress-theme/src/options/declarations.ts#L56) +[options/declarations.ts:54](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-vitepress-theme/src/options/declarations.ts#L54) diff --git a/devguide/typedoc-vitepress-theme/options/namespaces/presets/README.md b/devguide/typedoc-vitepress-theme/options/namespaces/presets/README.md index 70fed150..b00a23fc 100644 --- a/devguide/typedoc-vitepress-theme/options/namespaces/presets/README.md +++ b/devguide/typedoc-vitepress-theme/options/namespaces/presets/README.md @@ -16,4 +16,4 @@ ### Defined in -[options/presets.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-vitepress-theme/src/options/presets.ts#L1) +[options/presets.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-vitepress-theme/src/options/presets.ts#L1) diff --git a/devguide/typedoc-vitepress-theme/types/interfaces/PluginOptions.md b/devguide/typedoc-vitepress-theme/types/interfaces/PluginOptions.md index 2c4f8fce..877222d9 100644 --- a/devguide/typedoc-vitepress-theme/types/interfaces/PluginOptions.md +++ b/devguide/typedoc-vitepress-theme/types/interfaces/PluginOptions.md @@ -14,7 +14,7 @@ The path to the VitePress project root. #### Defined in -[types/options.ts:11](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/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) *** @@ -26,4 +26,4 @@ Configures the autogenerated VitePress sidebar. #### Defined in -[types/options.ts:16](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/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) diff --git a/devguide/typedoc-vitepress-theme/types/interfaces/Sidebar.md b/devguide/typedoc-vitepress-theme/types/interfaces/Sidebar.md index e72d04a4..db41d24d 100644 --- a/devguide/typedoc-vitepress-theme/types/interfaces/Sidebar.md +++ b/devguide/typedoc-vitepress-theme/types/interfaces/Sidebar.md @@ -10,7 +10,7 @@ #### Defined in -[types/options.ts:23](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-vitepress-theme/src/types/options.ts#L23) +[types/options.ts:23](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-vitepress-theme/src/types/options.ts#L23) *** @@ -20,7 +20,7 @@ #### Defined in -[types/options.ts:24](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-vitepress-theme/src/types/options.ts#L24) +[types/options.ts:24](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-vitepress-theme/src/types/options.ts#L24) *** @@ -30,7 +30,7 @@ #### Defined in -[types/options.ts:25](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-vitepress-theme/src/types/options.ts#L25) +[types/options.ts:25](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-vitepress-theme/src/types/options.ts#L25) *** @@ -40,4 +40,4 @@ #### Defined in -[types/options.ts:26](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-vitepress-theme/src/types/options.ts#L26) +[types/options.ts:26](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-vitepress-theme/src/types/options.ts#L26) diff --git a/docs/pages/plugins/vitepress/options.mdx b/docs/pages/plugins/vitepress/options.mdx index 5e716d41..c981f438 100644 --- a/docs/pages/plugins/vitepress/options.mdx +++ b/docs/pages/plugins/vitepress/options.mdx @@ -33,16 +33,14 @@ If TypeDoc is run from outside of the VitePress project root directory, then `do e.g. the following file structure: - - - - - - - - - - +``` + ├── package.json + ├── typedoc.json + └── docs/ + └── .vitepress/ + └── typedoc-api/ + └── index.md +``` Requires the following config: diff --git a/packages/typedoc-plugin-markdown/src/internationalization/locales/index.ts b/packages/typedoc-plugin-markdown/src/internationalization/locales/index.ts index 1a3fe729..b09bf178 100644 --- a/packages/typedoc-plugin-markdown/src/internationalization/locales/index.ts +++ b/packages/typedoc-plugin-markdown/src/internationalization/locales/index.ts @@ -3,7 +3,7 @@ * * The translatable strings configured in the plugin are only additional strings that are not present in TypeDoc core. * - * To add a new locale or edit and existing locale (if you think the strings are incorrect). + * To add a new locale or edit and existing locale (if you think the strings are incorrect) please update the individual locale file. * * @module */ diff --git a/packages/typedoc-vitepress-theme/src/options/declarations.ts b/packages/typedoc-vitepress-theme/src/options/declarations.ts index 8b1f310f..7b72a7ce 100644 --- a/packages/typedoc-vitepress-theme/src/options/declarations.ts +++ b/packages/typedoc-vitepress-theme/src/options/declarations.ts @@ -7,16 +7,14 @@ import { DEFAULT_SIDEBAR_OPTIONS } from '../options'; * * e.g. the following file structure: * - * - * - * - * - * - * - * - * - * - * + * ``` + * ├── package.json + * ├── typedoc.json + * └── docs/ + * └── .vitepress/ + * └── typedoc-api/ + * └── index.md + * ``` * * Requires the following config: * diff --git a/typedoc.json b/typedoc.json index 69f4f7df..543937b3 100644 --- a/typedoc.json +++ b/typedoc.json @@ -29,7 +29,8 @@ "readme": "./OVERVIEW.md", "sortEntryPoints": false, "sort": "source-order", - "excludeExternals": true + "excludeExternals": true, + "gitRevision": "main" }, // typedoc-plugin-markdown options