From 755950097942cbcd287845557fe80a84c8caab4d Mon Sep 17 00:00:00 2001 From: tgreyuk Date: Tue, 18 Jun 2024 16:50:10 +0100 Subject: [PATCH] chore(docs): docs update --- .prettierrc.json | 2 +- CONTRIBUTING.md | 37 +- .../types/interfaces/Sidebar.md | 23 - .../types/interfaces/FrontmatterGlobals.md | 3 - .../types/interfaces/IndexFrontmatter.md | 3 - .../types/interfaces/ReadmeFrontmatter.md | 3 - .../documents/Testing.md | 29 - .../typedoc-plugin-markdown/options/README.md | 15 - .../typedoc-plugin-markdown/theme/README.md | 14 - .../typedoc-vitepress-theme/index/README.md | 23 - {developer-docs => devguide}/README.md | 57 +- .../docusaurus-plugin-typedoc/README.md | 6 +- .../docusaurus-plugin-typedoc/index/README.md | 4 +- .../index/interfaces/PluginOptions.md | 6 +- .../options/README.md | 2 +- .../options/namespaces/declarations/README.md | 4 +- .../options/namespaces/presets/README.md | 4 +- .../types/README.md | 2 +- .../types/interfaces/PluginOptions.md | 4 +- .../types/interfaces/Sidebar.md | 23 + .../typedoc-github-wiki-theme/README.md | 6 +- .../typedoc-github-wiki-theme/index/README.md | 6 +- .../options/README.md | 2 +- .../options/namespaces/declarations/README.md | 4 +- .../options/namespaces/presets/README.md | 4 +- .../types/README.md | 2 +- .../types/interfaces/PluginOptions.md | 4 +- .../types/interfaces/Sidebar.md | 6 +- .../typedoc-gitlab-wiki-theme/README.md | 6 +- .../typedoc-gitlab-wiki-theme/index/README.md | 4 +- .../options/README.md | 2 +- .../options/namespaces/declarations/README.md | 4 +- .../options/namespaces/presets/README.md | 4 +- .../types/README.md | 2 +- .../types/interfaces/PluginOptions.md | 4 +- .../types/interfaces/Sidebar.md | 6 +- .../typedoc-plugin-frontmatter/README.md | 6 +- .../index/README.md | 4 +- .../options/README.md | 2 +- .../options/namespaces/declarations/README.md | 14 +- .../options/namespaces/maps/README.md | 2 +- .../FrontmatterNamingConvention.md | 2 +- .../typedoc-plugin-frontmatter/tags/README.md | 10 +- .../types/README.md | 2 +- .../types/interfaces/FrontmatterGlobals.md | 3 + .../types/interfaces/IndexFrontmatter.md | 3 + .../types/interfaces/PluginOptions.md | 14 +- .../types/interfaces/ReadmeFrontmatter.md | 3 + .../typedoc-plugin-markdown/README.md | 14 +- .../documents/Getting-Started.md | 51 +- .../documents/Test-and-Validation.md | 79 +++ .../typedoc-plugin-markdown/events/README.md | 12 +- .../events/classes/MarkdownPageEvent.md | 36 +- .../events/classes/MarkdownRendererEvent.md | 24 +- .../typedoc-plugin-markdown/index/README.md | 10 +- .../internationalization/README.md | 16 +- .../typedoc-plugin-markdown/libs/README.md | 2 +- .../libs/namespaces/markdown/README.md | 28 +- .../libs/namespaces/utils/README.md | 28 +- .../typedoc-plugin-markdown/options/README.md | 44 ++ .../options/namespaces/constants/README.md | 6 +- .../options/namespaces/declarations/README.md | 163 ++--- .../options/namespaces/maps/README.md | 2 +- .../maps/enumerations/IndexFormat.md | 2 +- .../maps/enumerations/OutputFileStrategy.md | 2 +- .../maps/enumerations/ReflectionFormat.md | 2 +- .../renderer/README.md | 8 +- .../typedoc-plugin-markdown/theme/README.md | 14 + .../theme/classes/MarkdownTheme.md | 53 +- .../theme/classes/MarkdownThemeContext.md | 371 +++++------ .../typedoc-plugin-markdown/types/README.md | 4 +- .../types/interfaces/MarkdownApplication.md | 16 +- .../types/interfaces/MarkdownRenderer.md | 34 +- .../types/interfaces/MarkdownRendererHooks.md | 12 +- .../types/interfaces/NavigationItem.md | 10 +- .../types/interfaces/PackageMetaData.md | 8 +- .../types/interfaces/PluginOptions.md | 66 +- .../types/interfaces/TemplateMapping.md | 8 +- .../types/interfaces/TranslatableStrings.md | 30 +- .../types/interfaces/UrlMapping.md | 8 +- .../types/interfaces/UrlOption.md | 14 +- .../types/type-aliases/RenderTemplate.md | 4 +- .../typedoc-plugin-remark/README.md | 6 +- .../typedoc-plugin-remark/index/README.md | 4 +- .../typedoc-plugin-remark/options/README.md | 2 +- .../options/namespaces/declarations/README.md | 6 +- .../options/namespaces/helpers/README.md | 4 +- .../typedoc-plugin-remark/types/README.md | 2 +- .../types/interfaces/PluginOptions.md | 6 +- .../typedoc-vitepress-theme/README.md | 6 +- .../typedoc-vitepress-theme/index/README.md | 23 + .../options/README.md | 2 +- .../options/namespaces/declarations/README.md | 6 +- .../options/namespaces/presets/README.md | 4 +- .../typedoc-vitepress-theme}/types/README.md | 2 +- .../types/interfaces/PluginOptions.md | 6 +- .../types/interfaces/Sidebar.md | 10 +- .../prebuild-options/tasks/generate-models.ts | 1 + .../typedoc-ignore-typeparam.mjs | 0 .../typedoc-plugins}/typedoc-nextra.mjs | 0 devtools/typedoc-plugins/typedoc-symbols.mjs | 79 +++ docs/global.css | 1 + .../api-docs/Class.MarkdownPageEvent.mdx | 12 +- .../api-docs/Class.MarkdownRendererEvent.mdx | 10 +- docs/pages/api-docs/Class.MarkdownTheme.mdx | 19 +- .../api-docs/Class.MarkdownThemeContext.mdx | 99 +-- .../api-docs/Document.Customizing-Output.mdx | 102 ++- .../pages/api-docs/Document.Local-Plugins.mdx | 4 +- ....mdx => Document.Utilizing-Navigation.mdx} | 2 +- .../Interface.MarkdownApplication.mdx | 19 + .../api-docs/Interface.MarkdownRenderer.mdx | 39 ++ docs/pages/api-docs/_meta.js | 14 +- docs/pages/api-docs/index.mdx | 17 +- docs/pages/docs/changelog/v4.1.mdx | 3 +- docs/pages/docs/options.mdx | 4 +- docs/pages/docs/options/display-options.mdx | 12 +- docs/pages/docs/options/file-options.mdx | 5 +- docs/pages/docs/options/utility-options.mdx | 60 +- docs/pages/docs/typedoc-usage.mdx | 4 +- packages/README.md | 50 ++ .../docusaurus-plugin-typedoc/OVERVIEW.md | 2 +- .../__snapshots__/docusaurus.spec.ts.snap | 382 +---------- .../typedoc-github-wiki-theme/OVERVIEW.md | 2 +- .../typedoc-gitlab-wiki-theme/OVERVIEW.md | 2 +- .../typedoc-plugin-frontmatter/OVERVIEW.md | 2 +- .../.docs/typedoc.json | 106 --- packages/typedoc-plugin-markdown/OVERVIEW.md | 2 +- packages/typedoc-plugin-markdown/package.json | 7 +- .../typedoc-plugin-markdown/src/_typedoc.d.ts | 1 + .../src/events/markdown-page-event.ts | 12 +- .../src/events/markdown-renderer-event.ts | 8 +- packages/typedoc-plugin-markdown/src/index.ts | 12 +- .../src/internationalization/index.ts | 4 + .../src/internationalization/locales/en.ts | 1 + .../src/internationalization/locales/index.ts | 4 + .../src/internationalization/locales/jp.ts | 1 + .../src/internationalization/locales/ko.ts | 1 + .../src/internationalization/locales/zh.ts | 1 + .../src/options/declarations.ts | 81 +-- .../src/options/index.ts | 24 + .../typedoc-plugin-markdown/src/public-api.ts | 8 +- .../src/theme/base/get-navigation.ts | 329 ---------- .../src/theme/base/get-urls.ts | 590 ----------------- .../src/theme/base/index.ts | 4 +- .../src/theme/base/navigation-builder.ts | 357 ++++++++++ .../src/theme/base/url-builder.ts | 611 ++++++++++++++++++ .../src/theme/context/templates/project.ts | 14 +- .../src/theme/index.ts | 2 +- .../src/theme/markdown-theme.ts | 19 +- ...me-context.ts => markdown-themeContext.ts} | 3 + .../src/types/internationalization.ts | 1 + .../src/types/markdown-application.ts | 13 +- .../src/types/markdown-renderer.ts | 23 - .../{ => internal}/getting-started.md | 38 +- .../internal/test-and-validation.md | 70 ++ .../supporting-docs/internationalization.md | 28 - .../{ => public}/customizing-output.md | 102 ++- .../{ => public}/local-plugins.md | 4 +- .../utilizing-navigation.md} | 4 +- .../supporting-docs/testing.md | 27 - .../__snapshots__/navigation.spec.ts.snap | 2 +- packages/typedoc-plugin-markdown/typedoc.json | 4 +- .../typedoc.public.json | 47 ++ packages/typedoc-plugin-remark/OVERVIEW.md | 2 +- .../src/options/helpers.ts | 1 + packages/typedoc-vitepress-theme/OVERVIEW.md | 2 +- packages/typedoc-vitepress-theme/src/index.ts | 60 +- typedoc.json | 88 +-- 168 files changed, 2622 insertions(+), 2707 deletions(-) delete mode 100644 developer-docs/docusaurus-plugin-typedoc/types/interfaces/Sidebar.md delete mode 100644 developer-docs/typedoc-plugin-frontmatter/types/interfaces/FrontmatterGlobals.md delete mode 100644 developer-docs/typedoc-plugin-frontmatter/types/interfaces/IndexFrontmatter.md delete mode 100644 developer-docs/typedoc-plugin-frontmatter/types/interfaces/ReadmeFrontmatter.md delete mode 100644 developer-docs/typedoc-plugin-markdown/documents/Testing.md delete mode 100644 developer-docs/typedoc-plugin-markdown/options/README.md delete mode 100644 developer-docs/typedoc-plugin-markdown/theme/README.md delete mode 100644 developer-docs/typedoc-vitepress-theme/index/README.md rename {developer-docs => devguide}/README.md (50%) rename {developer-docs => devguide}/docusaurus-plugin-typedoc/README.md (83%) rename {developer-docs => devguide}/docusaurus-plugin-typedoc/index/README.md (83%) rename {developer-docs => devguide}/docusaurus-plugin-typedoc/index/interfaces/PluginOptions.md (97%) rename {developer-docs/typedoc-vitepress-theme => devguide/docusaurus-plugin-typedoc}/options/README.md (80%) rename {developer-docs => devguide}/docusaurus-plugin-typedoc/options/namespaces/declarations/README.md (82%) rename {developer-docs => devguide}/docusaurus-plugin-typedoc/options/namespaces/presets/README.md (71%) rename {developer-docs/typedoc-vitepress-theme => devguide/docusaurus-plugin-typedoc}/types/README.md (84%) rename {developer-docs => devguide}/docusaurus-plugin-typedoc/types/interfaces/PluginOptions.md (65%) create mode 100644 devguide/docusaurus-plugin-typedoc/types/interfaces/Sidebar.md rename {developer-docs => devguide}/typedoc-github-wiki-theme/README.md (83%) rename {developer-docs => devguide}/typedoc-github-wiki-theme/index/README.md (80%) rename {developer-docs/typedoc-gitlab-wiki-theme => devguide/typedoc-github-wiki-theme}/options/README.md (80%) rename {developer-docs => devguide}/typedoc-github-wiki-theme/options/namespaces/declarations/README.md (81%) rename {developer-docs => devguide}/typedoc-github-wiki-theme/options/namespaces/presets/README.md (71%) rename {developer-docs/typedoc-gitlab-wiki-theme => devguide/typedoc-github-wiki-theme}/types/README.md (84%) rename {developer-docs => devguide}/typedoc-github-wiki-theme/types/interfaces/PluginOptions.md (63%) rename {developer-docs => devguide}/typedoc-github-wiki-theme/types/interfaces/Sidebar.md (62%) rename {developer-docs => devguide}/typedoc-gitlab-wiki-theme/README.md (83%) rename {developer-docs => devguide}/typedoc-gitlab-wiki-theme/index/README.md (77%) rename {developer-docs/typedoc-github-wiki-theme => devguide/typedoc-gitlab-wiki-theme}/options/README.md (80%) rename {developer-docs => devguide}/typedoc-gitlab-wiki-theme/options/namespaces/declarations/README.md (81%) rename {developer-docs => devguide}/typedoc-gitlab-wiki-theme/options/namespaces/presets/README.md (68%) rename {developer-docs/typedoc-github-wiki-theme => devguide/typedoc-gitlab-wiki-theme}/types/README.md (84%) rename {developer-docs => devguide}/typedoc-gitlab-wiki-theme/types/interfaces/PluginOptions.md (63%) rename {developer-docs => devguide}/typedoc-gitlab-wiki-theme/types/interfaces/Sidebar.md (62%) rename {developer-docs => devguide}/typedoc-plugin-frontmatter/README.md (85%) rename {developer-docs => devguide}/typedoc-plugin-frontmatter/index/README.md (77%) rename {developer-docs => devguide}/typedoc-plugin-frontmatter/options/README.md (80%) rename {developer-docs => devguide}/typedoc-plugin-frontmatter/options/namespaces/declarations/README.md (89%) rename {developer-docs => devguide}/typedoc-plugin-frontmatter/options/namespaces/maps/README.md (71%) rename {developer-docs => devguide}/typedoc-plugin-frontmatter/options/namespaces/maps/enumerations/FrontmatterNamingConvention.md (55%) rename {developer-docs => devguide}/typedoc-plugin-frontmatter/tags/README.md (76%) rename {developer-docs => devguide}/typedoc-plugin-frontmatter/types/README.md (89%) create mode 100644 devguide/typedoc-plugin-frontmatter/types/interfaces/FrontmatterGlobals.md create mode 100644 devguide/typedoc-plugin-frontmatter/types/interfaces/IndexFrontmatter.md rename {developer-docs => devguide}/typedoc-plugin-frontmatter/types/interfaces/PluginOptions.md (78%) create mode 100644 devguide/typedoc-plugin-frontmatter/types/interfaces/ReadmeFrontmatter.md rename {developer-docs => devguide}/typedoc-plugin-markdown/README.md (73%) rename {developer-docs => devguide}/typedoc-plugin-markdown/documents/Getting-Started.md (66%) create mode 100644 devguide/typedoc-plugin-markdown/documents/Test-and-Validation.md rename {developer-docs => devguide}/typedoc-plugin-markdown/events/README.md (73%) rename {developer-docs => devguide}/typedoc-plugin-markdown/events/classes/MarkdownPageEvent.md (50%) rename {developer-docs => devguide}/typedoc-plugin-markdown/events/classes/MarkdownRendererEvent.md (52%) rename {developer-docs => devguide}/typedoc-plugin-markdown/index/README.md (78%) rename {developer-docs => devguide}/typedoc-plugin-markdown/internationalization/README.md (80%) rename {developer-docs => devguide}/typedoc-plugin-markdown/libs/README.md (84%) rename {developer-docs => devguide}/typedoc-plugin-markdown/libs/namespaces/markdown/README.md (77%) rename {developer-docs => devguide}/typedoc-plugin-markdown/libs/namespaces/utils/README.md (73%) create mode 100644 devguide/typedoc-plugin-markdown/options/README.md rename {developer-docs => devguide}/typedoc-plugin-markdown/options/namespaces/constants/README.md (85%) rename {developer-docs => devguide}/typedoc-plugin-markdown/options/namespaces/declarations/README.md (86%) rename {developer-docs => devguide}/typedoc-plugin-markdown/options/namespaces/maps/README.md (84%) rename {developer-docs => devguide}/typedoc-plugin-markdown/options/namespaces/maps/enumerations/IndexFormat.md (59%) rename {developer-docs => devguide}/typedoc-plugin-markdown/options/namespaces/maps/enumerations/OutputFileStrategy.md (61%) rename {developer-docs => devguide}/typedoc-plugin-markdown/options/namespaces/maps/enumerations/ReflectionFormat.md (64%) rename {developer-docs => devguide}/typedoc-plugin-markdown/renderer/README.md (91%) create mode 100644 devguide/typedoc-plugin-markdown/theme/README.md rename {developer-docs => devguide}/typedoc-plugin-markdown/theme/classes/MarkdownTheme.md (78%) rename {developer-docs => devguide}/typedoc-plugin-markdown/theme/classes/MarkdownThemeContext.md (84%) rename {developer-docs => devguide}/typedoc-plugin-markdown/types/README.md (96%) rename {developer-docs => devguide}/typedoc-plugin-markdown/types/interfaces/MarkdownApplication.md (53%) rename {developer-docs => devguide}/typedoc-plugin-markdown/types/interfaces/MarkdownRenderer.md (55%) rename {developer-docs => devguide}/typedoc-plugin-markdown/types/interfaces/MarkdownRendererHooks.md (65%) rename {developer-docs => devguide}/typedoc-plugin-markdown/types/interfaces/NavigationItem.md (70%) rename {developer-docs => devguide}/typedoc-plugin-markdown/types/interfaces/PackageMetaData.md (56%) rename {developer-docs => devguide}/typedoc-plugin-markdown/types/interfaces/PluginOptions.md (83%) rename {developer-docs => devguide}/typedoc-plugin-markdown/types/interfaces/TemplateMapping.md (68%) rename {developer-docs => devguide}/typedoc-plugin-markdown/types/interfaces/TranslatableStrings.md (54%) rename {developer-docs => devguide}/typedoc-plugin-markdown/types/interfaces/UrlMapping.md (78%) rename {developer-docs => devguide}/typedoc-plugin-markdown/types/interfaces/UrlOption.md (72%) rename {developer-docs => devguide}/typedoc-plugin-markdown/types/type-aliases/RenderTemplate.md (70%) rename {developer-docs => devguide}/typedoc-plugin-remark/README.md (84%) rename {developer-docs => devguide}/typedoc-plugin-remark/index/README.md (77%) rename {developer-docs => devguide}/typedoc-plugin-remark/options/README.md (81%) rename {developer-docs => devguide}/typedoc-plugin-remark/options/namespaces/declarations/README.md (88%) rename {developer-docs => devguide}/typedoc-plugin-remark/options/namespaces/helpers/README.md (73%) rename {developer-docs => devguide}/typedoc-plugin-remark/types/README.md (82%) rename {developer-docs => devguide}/typedoc-plugin-remark/types/interfaces/PluginOptions.md (69%) rename {developer-docs => devguide}/typedoc-vitepress-theme/README.md (83%) create mode 100644 devguide/typedoc-vitepress-theme/index/README.md rename {developer-docs/docusaurus-plugin-typedoc => devguide/typedoc-vitepress-theme}/options/README.md (80%) rename {developer-docs => devguide}/typedoc-vitepress-theme/options/namespaces/declarations/README.md (91%) rename {developer-docs => devguide}/typedoc-vitepress-theme/options/namespaces/presets/README.md (70%) rename {developer-docs/docusaurus-plugin-typedoc => devguide/typedoc-vitepress-theme}/types/README.md (84%) rename {developer-docs => devguide}/typedoc-vitepress-theme/types/interfaces/PluginOptions.md (68%) rename {developer-docs => devguide}/typedoc-vitepress-theme/types/interfaces/Sidebar.md (67%) rename {packages/typedoc-plugin-markdown/.docs/plugins => devtools/typedoc-plugins}/typedoc-ignore-typeparam.mjs (100%) rename {packages/typedoc-plugin-markdown/.docs/plugins => devtools/typedoc-plugins}/typedoc-nextra.mjs (100%) create mode 100644 devtools/typedoc-plugins/typedoc-symbols.mjs rename docs/pages/api-docs/{Document.Navigation.mdx => Document.Utilizing-Navigation.mdx} (97%) create mode 100644 docs/pages/api-docs/Interface.MarkdownApplication.mdx create mode 100644 docs/pages/api-docs/Interface.MarkdownRenderer.mdx create mode 100644 packages/README.md delete mode 100644 packages/typedoc-plugin-markdown/.docs/typedoc.json delete mode 100644 packages/typedoc-plugin-markdown/src/theme/base/get-navigation.ts delete mode 100644 packages/typedoc-plugin-markdown/src/theme/base/get-urls.ts create mode 100644 packages/typedoc-plugin-markdown/src/theme/base/navigation-builder.ts create mode 100644 packages/typedoc-plugin-markdown/src/theme/base/url-builder.ts rename packages/typedoc-plugin-markdown/src/theme/{markdown-theme-context.ts => markdown-themeContext.ts} (99%) rename packages/typedoc-plugin-markdown/supporting-docs/{ => internal}/getting-started.md (74%) create mode 100644 packages/typedoc-plugin-markdown/supporting-docs/internal/test-and-validation.md delete mode 100644 packages/typedoc-plugin-markdown/supporting-docs/internationalization.md rename packages/typedoc-plugin-markdown/supporting-docs/{ => public}/customizing-output.md (57%) rename packages/typedoc-plugin-markdown/supporting-docs/{ => public}/local-plugins.md (89%) rename packages/typedoc-plugin-markdown/supporting-docs/{navigation.md => public/utilizing-navigation.md} (95%) delete mode 100644 packages/typedoc-plugin-markdown/supporting-docs/testing.md create mode 100644 packages/typedoc-plugin-markdown/typedoc.public.json diff --git a/.prettierrc.json b/.prettierrc.json index 57172d89..19dad0e0 100644 --- a/.prettierrc.json +++ b/.prettierrc.json @@ -2,4 +2,4 @@ "singleQuote": true, "trailingComma": "all", "plugins": ["prettier-plugin-organize-imports"] -} \ No newline at end of file +} diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 43d2ecde..eb386cd6 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,38 +1,36 @@ # Contributing Guide -Thank you for showing interest in contributing to this project. This guide provides some basic guidelines for doing so. +> How to contribute to "typedoc-plugin-markdown" and associated packages. ## Contents -- [Contributing Guide](#contributing-guide) - - [Contents](#contents) - - [Introduction](#introduction) - - [Contributions to the public docs](#contributions-to-the-public-docs) - - [Contributing to the codebase](#contributing-to-the-codebase) - - [Submitting a Pull Request](#submitting-a-pull-request) - - [Contributors](#contributors) +- [Introduction](#introduction) +- [Contributing to the public docs](#contributing-to-the-public-docs) +- [Contributing to the codebase](#contributing-to-the-codebase) +- [Submitting a PR](#submitting-a-pr) +- [Acknowledgements](#acknowledgements) ## Introduction -Before you start, you might find it helpful to read the [TypeDoc development guide](https://typedoc.org/guides/development/) to understand the architecture of TypeDoc itself. +Thank you for showing interest in contributing to this project. This guide provides some guidelines for doing so. -## Contributions to the public docs +If something does not make sense please do not hesitate to [ask for help](/discussions/categories/help). -Contributions to the public facing documentation hosted at https://typedoc-plugin-markdown.org welcome. +## Contributing to the public docs + +Contributions to the public facing documentation hosted at https://typedoc-plugin-markdown.org is welcome. The site is built on [Nextra](https://nextra.site/docs) and you can edit the mdx files located at [docs folder](https://github.com/typedoc2md/typedoc-plugin-markdown/tree/main/docs) of the repo. Please note that the API docs (`/pages/api-docs`) are autogenerated and should not be edited from the location. -When submitting a PR please use commit message in the format `chore(docs): improved getting started docs` +When submitting a PR please use commit message in the format `chore(docs): my docs update xxx` ## Contributing to the codebase -For contributing to the plugin codebase, please see the [Developer Documentation](./developer-docs/README.md) for detailed information about the codebase and development practices. - -All contributions are welcome and appreciated. If something does not make sense please do not hesitate to [ask for help](/discussions/categories/help). +For contributing to the plugin codebase, please see the [Developer Guide](./devguide/README.md) for detailed information about the codebase and development practices. -## Submitting a Pull Request +## Submitting a PR Once you're ready to submit your changes: @@ -45,8 +43,11 @@ Please note we follow [Conventional Commits](https://www.conventionalcommits.org The commit message should be in the form: -`fix(core): resolve issue with table rendering (#100)` +`fix(core): my bug fix xxx (#100)` + +The scope should be one of `'core'`, `'frontmatter'`, `'remark'`, `'docusaurus'`, `'vitepress'`, `'githubwiki'`, `'gitlabwiki'`, `'docs'`. +Use `'core'` to contribute to the main project. -## Contributors +## Acknowledgements Thank you to all the people who have already contributed to typedoc-plugin-markdown. diff --git a/developer-docs/docusaurus-plugin-typedoc/types/interfaces/Sidebar.md b/developer-docs/docusaurus-plugin-typedoc/types/interfaces/Sidebar.md deleted file mode 100644 index 152f826e..00000000 --- a/developer-docs/docusaurus-plugin-typedoc/types/interfaces/Sidebar.md +++ /dev/null @@ -1,23 +0,0 @@ -[Packages Index](../../../README.md) / [docusaurus-plugin-typedoc](../../README.md) / [types](../README.md) / Sidebar - -# Interface: Sidebar - -## Properties - -### autoConfiguration - -> **autoConfiguration**: `boolean` - -#### Defined in - -[docusaurus-plugin-typedoc/src/types/options.ts:18](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/docusaurus-plugin-typedoc/src/types/options.ts#L18) - -*** - -### pretty - -> **pretty**: `boolean` - -#### Defined in - -[docusaurus-plugin-typedoc/src/types/options.ts:19](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/docusaurus-plugin-typedoc/src/types/options.ts#L19) diff --git a/developer-docs/typedoc-plugin-frontmatter/types/interfaces/FrontmatterGlobals.md b/developer-docs/typedoc-plugin-frontmatter/types/interfaces/FrontmatterGlobals.md deleted file mode 100644 index 36519ddc..00000000 --- a/developer-docs/typedoc-plugin-frontmatter/types/interfaces/FrontmatterGlobals.md +++ /dev/null @@ -1,3 +0,0 @@ -[Packages Index](../../../README.md) / [typedoc-plugin-frontmatter](../../README.md) / [types](../README.md) / FrontmatterGlobals - -# Interface: FrontmatterGlobals diff --git a/developer-docs/typedoc-plugin-frontmatter/types/interfaces/IndexFrontmatter.md b/developer-docs/typedoc-plugin-frontmatter/types/interfaces/IndexFrontmatter.md deleted file mode 100644 index 5511d5e0..00000000 --- a/developer-docs/typedoc-plugin-frontmatter/types/interfaces/IndexFrontmatter.md +++ /dev/null @@ -1,3 +0,0 @@ -[Packages Index](../../../README.md) / [typedoc-plugin-frontmatter](../../README.md) / [types](../README.md) / IndexFrontmatter - -# Interface: IndexFrontmatter diff --git a/developer-docs/typedoc-plugin-frontmatter/types/interfaces/ReadmeFrontmatter.md b/developer-docs/typedoc-plugin-frontmatter/types/interfaces/ReadmeFrontmatter.md deleted file mode 100644 index c2dc6d55..00000000 --- a/developer-docs/typedoc-plugin-frontmatter/types/interfaces/ReadmeFrontmatter.md +++ /dev/null @@ -1,3 +0,0 @@ -[Packages Index](../../../README.md) / [typedoc-plugin-frontmatter](../../README.md) / [types](../README.md) / ReadmeFrontmatter - -# Interface: ReadmeFrontmatter diff --git a/developer-docs/typedoc-plugin-markdown/documents/Testing.md b/developer-docs/typedoc-plugin-markdown/documents/Testing.md deleted file mode 100644 index 394726e3..00000000 --- a/developer-docs/typedoc-plugin-markdown/documents/Testing.md +++ /dev/null @@ -1,29 +0,0 @@ -[Packages Index](../../README.md) / [typedoc-plugin-markdown](../README.md) / Testing - -# Testing - -> This page is incomplete. More docs to come shortly. - -## Contents - -* [Running tests](#running-tests) -* [Test Fixtures](#test-fixtures) - -## Running tests - -```bash -npm run test -``` - -If you require to update the snapshots run the following command: - -```bash -npm run test:update -``` - -## Test Fixtures - -A series of snapshot tests are used to ensure the output of the plugin is consistent. - -* Example code for fixtures are located at `/test/fixtures/src`. -* Fixtures output scenarios are setup using a config file (`/test/fixtures/config.ts`) that provides a mechanism to easily provide a combination of options. diff --git a/developer-docs/typedoc-plugin-markdown/options/README.md b/developer-docs/typedoc-plugin-markdown/options/README.md deleted file mode 100644 index 9b5b367a..00000000 --- a/developer-docs/typedoc-plugin-markdown/options/README.md +++ /dev/null @@ -1,15 +0,0 @@ -[Packages Index](../../README.md) / [typedoc-plugin-markdown](../README.md) / options - -# options - -Contains all the option declarations and types used in the plugin. - -## Index - -### Namespaces - -| Namespace | Description | -| ------------------------------------------------- | ------------------------------------------------- | -| [constants](namespaces/constants/README.md) | Contains constant default values used in options. | -| [declarations](namespaces/declarations/README.md) | Typedoc options declarations. | -| [maps](namespaces/maps/README.md) | Maps a given value to the option type. | diff --git a/developer-docs/typedoc-plugin-markdown/theme/README.md b/developer-docs/typedoc-plugin-markdown/theme/README.md deleted file mode 100644 index 89155d52..00000000 --- a/developer-docs/typedoc-plugin-markdown/theme/README.md +++ /dev/null @@ -1,14 +0,0 @@ -[Packages Index](../../README.md) / [typedoc-plugin-markdown](../README.md) / theme - -# theme - -Contains all functionality relevant to the theme. - -## Index - -### Classes - -| Class | Description | -| ------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [MarkdownThemeContext](classes/MarkdownThemeContext.md) | The theme context class that is provided as context on the rendering of every page. It is heavily influenced by the equivalent [DefaultThemeRenderContext](https://typedoc.org/api/classes/DefaultThemeRenderContext.html) from the default theme. | -| [MarkdownTheme](classes/MarkdownTheme.md) | The main theme class for the plugin. The class controls how TypeDoc models are mapped to files and templates and extends TypeDoc's base Theme class. | diff --git a/developer-docs/typedoc-vitepress-theme/index/README.md b/developer-docs/typedoc-vitepress-theme/index/README.md deleted file mode 100644 index 8b17243c..00000000 --- a/developer-docs/typedoc-vitepress-theme/index/README.md +++ /dev/null @@ -1,23 +0,0 @@ -[Packages Index](../../README.md) / [typedoc-vitepress-theme](../README.md) / index - -# index - -The plugin entrypoint and bootstrapping of the plugin. - -## load() - -> **load**(`app`): `void` - -### Parameters - -| Parameter | Type | -| --------- | ----------------------------------------------------------------- | -| `app` | [`Application`](https://typedoc.org/api/classes/Application.html) | - -### Returns - -`void` - -### Defined in - -[index.ts:23](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-vitepress-theme/src/index.ts#L23) diff --git a/developer-docs/README.md b/devguide/README.md similarity index 50% rename from developer-docs/README.md rename to devguide/README.md index 3dd57da3..21b3011b 100644 --- a/developer-docs/README.md +++ b/devguide/README.md @@ -1,4 +1,59 @@ -# Developer Documentation +# Developer Guide + +## Contents + +* [Monorepo Overview](#monorepo-overview) +* [Machine Setup](#machine-setup) +* [Packages](#packages) + +## Monorepo Overview + +This is a simple monorepo managed by [npm workspaces](https://docs.npmjs.com/cli/v7/using-npm/workspaces). + +Please view individual packages for further insights: + +* [ typedoc-plugin-markdown](typedoc-plugin-markdown/README.md) is the core package and is the package that is used to generate the markdown documentation. +* [ typedoc-plugin-frontmatter](typedoc-plugin-frontmatter/README.md) and [ typedoc-plugin-remark](typedoc-plugin-remark/README.md) provide metadata or adjust the output. +* [ typedoc-github-wiki-theme](typedoc-github-wiki-theme/README.md), [ typedoc-gitlab-wiki-theme](typedoc-gitlab-wiki-theme/README.md), + [ typedoc-vitepress-theme](typedoc-vitepress-theme/README.md) and [ docusaurus-plugin-typedoc](docusaurus-plugin-typedoc/README.md) target specific implementations. + +## Machine Setup + +**1. Fork and clone the repository** + +Start by forking the repository to your own GitHub account. Then, clone the repository to your local machine. Please replace `` with your actual GitHub username. + +```bash +git clone git@github.com:/typedoc-plugin-markdown.git +``` + +**2. Install dependencies** + +Navigate to the repository root and install the necessary dependencies: + +```bash +cd typedoc-plugin-markdown + +npm install +``` + +**3. Build the packages and run tests** + +Finally, you can build all the packages and run the tests to ensure everything is set up correctly. + +Build all packages in the workspace: + +```bash +npm run build +``` + +Test all packages in the workspace: + +```bash +npm run test +``` + +If the project builds and the tests run successfully you are ready to start contributing to the project. ## Packages diff --git a/developer-docs/docusaurus-plugin-typedoc/README.md b/devguide/docusaurus-plugin-typedoc/README.md similarity index 83% rename from developer-docs/docusaurus-plugin-typedoc/README.md rename to devguide/docusaurus-plugin-typedoc/README.md index 538fbc39..c985bb85 100644 --- a/developer-docs/docusaurus-plugin-typedoc/README.md +++ b/devguide/docusaurus-plugin-typedoc/README.md @@ -1,4 +1,4 @@ -[Packages Index](../README.md) / docusaurus-plugin-typedoc +[Home](../README.md) / docusaurus-plugin-typedoc # typedoc-vitepress-theme @@ -6,10 +6,10 @@ ## Contents -* [What does the package do?](#what-does-the-package-do) +* [What Does the Package Do?](#what-does-the-package-do) * [Modules](#modules) -## What does the package do? +## What Does the Package Do? * Exposes some additional options to TypeDoc. * Presets relevant typedoc-plugin-markdown options. diff --git a/developer-docs/docusaurus-plugin-typedoc/index/README.md b/devguide/docusaurus-plugin-typedoc/index/README.md similarity index 83% rename from developer-docs/docusaurus-plugin-typedoc/index/README.md rename to devguide/docusaurus-plugin-typedoc/index/README.md index 1c5616b3..4c7a0f64 100644 --- a/developer-docs/docusaurus-plugin-typedoc/index/README.md +++ b/devguide/docusaurus-plugin-typedoc/index/README.md @@ -1,4 +1,4 @@ -[Packages Index](../../README.md) / [docusaurus-plugin-typedoc](../README.md) / index +[Home](../../README.md) / [docusaurus-plugin-typedoc](../README.md) / index # index @@ -38,4 +38,4 @@ ### Defined in -[docusaurus-plugin-typedoc/src/plugin.ts:13](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/docusaurus-plugin-typedoc/src/plugin.ts#L13) +[docusaurus-plugin-typedoc/src/plugin.ts:13](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/docusaurus-plugin-typedoc/src/plugin.ts#L13) diff --git a/developer-docs/docusaurus-plugin-typedoc/index/interfaces/PluginOptions.md b/devguide/docusaurus-plugin-typedoc/index/interfaces/PluginOptions.md similarity index 97% rename from developer-docs/docusaurus-plugin-typedoc/index/interfaces/PluginOptions.md rename to devguide/docusaurus-plugin-typedoc/index/interfaces/PluginOptions.md index ff22fc2c..60b5c4d9 100644 --- a/developer-docs/docusaurus-plugin-typedoc/index/interfaces/PluginOptions.md +++ b/devguide/docusaurus-plugin-typedoc/index/interfaces/PluginOptions.md @@ -1,4 +1,4 @@ -[Packages Index](../../../README.md) / [docusaurus-plugin-typedoc](../../README.md) / [index](../README.md) / PluginOptions +[Home](../../../README.md) / [docusaurus-plugin-typedoc](../../README.md) / [index](../README.md) / PluginOptions # Interface: PluginOptions @@ -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/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/docusaurus-plugin-typedoc/src/models.ts#L7) +[docusaurus-plugin-typedoc/src/models.ts:7](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/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/352ce41370cee18034e72b7c2f3874bbfe56f96f/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/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/docusaurus-plugin-typedoc/src/types/options.ts#L11) *** diff --git a/developer-docs/typedoc-vitepress-theme/options/README.md b/devguide/docusaurus-plugin-typedoc/options/README.md similarity index 80% rename from developer-docs/typedoc-vitepress-theme/options/README.md rename to devguide/docusaurus-plugin-typedoc/options/README.md index 438f7768..0f02e448 100644 --- a/developer-docs/typedoc-vitepress-theme/options/README.md +++ b/devguide/docusaurus-plugin-typedoc/options/README.md @@ -1,4 +1,4 @@ -[Packages Index](../../README.md) / [typedoc-vitepress-theme](../README.md) / options +[Home](../../README.md) / [docusaurus-plugin-typedoc](../README.md) / options # options diff --git a/developer-docs/docusaurus-plugin-typedoc/options/namespaces/declarations/README.md b/devguide/docusaurus-plugin-typedoc/options/namespaces/declarations/README.md similarity index 82% rename from developer-docs/docusaurus-plugin-typedoc/options/namespaces/declarations/README.md rename to devguide/docusaurus-plugin-typedoc/options/namespaces/declarations/README.md index e50b3635..694809a6 100644 --- a/developer-docs/docusaurus-plugin-typedoc/options/namespaces/declarations/README.md +++ b/devguide/docusaurus-plugin-typedoc/options/namespaces/declarations/README.md @@ -1,4 +1,4 @@ -[Packages Index](../../../../README.md) / [docusaurus-plugin-typedoc](../../../README.md) / [options](../../README.md) / declarations +[Home](../../../../README.md) / [docusaurus-plugin-typedoc](../../../README.md) / [options](../../README.md) / declarations # declarations @@ -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/352ce41370cee18034e72b7c2f3874bbfe56f96f/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/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/docusaurus-plugin-typedoc/src/options/declarations.ts#L16) diff --git a/developer-docs/docusaurus-plugin-typedoc/options/namespaces/presets/README.md b/devguide/docusaurus-plugin-typedoc/options/namespaces/presets/README.md similarity index 71% rename from developer-docs/docusaurus-plugin-typedoc/options/namespaces/presets/README.md rename to devguide/docusaurus-plugin-typedoc/options/namespaces/presets/README.md index 268669a8..9f1bc84f 100644 --- a/developer-docs/docusaurus-plugin-typedoc/options/namespaces/presets/README.md +++ b/devguide/docusaurus-plugin-typedoc/options/namespaces/presets/README.md @@ -1,4 +1,4 @@ -[Packages Index](../../../../README.md) / [docusaurus-plugin-typedoc](../../../README.md) / [options](../../README.md) / presets +[Home](../../../../README.md) / [docusaurus-plugin-typedoc](../../../README.md) / [options](../../README.md) / presets # presets @@ -18,4 +18,4 @@ ### Defined in -[docusaurus-plugin-typedoc/src/options/presets.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/352ce41370cee18034e72b7c2f3874bbfe56f96f/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/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/docusaurus-plugin-typedoc/src/options/presets.ts#L1) diff --git a/developer-docs/typedoc-vitepress-theme/types/README.md b/devguide/docusaurus-plugin-typedoc/types/README.md similarity index 84% rename from developer-docs/typedoc-vitepress-theme/types/README.md rename to devguide/docusaurus-plugin-typedoc/types/README.md index 52e1193e..3547b5c3 100644 --- a/developer-docs/typedoc-vitepress-theme/types/README.md +++ b/devguide/docusaurus-plugin-typedoc/types/README.md @@ -1,4 +1,4 @@ -[Packages Index](../../README.md) / [typedoc-vitepress-theme](../README.md) / types +[Home](../../README.md) / [docusaurus-plugin-typedoc](../README.md) / types # types diff --git a/developer-docs/docusaurus-plugin-typedoc/types/interfaces/PluginOptions.md b/devguide/docusaurus-plugin-typedoc/types/interfaces/PluginOptions.md similarity index 65% rename from developer-docs/docusaurus-plugin-typedoc/types/interfaces/PluginOptions.md rename to devguide/docusaurus-plugin-typedoc/types/interfaces/PluginOptions.md index eb5d0a58..f32209ee 100644 --- a/developer-docs/docusaurus-plugin-typedoc/types/interfaces/PluginOptions.md +++ b/devguide/docusaurus-plugin-typedoc/types/interfaces/PluginOptions.md @@ -1,4 +1,4 @@ -[Packages Index](../../../README.md) / [docusaurus-plugin-typedoc](../../README.md) / [types](../README.md) / PluginOptions +[Home](../../../README.md) / [docusaurus-plugin-typedoc](../../README.md) / [types](../README.md) / PluginOptions # Interface: PluginOptions @@ -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/352ce41370cee18034e72b7c2f3874bbfe56f96f/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/7934b23566f374f44fe6de5fd9240ab185bf799f/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 new file mode 100644 index 00000000..1a66ea6c --- /dev/null +++ b/devguide/docusaurus-plugin-typedoc/types/interfaces/Sidebar.md @@ -0,0 +1,23 @@ +[Home](../../../README.md) / [docusaurus-plugin-typedoc](../../README.md) / [types](../README.md) / Sidebar + +# Interface: Sidebar + +## Properties + +### autoConfiguration + +> **autoConfiguration**: `boolean` + +#### 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) + +*** + +### pretty + +> **pretty**: `boolean` + +#### 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) diff --git a/developer-docs/typedoc-github-wiki-theme/README.md b/devguide/typedoc-github-wiki-theme/README.md similarity index 83% rename from developer-docs/typedoc-github-wiki-theme/README.md rename to devguide/typedoc-github-wiki-theme/README.md index 79c2a4fa..3a4bfcac 100644 --- a/developer-docs/typedoc-github-wiki-theme/README.md +++ b/devguide/typedoc-github-wiki-theme/README.md @@ -1,4 +1,4 @@ -[Packages Index](../README.md) / typedoc-github-wiki-theme +[Home](../README.md) / typedoc-github-wiki-theme # typedoc-github-wiki-theme @@ -6,10 +6,10 @@ ## Contents -* [What does the package do?](#what-does-the-package-do) +* [What Does the Package Do?](#what-does-the-package-do) * [Modules](#modules) -## What does the package do? +## What Does the Package Do? * Exposes some additional options to TypeDoc. * Presets relevant typedoc-plugin-markdown options. diff --git a/developer-docs/typedoc-github-wiki-theme/index/README.md b/devguide/typedoc-github-wiki-theme/index/README.md similarity index 80% rename from developer-docs/typedoc-github-wiki-theme/index/README.md rename to devguide/typedoc-github-wiki-theme/index/README.md index ff10b461..5f351b09 100644 --- a/developer-docs/typedoc-github-wiki-theme/index/README.md +++ b/devguide/typedoc-github-wiki-theme/index/README.md @@ -1,4 +1,4 @@ -[Packages Index](../../README.md) / [typedoc-github-wiki-theme](../README.md) / index +[Home](../../README.md) / [typedoc-github-wiki-theme](../README.md) / index # index @@ -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/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-github-wiki-theme/src/index.ts#L23) +[index.ts:23](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/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/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-github-wiki-theme/src/index.ts#L78) +[index.ts:78](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-github-wiki-theme/src/index.ts#L78) diff --git a/developer-docs/typedoc-gitlab-wiki-theme/options/README.md b/devguide/typedoc-github-wiki-theme/options/README.md similarity index 80% rename from developer-docs/typedoc-gitlab-wiki-theme/options/README.md rename to devguide/typedoc-github-wiki-theme/options/README.md index d18e1a75..69db7e07 100644 --- a/developer-docs/typedoc-gitlab-wiki-theme/options/README.md +++ b/devguide/typedoc-github-wiki-theme/options/README.md @@ -1,4 +1,4 @@ -[Packages Index](../../README.md) / [typedoc-gitlab-wiki-theme](../README.md) / options +[Home](../../README.md) / [typedoc-github-wiki-theme](../README.md) / options # options diff --git a/developer-docs/typedoc-github-wiki-theme/options/namespaces/declarations/README.md b/devguide/typedoc-github-wiki-theme/options/namespaces/declarations/README.md similarity index 81% rename from developer-docs/typedoc-github-wiki-theme/options/namespaces/declarations/README.md rename to devguide/typedoc-github-wiki-theme/options/namespaces/declarations/README.md index 016aa795..642c6c03 100644 --- a/developer-docs/typedoc-github-wiki-theme/options/namespaces/declarations/README.md +++ b/devguide/typedoc-github-wiki-theme/options/namespaces/declarations/README.md @@ -1,4 +1,4 @@ -[Packages Index](../../../../README.md) / [typedoc-github-wiki-theme](../../../README.md) / [options](../../README.md) / declarations +[Home](../../../../README.md) / [typedoc-github-wiki-theme](../../../README.md) / [options](../../README.md) / declarations # declarations @@ -24,4 +24,4 @@ The heading displayed above the sidebar. ### Defined in -[options/declarations.ts:14](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-github-wiki-theme/src/options/declarations.ts#L14) +[options/declarations.ts:14](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-github-wiki-theme/src/options/declarations.ts#L14) diff --git a/developer-docs/typedoc-github-wiki-theme/options/namespaces/presets/README.md b/devguide/typedoc-github-wiki-theme/options/namespaces/presets/README.md similarity index 71% rename from developer-docs/typedoc-github-wiki-theme/options/namespaces/presets/README.md rename to devguide/typedoc-github-wiki-theme/options/namespaces/presets/README.md index c27dbf65..b717e0d7 100644 --- a/developer-docs/typedoc-github-wiki-theme/options/namespaces/presets/README.md +++ b/devguide/typedoc-github-wiki-theme/options/namespaces/presets/README.md @@ -1,4 +1,4 @@ -[Packages Index](../../../../README.md) / [typedoc-github-wiki-theme](../../../README.md) / [options](../../README.md) / presets +[Home](../../../../README.md) / [typedoc-github-wiki-theme](../../../README.md) / [options](../../README.md) / presets # presets @@ -16,4 +16,4 @@ ### Defined in -[options/presets.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-github-wiki-theme/src/options/presets.ts#L1) +[options/presets.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-github-wiki-theme/src/options/presets.ts#L1) diff --git a/developer-docs/typedoc-gitlab-wiki-theme/types/README.md b/devguide/typedoc-github-wiki-theme/types/README.md similarity index 84% rename from developer-docs/typedoc-gitlab-wiki-theme/types/README.md rename to devguide/typedoc-github-wiki-theme/types/README.md index 7a3f1bd7..55fa05b2 100644 --- a/developer-docs/typedoc-gitlab-wiki-theme/types/README.md +++ b/devguide/typedoc-github-wiki-theme/types/README.md @@ -1,4 +1,4 @@ -[Packages Index](../../README.md) / [typedoc-gitlab-wiki-theme](../README.md) / types +[Home](../../README.md) / [typedoc-github-wiki-theme](../README.md) / types # types diff --git a/developer-docs/typedoc-github-wiki-theme/types/interfaces/PluginOptions.md b/devguide/typedoc-github-wiki-theme/types/interfaces/PluginOptions.md similarity index 63% rename from developer-docs/typedoc-github-wiki-theme/types/interfaces/PluginOptions.md rename to devguide/typedoc-github-wiki-theme/types/interfaces/PluginOptions.md index 2364e3a0..a01a8867 100644 --- a/developer-docs/typedoc-github-wiki-theme/types/interfaces/PluginOptions.md +++ b/devguide/typedoc-github-wiki-theme/types/interfaces/PluginOptions.md @@ -1,4 +1,4 @@ -[Packages Index](../../../README.md) / [typedoc-github-wiki-theme](../../README.md) / [types](../README.md) / PluginOptions +[Home](../../../README.md) / [typedoc-github-wiki-theme](../../README.md) / [types](../README.md) / PluginOptions # Interface: PluginOptions @@ -14,4 +14,4 @@ Configures the autogenerated `_sidebar.md file`. #### Defined in -[types/options.ts:11](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-github-wiki-theme/src/types/options.ts#L11) +[types/options.ts:11](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-github-wiki-theme/src/types/options.ts#L11) diff --git a/developer-docs/typedoc-github-wiki-theme/types/interfaces/Sidebar.md b/devguide/typedoc-github-wiki-theme/types/interfaces/Sidebar.md similarity index 62% rename from developer-docs/typedoc-github-wiki-theme/types/interfaces/Sidebar.md rename to devguide/typedoc-github-wiki-theme/types/interfaces/Sidebar.md index 2477cb1b..1293afdf 100644 --- a/developer-docs/typedoc-github-wiki-theme/types/interfaces/Sidebar.md +++ b/devguide/typedoc-github-wiki-theme/types/interfaces/Sidebar.md @@ -1,4 +1,4 @@ -[Packages Index](../../../README.md) / [typedoc-github-wiki-theme](../../README.md) / [types](../README.md) / Sidebar +[Home](../../../README.md) / [typedoc-github-wiki-theme](../../README.md) / [types](../README.md) / Sidebar # Interface: Sidebar @@ -10,7 +10,7 @@ #### Defined in -[types/options.ts:18](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-github-wiki-theme/src/types/options.ts#L18) +[types/options.ts:18](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/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/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-github-wiki-theme/src/types/options.ts#L19) +[types/options.ts:19](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-github-wiki-theme/src/types/options.ts#L19) diff --git a/developer-docs/typedoc-gitlab-wiki-theme/README.md b/devguide/typedoc-gitlab-wiki-theme/README.md similarity index 83% rename from developer-docs/typedoc-gitlab-wiki-theme/README.md rename to devguide/typedoc-gitlab-wiki-theme/README.md index 9f24fad0..0af50cce 100644 --- a/developer-docs/typedoc-gitlab-wiki-theme/README.md +++ b/devguide/typedoc-gitlab-wiki-theme/README.md @@ -1,4 +1,4 @@ -[Packages Index](../README.md) / typedoc-gitlab-wiki-theme +[Home](../README.md) / typedoc-gitlab-wiki-theme # typedoc-gitlab-wiki-theme @@ -6,10 +6,10 @@ ## Contents -* [What does the package do?](#what-does-the-package-do) +* [What Does the Package Do?](#what-does-the-package-do) * [Modules](#modules) -## What does the package do? +## What Does the Package Do? * Exposes some additional options to TypeDoc. * Presets relevant typedoc-plugin-markdown options. diff --git a/developer-docs/typedoc-gitlab-wiki-theme/index/README.md b/devguide/typedoc-gitlab-wiki-theme/index/README.md similarity index 77% rename from developer-docs/typedoc-gitlab-wiki-theme/index/README.md rename to devguide/typedoc-gitlab-wiki-theme/index/README.md index 9f9e901b..84367910 100644 --- a/developer-docs/typedoc-gitlab-wiki-theme/index/README.md +++ b/devguide/typedoc-gitlab-wiki-theme/index/README.md @@ -1,4 +1,4 @@ -[Packages Index](../../README.md) / [typedoc-gitlab-wiki-theme](../README.md) / index +[Home](../../README.md) / [typedoc-gitlab-wiki-theme](../README.md) / index # index @@ -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/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-gitlab-wiki-theme/src/index.ts#L23) +[index.ts:23](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-gitlab-wiki-theme/src/index.ts#L23) diff --git a/developer-docs/typedoc-github-wiki-theme/options/README.md b/devguide/typedoc-gitlab-wiki-theme/options/README.md similarity index 80% rename from developer-docs/typedoc-github-wiki-theme/options/README.md rename to devguide/typedoc-gitlab-wiki-theme/options/README.md index 491a6c2e..82c4e373 100644 --- a/developer-docs/typedoc-github-wiki-theme/options/README.md +++ b/devguide/typedoc-gitlab-wiki-theme/options/README.md @@ -1,4 +1,4 @@ -[Packages Index](../../README.md) / [typedoc-github-wiki-theme](../README.md) / options +[Home](../../README.md) / [typedoc-gitlab-wiki-theme](../README.md) / options # options diff --git a/developer-docs/typedoc-gitlab-wiki-theme/options/namespaces/declarations/README.md b/devguide/typedoc-gitlab-wiki-theme/options/namespaces/declarations/README.md similarity index 81% rename from developer-docs/typedoc-gitlab-wiki-theme/options/namespaces/declarations/README.md rename to devguide/typedoc-gitlab-wiki-theme/options/namespaces/declarations/README.md index 016b9945..3a522f2e 100644 --- a/developer-docs/typedoc-gitlab-wiki-theme/options/namespaces/declarations/README.md +++ b/devguide/typedoc-gitlab-wiki-theme/options/namespaces/declarations/README.md @@ -1,4 +1,4 @@ -[Packages Index](../../../../README.md) / [typedoc-gitlab-wiki-theme](../../../README.md) / [options](../../README.md) / declarations +[Home](../../../../README.md) / [typedoc-gitlab-wiki-theme](../../../README.md) / [options](../../README.md) / declarations # declarations @@ -24,4 +24,4 @@ The heading displayed above the sidebar. ### Defined in -[options/declarations.ts:14](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-gitlab-wiki-theme/src/options/declarations.ts#L14) +[options/declarations.ts:14](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-gitlab-wiki-theme/src/options/declarations.ts#L14) diff --git a/developer-docs/typedoc-gitlab-wiki-theme/options/namespaces/presets/README.md b/devguide/typedoc-gitlab-wiki-theme/options/namespaces/presets/README.md similarity index 68% rename from developer-docs/typedoc-gitlab-wiki-theme/options/namespaces/presets/README.md rename to devguide/typedoc-gitlab-wiki-theme/options/namespaces/presets/README.md index 725d5281..cf99a4cf 100644 --- a/developer-docs/typedoc-gitlab-wiki-theme/options/namespaces/presets/README.md +++ b/devguide/typedoc-gitlab-wiki-theme/options/namespaces/presets/README.md @@ -1,4 +1,4 @@ -[Packages Index](../../../../README.md) / [typedoc-gitlab-wiki-theme](../../../README.md) / [options](../../README.md) / presets +[Home](../../../../README.md) / [typedoc-gitlab-wiki-theme](../../../README.md) / [options](../../README.md) / presets # presets @@ -15,4 +15,4 @@ ### Defined in -[options/presets.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-gitlab-wiki-theme/src/options/presets.ts#L1) +[options/presets.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-gitlab-wiki-theme/src/options/presets.ts#L1) diff --git a/developer-docs/typedoc-github-wiki-theme/types/README.md b/devguide/typedoc-gitlab-wiki-theme/types/README.md similarity index 84% rename from developer-docs/typedoc-github-wiki-theme/types/README.md rename to devguide/typedoc-gitlab-wiki-theme/types/README.md index b67de6d1..1627cd78 100644 --- a/developer-docs/typedoc-github-wiki-theme/types/README.md +++ b/devguide/typedoc-gitlab-wiki-theme/types/README.md @@ -1,4 +1,4 @@ -[Packages Index](../../README.md) / [typedoc-github-wiki-theme](../README.md) / types +[Home](../../README.md) / [typedoc-gitlab-wiki-theme](../README.md) / types # types diff --git a/developer-docs/typedoc-gitlab-wiki-theme/types/interfaces/PluginOptions.md b/devguide/typedoc-gitlab-wiki-theme/types/interfaces/PluginOptions.md similarity index 63% rename from developer-docs/typedoc-gitlab-wiki-theme/types/interfaces/PluginOptions.md rename to devguide/typedoc-gitlab-wiki-theme/types/interfaces/PluginOptions.md index 3bf20d94..9cad8305 100644 --- a/developer-docs/typedoc-gitlab-wiki-theme/types/interfaces/PluginOptions.md +++ b/devguide/typedoc-gitlab-wiki-theme/types/interfaces/PluginOptions.md @@ -1,4 +1,4 @@ -[Packages Index](../../../README.md) / [typedoc-gitlab-wiki-theme](../../README.md) / [types](../README.md) / PluginOptions +[Home](../../../README.md) / [typedoc-gitlab-wiki-theme](../../README.md) / [types](../README.md) / PluginOptions # Interface: PluginOptions @@ -14,4 +14,4 @@ Configures the autogenerated `_Sidebar.md file`. #### Defined in -[types/options.ts:11](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-gitlab-wiki-theme/src/types/options.ts#L11) +[types/options.ts:11](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-gitlab-wiki-theme/src/types/options.ts#L11) diff --git a/developer-docs/typedoc-gitlab-wiki-theme/types/interfaces/Sidebar.md b/devguide/typedoc-gitlab-wiki-theme/types/interfaces/Sidebar.md similarity index 62% rename from developer-docs/typedoc-gitlab-wiki-theme/types/interfaces/Sidebar.md rename to devguide/typedoc-gitlab-wiki-theme/types/interfaces/Sidebar.md index 6193c77e..34aa9eeb 100644 --- a/developer-docs/typedoc-gitlab-wiki-theme/types/interfaces/Sidebar.md +++ b/devguide/typedoc-gitlab-wiki-theme/types/interfaces/Sidebar.md @@ -1,4 +1,4 @@ -[Packages Index](../../../README.md) / [typedoc-gitlab-wiki-theme](../../README.md) / [types](../README.md) / Sidebar +[Home](../../../README.md) / [typedoc-gitlab-wiki-theme](../../README.md) / [types](../README.md) / Sidebar # Interface: Sidebar @@ -10,7 +10,7 @@ #### Defined in -[types/options.ts:18](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-gitlab-wiki-theme/src/types/options.ts#L18) +[types/options.ts:18](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/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/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-gitlab-wiki-theme/src/types/options.ts#L19) +[types/options.ts:19](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-gitlab-wiki-theme/src/types/options.ts#L19) diff --git a/developer-docs/typedoc-plugin-frontmatter/README.md b/devguide/typedoc-plugin-frontmatter/README.md similarity index 85% rename from developer-docs/typedoc-plugin-frontmatter/README.md rename to devguide/typedoc-plugin-frontmatter/README.md index 45dd0e21..029c2bec 100644 --- a/developer-docs/typedoc-plugin-frontmatter/README.md +++ b/devguide/typedoc-plugin-frontmatter/README.md @@ -1,4 +1,4 @@ -[Packages Index](../README.md) / typedoc-plugin-frontmatter +[Home](../README.md) / typedoc-plugin-frontmatter # typedoc-plugin-frontmatter @@ -6,10 +6,10 @@ ## Contents -* [What does the package do?](#what-does-the-package-do) +* [What Does the Package Do?](#what-does-the-package-do) * [Modules](#modules) -## What does the package do? +## What Does the Package Do? * Exposes some additional options to TypeDoc. * Prepends a YAML block to pages. diff --git a/developer-docs/typedoc-plugin-frontmatter/index/README.md b/devguide/typedoc-plugin-frontmatter/index/README.md similarity index 77% rename from developer-docs/typedoc-plugin-frontmatter/index/README.md rename to devguide/typedoc-plugin-frontmatter/index/README.md index 91e35843..5cfebc16 100644 --- a/developer-docs/typedoc-plugin-frontmatter/index/README.md +++ b/devguide/typedoc-plugin-frontmatter/index/README.md @@ -1,4 +1,4 @@ -[Packages Index](../../README.md) / [typedoc-plugin-frontmatter](../README.md) / index +[Home](../../README.md) / [typedoc-plugin-frontmatter](../README.md) / index # index @@ -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/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-frontmatter/src/index.ts#L18) +[index.ts:18](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-frontmatter/src/index.ts#L18) diff --git a/developer-docs/typedoc-plugin-frontmatter/options/README.md b/devguide/typedoc-plugin-frontmatter/options/README.md similarity index 80% rename from developer-docs/typedoc-plugin-frontmatter/options/README.md rename to devguide/typedoc-plugin-frontmatter/options/README.md index eb1f5a95..580ed125 100644 --- a/developer-docs/typedoc-plugin-frontmatter/options/README.md +++ b/devguide/typedoc-plugin-frontmatter/options/README.md @@ -1,4 +1,4 @@ -[Packages Index](../../README.md) / [typedoc-plugin-frontmatter](../README.md) / options +[Home](../../README.md) / [typedoc-plugin-frontmatter](../README.md) / options # options diff --git a/developer-docs/typedoc-plugin-frontmatter/options/namespaces/declarations/README.md b/devguide/typedoc-plugin-frontmatter/options/namespaces/declarations/README.md similarity index 89% rename from developer-docs/typedoc-plugin-frontmatter/options/namespaces/declarations/README.md rename to devguide/typedoc-plugin-frontmatter/options/namespaces/declarations/README.md index ca91e45d..59a751db 100644 --- a/developer-docs/typedoc-plugin-frontmatter/options/namespaces/declarations/README.md +++ b/devguide/typedoc-plugin-frontmatter/options/namespaces/declarations/README.md @@ -1,4 +1,4 @@ -[Packages Index](../../../../README.md) / [typedoc-plugin-frontmatter](../../../README.md) / [options](../../README.md) / declarations +[Home](../../../../README.md) / [typedoc-plugin-frontmatter](../../../README.md) / [options](../../README.md) / declarations # declarations @@ -40,7 +40,7 @@ sidebar: true ### Defined in -[options/declarations.ts:15](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-frontmatter/src/options/declarations.ts#L15) +[options/declarations.ts:15](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/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/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-frontmatter/src/options/declarations.ts#L24) +[options/declarations.ts:24](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/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/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-frontmatter/src/options/declarations.ts#L33) +[options/declarations.ts:33](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/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/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-frontmatter/src/options/declarations.ts#L61) +[options/declarations.ts:61](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/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/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-frontmatter/src/options/declarations.ts#L66) +[options/declarations.ts:66](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/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/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-frontmatter/src/options/declarations.ts#L77) +[options/declarations.ts:77](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-frontmatter/src/options/declarations.ts#L77) diff --git a/developer-docs/typedoc-plugin-frontmatter/options/namespaces/maps/README.md b/devguide/typedoc-plugin-frontmatter/options/namespaces/maps/README.md similarity index 71% rename from developer-docs/typedoc-plugin-frontmatter/options/namespaces/maps/README.md rename to devguide/typedoc-plugin-frontmatter/options/namespaces/maps/README.md index e689817f..4d13851c 100644 --- a/developer-docs/typedoc-plugin-frontmatter/options/namespaces/maps/README.md +++ b/devguide/typedoc-plugin-frontmatter/options/namespaces/maps/README.md @@ -1,4 +1,4 @@ -[Packages Index](../../../../README.md) / [typedoc-plugin-frontmatter](../../../README.md) / [options](../../README.md) / maps +[Home](../../../../README.md) / [typedoc-plugin-frontmatter](../../../README.md) / [options](../../README.md) / maps # maps diff --git a/developer-docs/typedoc-plugin-frontmatter/options/namespaces/maps/enumerations/FrontmatterNamingConvention.md b/devguide/typedoc-plugin-frontmatter/options/namespaces/maps/enumerations/FrontmatterNamingConvention.md similarity index 55% rename from developer-docs/typedoc-plugin-frontmatter/options/namespaces/maps/enumerations/FrontmatterNamingConvention.md rename to devguide/typedoc-plugin-frontmatter/options/namespaces/maps/enumerations/FrontmatterNamingConvention.md index ede251aa..10774fe9 100644 --- a/developer-docs/typedoc-plugin-frontmatter/options/namespaces/maps/enumerations/FrontmatterNamingConvention.md +++ b/devguide/typedoc-plugin-frontmatter/options/namespaces/maps/enumerations/FrontmatterNamingConvention.md @@ -1,4 +1,4 @@ -[Packages Index](../../../../../README.md) / [typedoc-plugin-frontmatter](../../../../README.md) / [options](../../../README.md) / [maps](../README.md) / FrontmatterNamingConvention +[Home](../../../../../README.md) / [typedoc-plugin-frontmatter](../../../../README.md) / [options](../../../README.md) / [maps](../README.md) / FrontmatterNamingConvention # Enumeration: FrontmatterNamingConvention diff --git a/developer-docs/typedoc-plugin-frontmatter/tags/README.md b/devguide/typedoc-plugin-frontmatter/tags/README.md similarity index 76% rename from developer-docs/typedoc-plugin-frontmatter/tags/README.md rename to devguide/typedoc-plugin-frontmatter/tags/README.md index 23147495..cb42fcec 100644 --- a/developer-docs/typedoc-plugin-frontmatter/tags/README.md +++ b/devguide/typedoc-plugin-frontmatter/tags/README.md @@ -1,4 +1,4 @@ -[Packages Index](../../README.md) / [typedoc-plugin-frontmatter](../README.md) / tags +[Home](../../README.md) / [typedoc-plugin-frontmatter](../README.md) / tags # tags @@ -18,7 +18,7 @@ Functionality to map options to tags. | Parameter | Type | | ---------- | ----------------------------------------------------------------- | | `app` | [`Application`](https://typedoc.org/api/classes/Application.html) | -| `comment`? | [`Comment`](https://typedoc.org/api/types/Models.Comment.html) | +| `comment`? | [`Comment`](https://typedoc.org/api/classes/Models.Comment.html) | ### Returns @@ -26,7 +26,7 @@ Functionality to map options to tags. ### Defined in -[tags.ts:9](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-frontmatter/src/tags.ts#L9) +[tags.ts:9](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-frontmatter/src/tags.ts#L9) *** @@ -38,7 +38,7 @@ Functionality to map options to tags. | Parameter | Type | | ------------------ | ------------------------------------------------------------------------------------------------------- | -| `comment` | [`Comment`](https://typedoc.org/api/types/Models.Comment.html) | +| `comment` | [`Comment`](https://typedoc.org/api/classes/Models.Comment.html) | | `frontmatterTags` | `string`\[] | | `namingConvention` | [`FrontmatterNamingConvention`](../options/namespaces/maps/enumerations/FrontmatterNamingConvention.md) | @@ -48,4 +48,4 @@ Functionality to map options to tags. ### Defined in -[tags.ts:33](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-frontmatter/src/tags.ts#L33) +[tags.ts:33](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-frontmatter/src/tags.ts#L33) diff --git a/developer-docs/typedoc-plugin-frontmatter/types/README.md b/devguide/typedoc-plugin-frontmatter/types/README.md similarity index 89% rename from developer-docs/typedoc-plugin-frontmatter/types/README.md rename to devguide/typedoc-plugin-frontmatter/types/README.md index 932ad96d..b8898ea9 100644 --- a/developer-docs/typedoc-plugin-frontmatter/types/README.md +++ b/devguide/typedoc-plugin-frontmatter/types/README.md @@ -1,4 +1,4 @@ -[Packages Index](../../README.md) / [typedoc-plugin-frontmatter](../README.md) / types +[Home](../../README.md) / [typedoc-plugin-frontmatter](../README.md) / types # types diff --git a/devguide/typedoc-plugin-frontmatter/types/interfaces/FrontmatterGlobals.md b/devguide/typedoc-plugin-frontmatter/types/interfaces/FrontmatterGlobals.md new file mode 100644 index 00000000..7884f317 --- /dev/null +++ b/devguide/typedoc-plugin-frontmatter/types/interfaces/FrontmatterGlobals.md @@ -0,0 +1,3 @@ +[Home](../../../README.md) / [typedoc-plugin-frontmatter](../../README.md) / [types](../README.md) / FrontmatterGlobals + +# Interface: FrontmatterGlobals diff --git a/devguide/typedoc-plugin-frontmatter/types/interfaces/IndexFrontmatter.md b/devguide/typedoc-plugin-frontmatter/types/interfaces/IndexFrontmatter.md new file mode 100644 index 00000000..32501a70 --- /dev/null +++ b/devguide/typedoc-plugin-frontmatter/types/interfaces/IndexFrontmatter.md @@ -0,0 +1,3 @@ +[Home](../../../README.md) / [typedoc-plugin-frontmatter](../../README.md) / [types](../README.md) / IndexFrontmatter + +# Interface: IndexFrontmatter diff --git a/developer-docs/typedoc-plugin-frontmatter/types/interfaces/PluginOptions.md b/devguide/typedoc-plugin-frontmatter/types/interfaces/PluginOptions.md similarity index 78% rename from developer-docs/typedoc-plugin-frontmatter/types/interfaces/PluginOptions.md rename to devguide/typedoc-plugin-frontmatter/types/interfaces/PluginOptions.md index eabeaf0d..191bb8ce 100644 --- a/developer-docs/typedoc-plugin-frontmatter/types/interfaces/PluginOptions.md +++ b/devguide/typedoc-plugin-frontmatter/types/interfaces/PluginOptions.md @@ -1,4 +1,4 @@ -[Packages Index](../../../README.md) / [typedoc-plugin-frontmatter](../../README.md) / [types](../README.md) / PluginOptions +[Home](../../../README.md) / [typedoc-plugin-frontmatter](../../README.md) / [types](../README.md) / PluginOptions # Interface: PluginOptions @@ -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/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-frontmatter/src/types/options.ts#L11) +[types/options.ts:11](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/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/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-frontmatter/src/types/options.ts#L16) +[types/options.ts:16](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/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/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-frontmatter/src/types/options.ts#L21) +[types/options.ts:21](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/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/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-frontmatter/src/types/options.ts#L26) +[types/options.ts:26](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/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/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-frontmatter/src/types/options.ts#L31) +[types/options.ts:31](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/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/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-frontmatter/src/types/options.ts#L36) +[types/options.ts:36](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-frontmatter/src/types/options.ts#L36) diff --git a/devguide/typedoc-plugin-frontmatter/types/interfaces/ReadmeFrontmatter.md b/devguide/typedoc-plugin-frontmatter/types/interfaces/ReadmeFrontmatter.md new file mode 100644 index 00000000..9be1cac8 --- /dev/null +++ b/devguide/typedoc-plugin-frontmatter/types/interfaces/ReadmeFrontmatter.md @@ -0,0 +1,3 @@ +[Home](../../../README.md) / [typedoc-plugin-frontmatter](../../README.md) / [types](../README.md) / ReadmeFrontmatter + +# Interface: ReadmeFrontmatter diff --git a/developer-docs/typedoc-plugin-markdown/README.md b/devguide/typedoc-plugin-markdown/README.md similarity index 73% rename from developer-docs/typedoc-plugin-markdown/README.md rename to devguide/typedoc-plugin-markdown/README.md index 9c913e64..8ff90fc6 100644 --- a/developer-docs/typedoc-plugin-markdown/README.md +++ b/devguide/typedoc-plugin-markdown/README.md @@ -1,4 +1,4 @@ -[Packages Index](../README.md) / typedoc-plugin-markdown +[Home](../README.md) / typedoc-plugin-markdown # typedoc-plugin-markdown @@ -6,11 +6,11 @@ The core package of this monorepo and is the package that is used to generate th ## Contents -* [What does the package do?](#what-does-the-package-do) +* [What Does the Package Do?](#what-does-the-package-do) * [Documents](#documents) * [Modules](#modules) -## What does the package do? +## What Does the Package Do? * Extends some methods on the TypeDoc renderer to make compatible with Markdown output. * Exposes some additional options to TypeDoc. @@ -19,10 +19,10 @@ The core package of this monorepo and is the package that is used to generate th ## Documents -| Document | Description | -| ----------------------------------------------- | ------------------------------------------------ | -| [Getting Started](documents/Getting-Started.md) | Instructions on how to start developing locally. | -| [Testing](documents/Testing.md) | Guidance of running tests and creating fixtures. | +| Document | Description | +| ------------------------------------------------------- | ------------------------------------------------------------------- | +| [Getting Started](documents/Getting-Started.md) | How to start developing locally. | +| [Test and Validation](documents/Test-and-Validation.md) | Guidance on running tests, creating fixtures and validating output. | ## Modules diff --git a/developer-docs/typedoc-plugin-markdown/documents/Getting-Started.md b/devguide/typedoc-plugin-markdown/documents/Getting-Started.md similarity index 66% rename from developer-docs/typedoc-plugin-markdown/documents/Getting-Started.md rename to devguide/typedoc-plugin-markdown/documents/Getting-Started.md index 5b4df5ae..14916a09 100644 --- a/developer-docs/typedoc-plugin-markdown/documents/Getting-Started.md +++ b/devguide/typedoc-plugin-markdown/documents/Getting-Started.md @@ -1,56 +1,33 @@ -[Packages Index](../../README.md) / [typedoc-plugin-markdown](../README.md) / Getting Started +[Home](../../README.md) / [typedoc-plugin-markdown](../README.md) / Getting Started # Getting Started +This guide provides some high-level steps with some typical development tasks. + ## Contents -* [Machine Setup](#machine-setup) - * [Fork and clone the repository](#fork-and-clone-the-repository) - * [Install dependencies](#install-dependencies) - * [Build the package](#build-the-package) +* [Setup](#setup) * [Development Playground](#development-playground) - * [Run playground docs](#run-playground-docs) - * [View playground docs](#view-playground-docs) - * [Perform a simple task](#perform-a-simple-task) + * [Run Playground Docs](#run-playground-docs) + * [View Playground Docs](#view-playground-docs) + * [Perform a Simple Task](#perform-a-simple-task) * [Next Steps](#next-steps) -## Machine Setup - -### Fork and clone the repository +## Setup -Start by forking the repository to your own GitHub account. Then, clone the repository to your local machine. Please replace `` with your actual GitHub username. - -```bash -git clone git@github.com:/typedoc-plugin-markdown.git -``` +Please see [Machine Setup]() for general setup instructions. -### Install dependencies +If you are setup, you can start by navigating to the package directory. -Navigate to the repository root and install the necessary dependencies: - -```bash -cd typedoc-plugin-markdown - -npm install -``` - -### Build the package - -Next cd into the package itself and run npm run build. - -```bash +```shell cd packages/typedoc-plugin-markdown - -npm run build ``` -The build process triggers several setup tasks. If the project builds successfully you are ready to start developing. - ## Development Playground To get started you can create a simple task of running a playground and editing a template. -### Run playground docs +### Run Playground Docs Run the playground from the project root. @@ -58,7 +35,7 @@ Run the playground from the project root. npm run playground ``` -### View playground docs +### View Playground Docs The above commands will generate some the markdown docs in the `./playground/docs` folder. @@ -81,7 +58,7 @@ We will use option 2 as an example here: markserv ./playground/docs/README.md ``` -### Perform a simple task +### Perform a Simple Task Now we have a playground setup we can perform some typical development tasks. diff --git a/devguide/typedoc-plugin-markdown/documents/Test-and-Validation.md b/devguide/typedoc-plugin-markdown/documents/Test-and-Validation.md new file mode 100644 index 00000000..6275033b --- /dev/null +++ b/devguide/typedoc-plugin-markdown/documents/Test-and-Validation.md @@ -0,0 +1,79 @@ +[Home](../../README.md) / [typedoc-plugin-markdown](../README.md) / Test and Validation + +# Test and Validation + +This document contains guidance on running tests and creating fixtures. + +## Contents + +* [Tooling](#tooling) +* [Get Started](#get-started) +* [Fixtures](#fixtures) + * [Building Fixtures](#building-fixtures) +* [Test](#test) + * [Specs](#specs) + * [Updating Snapshots](#updating-snapshots) +* [Validation](#validation) + * [Validation Scripts](#validation-scripts) + +## Tooling + +* We use [Jest](https://jestjs.io/) with [ts-Jest](https://kulshekhar.github.io/ts-jest/) to run our test suites. +* We use [markdownlint](https://github.com/DavidAnson/markdownlint) and [remark-mdx](https://mdxjs.com/packages/remark-mdx/) to validate markdown. + +## Get Started + +The following command runs all tests. + +```bash +npm run test +``` + +This command: + +* Generates a suite of fixtures on a `prebuild` task. +* Runs some validation scripts to check the output of the fixtures. +* Runs Jest and triggers the spec files. + +## Fixtures + +We reply heavily (but not exclusively) on snapshot testing. We do this because we need to ensure output is correct +after converting with TypeDoc. + +A series of snapshot tests are used to ensure the output of the plugin is consistent. + +### Building Fixtures + +* The `/fixtures/src` folder contains a set of TypeScript source files that are used as entrypoints. +* The `/fixtures/config.ts` is a configuration file that generates a set of fixture output files that are used by the Jest snapshot tests. It provides a mechanism to easily provide a combination of options. + +The fixtures are build in `pretest` script using a an internal package workspace. See `devtools/packages/fixtures`. + +## Test + +Tests are run on the Jest test suite. + +### Specs + +* There are a suite of tests located in `/test/specs`. These tests run a series of snapshot tests against some output fixtures. +* All pure utility lib methods also have specs run against them in `/src/libs/utils`. + +### Updating Snapshots + +If you make a change to any code the you can update the snapshot source and add a test in the relevant spec file. + +If you require to update the snapshots run the following command: + +```bash +npm run test:update +``` + +## Validation + +Validation is undertaken by the markdownlint and remark-mdx libraries. +When the fixtures are build the output markdown is validated. + +### Validation Scripts + +* `markdownlint` ensures that all output is commonMark complaint. See `/test/script/lint.md`. +* `remark-mdx` ensures that the output is also MDX compliant. See `/test/script/lint.mdx`. diff --git a/developer-docs/typedoc-plugin-markdown/events/README.md b/devguide/typedoc-plugin-markdown/events/README.md similarity index 73% rename from developer-docs/typedoc-plugin-markdown/events/README.md rename to devguide/typedoc-plugin-markdown/events/README.md index 3f699313..d5d7d7ea 100644 --- a/developer-docs/typedoc-plugin-markdown/events/README.md +++ b/devguide/typedoc-plugin-markdown/events/README.md @@ -1,4 +1,4 @@ -[Packages Index](../../README.md) / [typedoc-plugin-markdown](../README.md) / events +[Home](../../README.md) / [typedoc-plugin-markdown](../README.md) / events # events @@ -6,9 +6,9 @@ Contains the events classes used by the plugin. ## Index -### Classes +### Events -| Class | Description | -| --------------------------------------------------------- | ---------------------------------------------------------------------- | -| [MarkdownPageEvent](classes/MarkdownPageEvent.md) | An event emitted by before and after the markup of a page is rendered. | -| [MarkdownRendererEvent](classes/MarkdownRendererEvent.md) | An event emitted at the beginning and end of the rendering process. | +| Class | Description | +| --------------------------------------------------------- | --------------------------------------------------------------------- | +| [MarkdownPageEvent](classes/MarkdownPageEvent.md) | An event emitted before and after the markdown of a page is rendered. | +| [MarkdownRendererEvent](classes/MarkdownRendererEvent.md) | An event emitted at the beginning and end of the rendering process. | diff --git a/developer-docs/typedoc-plugin-markdown/events/classes/MarkdownPageEvent.md b/devguide/typedoc-plugin-markdown/events/classes/MarkdownPageEvent.md similarity index 50% rename from developer-docs/typedoc-plugin-markdown/events/classes/MarkdownPageEvent.md rename to devguide/typedoc-plugin-markdown/events/classes/MarkdownPageEvent.md index 75607a5e..2682e999 100644 --- a/developer-docs/typedoc-plugin-markdown/events/classes/MarkdownPageEvent.md +++ b/devguide/typedoc-plugin-markdown/events/classes/MarkdownPageEvent.md @@ -1,8 +1,8 @@ -[Packages Index](../../../README.md) / [typedoc-plugin-markdown](../../README.md) / [events](../README.md) / MarkdownPageEvent +[Home](../../../README.md) / [typedoc-plugin-markdown](../../README.md) / [events](../README.md) / MarkdownPageEvent # Class: MarkdownPageEvent\ -An event emitted by before and after the markup of a page is rendered. +An event emitted before and after the markdown of a page is rendered. ## Contents @@ -19,25 +19,15 @@ An event emitted by before and after the markup of a page is rendered. * [BEGIN](#begin) * [END](#end) -## Example - -```ts -export function load(app: MarkdownApplication) { - app.renderer.on(MarkdownPageEvent.BEGIN, (page: MarkdownPageEvent) => { - page.contents = page.contents.replace('foo', 'bar'); - }); -}); -``` - ## Extends * [`Event`](https://typedoc.org/api/classes/Event.html) ## Type Parameters -| Type Parameter | Default type | -| -------------- | ---------------------------------------------------------------------- | -| `Model` | [`Reflection`](https://typedoc.org/api/classes/Models.Reflection.html) | +| Type Parameter | Default type | +| -------------- | --------------------------------------------------------------- | +| `Model` | [`Reflection`](https://typedoc.org/api/classes/Reflection.html) | ## Properties @@ -49,7 +39,7 @@ The [`ProjectReflection`](https://typedoc.org/api/classes/Models.ProjectReflecti #### Defined in -[events/markdown-page-event.ts:22](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-markdown/src/events/markdown-page-event.ts#L22) +[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) *** @@ -62,7 +52,7 @@ Either a [`DeclarationReflection`](https://typedoc.org/api/classes/Models.Declar #### Defined in -[events/markdown-page-event.ts:28](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-markdown/src/events/markdown-page-event.ts#L28) +[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) *** @@ -76,7 +66,7 @@ Should be rendered by layout templates and can be modified by plugins. #### Defined in -[events/markdown-page-event.ts:35](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-markdown/src/events/markdown-page-event.ts#L35) +[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) *** @@ -88,7 +78,7 @@ The url `string` of the page. #### Defined in -[events/markdown-page-event.ts:40](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-markdown/src/events/markdown-page-event.ts#L40) +[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) *** @@ -100,7 +90,7 @@ The complete `string` filename where the file will be written.. #### Defined in -[events/markdown-page-event.ts:45](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-markdown/src/events/markdown-page-event.ts#L45) +[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) *** @@ -112,7 +102,7 @@ The frontmatter of this page represented as a key value object. This property ca #### Defined in -[events/markdown-page-event.ts:50](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-markdown/src/events/markdown-page-event.ts#L50) +[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 @@ -124,7 +114,7 @@ Triggered before a document will be rendered. #### Defined in -[events/markdown-page-event.ts:62](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-markdown/src/events/markdown-page-event.ts#L62) +[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) *** @@ -136,4 +126,4 @@ Triggered after a document has been rendered, just before it is written to disc. #### Defined in -[events/markdown-page-event.ts:68](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-markdown/src/events/markdown-page-event.ts#L68) +[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) diff --git a/developer-docs/typedoc-plugin-markdown/events/classes/MarkdownRendererEvent.md b/devguide/typedoc-plugin-markdown/events/classes/MarkdownRendererEvent.md similarity index 52% rename from developer-docs/typedoc-plugin-markdown/events/classes/MarkdownRendererEvent.md rename to devguide/typedoc-plugin-markdown/events/classes/MarkdownRendererEvent.md index 94bd96b8..08d2fceb 100644 --- a/developer-docs/typedoc-plugin-markdown/events/classes/MarkdownRendererEvent.md +++ b/devguide/typedoc-plugin-markdown/events/classes/MarkdownRendererEvent.md @@ -1,4 +1,4 @@ -[Packages Index](../../../README.md) / [typedoc-plugin-markdown](../../README.md) / [events](../README.md) / MarkdownRendererEvent +[Home](../../../README.md) / [typedoc-plugin-markdown](../../README.md) / [events](../README.md) / MarkdownRendererEvent # Class: MarkdownRendererEvent @@ -16,14 +16,6 @@ An event emitted at the beginning and end of the rendering process. * [BEGIN](#begin) * [END](#end) -## Example - -```ts -app.renderer.on(MarkdownRendererEvent.BEGIN, (event) => { - console.log(`Render Starting for ${event.project.name}!`); -}); -``` - ## Extends * [`Event`](https://typedoc.org/api/classes/Event.html) @@ -38,7 +30,7 @@ The project the renderer is currently processing. #### Defined in -[events/markdown-renderer-event.ts:21](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-markdown/src/events/markdown-renderer-event.ts#L21) +[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) *** @@ -50,19 +42,19 @@ The path of the directory the documentation should be written to. #### Defined in -[events/markdown-renderer-event.ts:26](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-markdown/src/events/markdown-renderer-event.ts#L26) +[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) *** ### urls? -> `optional` **urls**: [`UrlMapping`](../../types/interfaces/UrlMapping.md)\<[`Reflection`](https://typedoc.org/api/classes/Models.Reflection.html)>\[] +> `optional` **urls**: [`UrlMapping`](../../types/interfaces/UrlMapping.md)\<[`Reflection`](https://typedoc.org/api/classes/Reflection.html)>\[] A list of all pages that should be generated. #### Defined in -[events/markdown-renderer-event.ts:31](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-markdown/src/events/markdown-renderer-event.ts#L31) +[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) *** @@ -74,7 +66,7 @@ The navigation structure of the project that can be utilised by plugins. #### Defined in -[events/markdown-renderer-event.ts:36](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-markdown/src/events/markdown-renderer-event.ts#L36) +[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 @@ -86,7 +78,7 @@ Triggered before the renderer starts rendering a project. #### Defined in -[events/markdown-renderer-event.ts:42](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-markdown/src/events/markdown-renderer-event.ts#L42) +[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) *** @@ -98,4 +90,4 @@ Triggered after the renderer has written all documents. #### Defined in -[events/markdown-renderer-event.ts:48](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-markdown/src/events/markdown-renderer-event.ts#L48) +[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) diff --git a/developer-docs/typedoc-plugin-markdown/index/README.md b/devguide/typedoc-plugin-markdown/index/README.md similarity index 78% rename from developer-docs/typedoc-plugin-markdown/index/README.md rename to devguide/typedoc-plugin-markdown/index/README.md index efdee4ca..314a6542 100644 --- a/developer-docs/typedoc-plugin-markdown/index/README.md +++ b/devguide/typedoc-plugin-markdown/index/README.md @@ -1,4 +1,4 @@ -[Packages Index](../../README.md) / [typedoc-plugin-markdown](../README.md) / index +[Home](../../README.md) / [typedoc-plugin-markdown](../README.md) / index # index @@ -8,7 +8,7 @@ The plugin entrypoint and bootstrapping of the plugin. > **load**(`app`): `void` -The function that is called by TypeDoc to bootstrap the plugin. [https://typedoc.org/guides/development/#plugins](https://typedoc.org/guides/development/#plugins). +The function that is called by TypeDoc to bootstrap the plugin. Here we expose additional TypeDoc options and make some adjustments. @@ -24,6 +24,10 @@ This method is not intended to be consumed in any other context that via the `pl `void` +### See + +[https://typedoc.org/guides/development/#plugins](https://typedoc.org/guides/development/#plugins). + ### Defined in -[index.ts:30](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-markdown/src/index.ts#L30) +[index.ts:30](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/index.ts#L30) diff --git a/developer-docs/typedoc-plugin-markdown/internationalization/README.md b/devguide/typedoc-plugin-markdown/internationalization/README.md similarity index 80% rename from developer-docs/typedoc-plugin-markdown/internationalization/README.md rename to devguide/typedoc-plugin-markdown/internationalization/README.md index 78899d33..3803b4d7 100644 --- a/developer-docs/typedoc-plugin-markdown/internationalization/README.md +++ b/devguide/typedoc-plugin-markdown/internationalization/README.md @@ -1,9 +1,13 @@ -[Packages Index](../../README.md) / [typedoc-plugin-markdown](../README.md) / internationalization +[Home](../../README.md) / [typedoc-plugin-markdown](../README.md) / internationalization # internationalization Exposes additional i18n keys and translations used by the theme. +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). + ## Contents * [Methods](#methods) @@ -36,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/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-markdown/src/internationalization/translatable.ts#L16) +[internationalization/translatable.ts:16](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/internationalization/translatable.ts#L16) ## Locales @@ -69,7 +73,7 @@ Translations for 'en' locale. #### Defined in -[internationalization/locales/en.ts:7](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-markdown/src/internationalization/locales/en.ts#L7) +[internationalization/locales/en.ts:7](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/internationalization/locales/en.ts#L7) *** @@ -102,7 +106,7 @@ Translations for 'jp' locale. #### Defined in -[internationalization/locales/jp.ts:8](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-markdown/src/internationalization/locales/jp.ts#L8) +[internationalization/locales/jp.ts:8](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/internationalization/locales/jp.ts#L8) *** @@ -135,7 +139,7 @@ Translations for 'ko' locale. #### Defined in -[internationalization/locales/ko.ts:7](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-markdown/src/internationalization/locales/ko.ts#L7) +[internationalization/locales/ko.ts:7](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/internationalization/locales/ko.ts#L7) *** @@ -168,4 +172,4 @@ Translations for 'zh' locale. #### Defined in -[internationalization/locales/zh.ts:7](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-markdown/src/internationalization/locales/zh.ts#L7) +[internationalization/locales/zh.ts:7](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/internationalization/locales/zh.ts#L7) diff --git a/developer-docs/typedoc-plugin-markdown/libs/README.md b/devguide/typedoc-plugin-markdown/libs/README.md similarity index 84% rename from developer-docs/typedoc-plugin-markdown/libs/README.md rename to devguide/typedoc-plugin-markdown/libs/README.md index 72277724..15a415a8 100644 --- a/developer-docs/typedoc-plugin-markdown/libs/README.md +++ b/devguide/typedoc-plugin-markdown/libs/README.md @@ -1,4 +1,4 @@ -[Packages Index](../../README.md) / [typedoc-plugin-markdown](../README.md) / libs +[Home](../../README.md) / [typedoc-plugin-markdown](../README.md) / libs # libs diff --git a/developer-docs/typedoc-plugin-markdown/libs/namespaces/markdown/README.md b/devguide/typedoc-plugin-markdown/libs/namespaces/markdown/README.md similarity index 77% rename from developer-docs/typedoc-plugin-markdown/libs/namespaces/markdown/README.md rename to devguide/typedoc-plugin-markdown/libs/namespaces/markdown/README.md index 8e8986a3..eb1b3e7d 100644 --- a/developer-docs/typedoc-plugin-markdown/libs/namespaces/markdown/README.md +++ b/devguide/typedoc-plugin-markdown/libs/namespaces/markdown/README.md @@ -1,4 +1,4 @@ -[Packages Index](../../../../README.md) / [typedoc-plugin-markdown](../../../README.md) / [libs](../../README.md) / markdown +[Home](../../../../README.md) / [typedoc-plugin-markdown](../../../README.md) / [libs](../../README.md) / markdown # markdown @@ -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/352ce41370cee18034e72b7c2f3874bbfe56f96f/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/7934b23566f374f44fe6de5fd9240ab185bf799f/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/352ce41370cee18034e72b7c2f3874bbfe56f96f/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/7934b23566f374f44fe6de5fd9240ab185bf799f/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/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-markdown/src/libs/markdown/bold.ts#L1) +[libs/markdown/bold.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/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/352ce41370cee18034e72b7c2f3874bbfe56f96f/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/7934b23566f374f44fe6de5fd9240ab185bf799f/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/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-markdown/src/libs/markdown/heading.ts#L6) +[libs/markdown/heading.ts:6](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/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/352ce41370cee18034e72b7c2f3874bbfe56f96f/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/7934b23566f374f44fe6de5fd9240ab185bf799f/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/352ce41370cee18034e72b7c2f3874bbfe56f96f/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/7934b23566f374f44fe6de5fd9240ab185bf799f/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/352ce41370cee18034e72b7c2f3874bbfe56f96f/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/7934b23566f374f44fe6de5fd9240ab185bf799f/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/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-markdown/src/libs/markdown/italic.ts#L1) +[libs/markdown/italic.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/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/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-markdown/src/libs/markdown/link.ts#L6) +[libs/markdown/link.ts:6](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/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/352ce41370cee18034e72b7c2f3874bbfe56f96f/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/7934b23566f374f44fe6de5fd9240ab185bf799f/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/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-markdown/src/libs/markdown/table.ts#L7) +[libs/markdown/table.ts:7](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/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/352ce41370cee18034e72b7c2f3874bbfe56f96f/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/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/libs/markdown/unordered-list.ts#L1) diff --git a/developer-docs/typedoc-plugin-markdown/libs/namespaces/utils/README.md b/devguide/typedoc-plugin-markdown/libs/namespaces/utils/README.md similarity index 73% rename from developer-docs/typedoc-plugin-markdown/libs/namespaces/utils/README.md rename to devguide/typedoc-plugin-markdown/libs/namespaces/utils/README.md index 6159ad80..76e5eae7 100644 --- a/developer-docs/typedoc-plugin-markdown/libs/namespaces/utils/README.md +++ b/devguide/typedoc-plugin-markdown/libs/namespaces/utils/README.md @@ -1,4 +1,4 @@ -[Packages Index](../../../../README.md) / [typedoc-plugin-markdown](../../../README.md) / [libs](../../README.md) / utils +[Home](../../../../README.md) / [typedoc-plugin-markdown](../../../README.md) / [libs](../../README.md) / utils # utils @@ -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/352ce41370cee18034e72b7c2f3874bbfe56f96f/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/7934b23566f374f44fe6de5fd9240ab185bf799f/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/352ce41370cee18034e72b7c2f3874bbfe56f96f/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/7934b23566f374f44fe6de5fd9240ab185bf799f/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/352ce41370cee18034e72b7c2f3874bbfe56f96f/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/7934b23566f374f44fe6de5fd9240ab185bf799f/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/352ce41370cee18034e72b7c2f3874bbfe56f96f/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/7934b23566f374f44fe6de5fd9240ab185bf799f/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/352ce41370cee18034e72b7c2f3874bbfe56f96f/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/7934b23566f374f44fe6de5fd9240ab185bf799f/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/352ce41370cee18034e72b7c2f3874bbfe56f96f/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/7934b23566f374f44fe6de5fd9240ab185bf799f/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/352ce41370cee18034e72b7c2f3874bbfe56f96f/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/7934b23566f374f44fe6de5fd9240ab185bf799f/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/352ce41370cee18034e72b7c2f3874bbfe56f96f/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/7934b23566f374f44fe6de5fd9240ab185bf799f/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/352ce41370cee18034e72b7c2f3874bbfe56f96f/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/7934b23566f374f44fe6de5fd9240ab185bf799f/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/352ce41370cee18034e72b7c2f3874bbfe56f96f/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/7934b23566f374f44fe6de5fd9240ab185bf799f/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/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-markdown/src/libs/utils/slugify.ts#L1) +[libs/utils/slugify.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/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/352ce41370cee18034e72b7c2f3874bbfe56f96f/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/7934b23566f374f44fe6de5fd9240ab185bf799f/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/352ce41370cee18034e72b7c2f3874bbfe56f96f/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/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/libs/utils/un-escape-chars.ts#L1) diff --git a/devguide/typedoc-plugin-markdown/options/README.md b/devguide/typedoc-plugin-markdown/options/README.md new file mode 100644 index 00000000..951d72d8 --- /dev/null +++ b/devguide/typedoc-plugin-markdown/options/README.md @@ -0,0 +1,44 @@ +[Home](../../README.md) / [typedoc-plugin-markdown](../README.md) / options + +# options + +Contains all the option declarations and types used in the plugin. + +Options exposed to TypeDoc are added as a named export to the declarations options. + +## Contents + +* [Index](#index) + * [Namespaces](#namespaces) + +## Example + +```ts +/** + * Some more detailed comments about the option. + * + * @category Display + */ +export const myNewOption: Partial = { + help: 'A short description of the option.', + type: ParameterType.Boolean, + defaultValue: false, + }; +``` + +This will be exposed to TypeDoc as a new option when bootstrapping the plugin, with the name of the option the name of the exported variable. + +In addition, when the `prebuild` task is run: + +* The option type will be added to `TypeDocOptionsMap`. +* The documentation will be updated using the JSDoc comments and categorized as per the `@category` tag. + +## Index + +### Namespaces + +| Namespace | Description | +| ------------------------------------------------- | ------------------------------------------------- | +| [constants](namespaces/constants/README.md) | Contains constant default values used in options. | +| [declarations](namespaces/declarations/README.md) | Typedoc options declarations. | +| [maps](namespaces/maps/README.md) | Maps a given value to the option type. | diff --git a/developer-docs/typedoc-plugin-markdown/options/namespaces/constants/README.md b/devguide/typedoc-plugin-markdown/options/namespaces/constants/README.md similarity index 85% rename from developer-docs/typedoc-plugin-markdown/options/namespaces/constants/README.md rename to devguide/typedoc-plugin-markdown/options/namespaces/constants/README.md index 4e036855..e2ab53cb 100644 --- a/developer-docs/typedoc-plugin-markdown/options/namespaces/constants/README.md +++ b/devguide/typedoc-plugin-markdown/options/namespaces/constants/README.md @@ -1,4 +1,4 @@ -[Packages Index](../../../../README.md) / [typedoc-plugin-markdown](../../../README.md) / [options](../../README.md) / constants +[Home](../../../../README.md) / [typedoc-plugin-markdown](../../../README.md) / [options](../../README.md) / constants # constants @@ -30,7 +30,7 @@ Default values for `membersWithOwnFile` option. ### Defined in -[options/constants.ts:12](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-markdown/src/options/constants.ts#L12) +[options/constants.ts:12](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/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/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-markdown/src/options/constants.ts#L24) +[options/constants.ts:24](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/options/constants.ts#L24) diff --git a/developer-docs/typedoc-plugin-markdown/options/namespaces/declarations/README.md b/devguide/typedoc-plugin-markdown/options/namespaces/declarations/README.md similarity index 86% rename from developer-docs/typedoc-plugin-markdown/options/namespaces/declarations/README.md rename to devguide/typedoc-plugin-markdown/options/namespaces/declarations/README.md index 65a6f70a..20051429 100644 --- a/developer-docs/typedoc-plugin-markdown/options/namespaces/declarations/README.md +++ b/devguide/typedoc-plugin-markdown/options/namespaces/declarations/README.md @@ -1,4 +1,4 @@ -[Packages Index](../../../../README.md) / [typedoc-plugin-markdown](../../../README.md) / [options](../../README.md) / declarations +[Home](../../../../README.md) / [typedoc-plugin-markdown](../../../README.md) / [options](../../README.md) / declarations # declarations @@ -21,8 +21,8 @@ The JSDoc comments will also be used in the public facing documentation. * [mergeReadme](#mergereadme) * [Display](#display) * [hidePageHeader](#hidepageheader) - * [hidePageTitle](#hidepagetitle) * [hideBreadcrumbs](#hidebreadcrumbs) + * [hidePageTitle](#hidepagetitle) * [hideGroupHeadings](#hidegroupheadings) * [useCodeBlocks](#usecodeblocks) * [expandObjects](#expandobjects) @@ -41,8 +41,8 @@ The JSDoc comments will also be used in the public facing documentation. * [anchorPrefix](#anchorprefix) * [useHTMLAnchors](#usehtmlanchors) * [preserveAnchorCasing](#preserveanchorcasing) - * [navigationModel](#navigationmodel) * [textContentMappings](#textcontentmappings) + * [navigationModel](#navigationmodel) ## File @@ -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/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-markdown/src/options/declarations.ts#L66) +[options/declarations.ts:66](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/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/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-markdown/src/options/declarations.ts#L82) +[options/declarations.ts:82](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/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/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-markdown/src/options/declarations.ts#L105) +[options/declarations.ts:105](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/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/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-markdown/src/options/declarations.ts#L118) +[options/declarations.ts:118](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/options/declarations.ts#L118) *** @@ -203,11 +203,12 @@ Typically markdown files are recognised by the `.md` or `.markdown` file extensi > `const` **entryFileName**: `Partial`\<[`DeclarationOption`](https://typedoc.org/api/types/Configuration.DeclarationOption.html)> -The entry page is the root page of the documentation, equivalent to `index.html` for web pages. +The `entryFileName` in this context is the root page of the documentation and each module directory. +This is essentially the equivalent to `index.html` for web pages. `README` is recognised when browsing folders on repos and Wikis and is the plugin default. `index` might be more suitable for static site generators. -The content of this file will be resolved in the following order: +The content of root documentation file will be resolved in the following order: 1. The value of the [`entryModule`](#entrymodule) option (if defined). 2. The resolved Readme file (skipped if the [`readme`](https://typedoc.org/options/input/#readme) option is set to `none`). @@ -231,7 +232,7 @@ The content of this file will be resolved in the following order: #### Defined in -[options/declarations.ts:147](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-markdown/src/options/declarations.ts#L147) +[options/declarations.ts:148](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/options/declarations.ts#L148) *** @@ -262,7 +263,7 @@ Please note a separate modules index page will not be generated, therefore would #### Defined in -[options/declarations.ts:164](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-markdown/src/options/declarations.ts#L164) +[options/declarations.ts:165](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/options/declarations.ts#L165) *** @@ -290,7 +291,7 @@ Ignored if `flattenOutputFiles` is set to `true`. #### Defined in -[options/declarations.ts:180](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-markdown/src/options/declarations.ts#L180) +[options/declarations.ts:181](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/options/declarations.ts#L181) *** @@ -315,7 +316,7 @@ This option has no effect when [`--readme`](https://typedoc.org/options/input/#r #### Defined in -[options/declarations.ts:194](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-markdown/src/options/declarations.ts#L194) +[options/declarations.ts:195](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/options/declarations.ts#L195) ## Display @@ -337,19 +338,19 @@ Options that are used to configure how the output is structured and displayed. #### Defined in -[options/declarations.ts:203](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-markdown/src/options/declarations.ts#L203) +[options/declarations.ts:204](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/options/declarations.ts#L204) *** -### hidePageTitle +### hideBreadcrumbs -> `const` **hidePageTitle**: `Partial`\<[`DeclarationOption`](https://typedoc.org/api/types/Configuration.DeclarationOption.html)> +> `const` **hideBreadcrumbs**: `Partial`\<[`DeclarationOption`](https://typedoc.org/api/types/Configuration.DeclarationOption.html)> #### Default Value ```ts { - help: 'Do not print page title.', + help: 'Do not print breadcrumbs.', type: ParameterType.Boolean, defaultValue: false, } @@ -357,19 +358,19 @@ Options that are used to configure how the output is structured and displayed. #### Defined in -[options/declarations.ts:212](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-markdown/src/options/declarations.ts#L212) +[options/declarations.ts:213](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/options/declarations.ts#L213) *** -### hideBreadcrumbs +### hidePageTitle -> `const` **hideBreadcrumbs**: `Partial`\<[`DeclarationOption`](https://typedoc.org/api/types/Configuration.DeclarationOption.html)> +> `const` **hidePageTitle**: `Partial`\<[`DeclarationOption`](https://typedoc.org/api/types/Configuration.DeclarationOption.html)> #### Default Value ```ts { - help: 'Do not print breadcrumbs.', + help: 'Do not print page title.', type: ParameterType.Boolean, defaultValue: false, } @@ -377,7 +378,7 @@ Options that are used to configure how the output is structured and displayed. #### Defined in -[options/declarations.ts:221](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-markdown/src/options/declarations.ts#L221) +[options/declarations.ts:222](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/options/declarations.ts#L222) *** @@ -401,7 +402,7 @@ This creates a flat structure where all members are displayed at the same headin #### Defined in -[options/declarations.ts:234](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-markdown/src/options/declarations.ts#L234) +[options/declarations.ts:235](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/options/declarations.ts#L235) *** @@ -427,7 +428,7 @@ As a work around the [`@link`](https://typedoc.org/tags/link/) tag can be be use #### Defined in -[options/declarations.ts:260](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-markdown/src/options/declarations.ts#L260) +[options/declarations.ts:261](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/options/declarations.ts#L261) *** @@ -451,7 +452,7 @@ This option should be set when a full object representation is preferred. #### Defined in -[options/declarations.ts:273](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-markdown/src/options/declarations.ts#L273) +[options/declarations.ts:274](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/options/declarations.ts#L274) *** @@ -475,7 +476,7 @@ This option should be set when a full type representation is preferred. #### Defined in -[options/declarations.ts:286](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-markdown/src/options/declarations.ts#L286) +[options/declarations.ts:287](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/options/declarations.ts#L287) *** @@ -504,7 +505,7 @@ When table style is selected the following will be the behaviour: #### Defined in -[options/declarations.ts:303](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-markdown/src/options/declarations.ts#L303) +[options/declarations.ts:304](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/options/declarations.ts#L304) *** @@ -531,7 +532,7 @@ This option specifies the output format for parameters and type parameters of fu #### Defined in -[options/declarations.ts:319](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-markdown/src/options/declarations.ts#L319) +[options/declarations.ts:320](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/options/declarations.ts#L320) *** @@ -558,7 +559,7 @@ This option specifies the output format for interface properties: #### Defined in -[options/declarations.ts:335](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-markdown/src/options/declarations.ts#L335) +[options/declarations.ts:336](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/options/declarations.ts#L336) *** @@ -585,7 +586,7 @@ This option specifies the output format for class properties: #### Defined in -[options/declarations.ts:351](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-markdown/src/options/declarations.ts#L351) +[options/declarations.ts:352](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/options/declarations.ts#L352) *** @@ -612,7 +613,7 @@ This option specifies the output format for enumeration members: #### Defined in -[options/declarations.ts:367](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-markdown/src/options/declarations.ts#L367) +[options/declarations.ts:368](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/options/declarations.ts#L368) *** @@ -639,7 +640,7 @@ This option specifies the output format for type declaration of variables and ty #### Defined in -[options/declarations.ts:383](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-markdown/src/options/declarations.ts#L383) +[options/declarations.ts:384](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/options/declarations.ts#L384) *** @@ -668,7 +669,7 @@ Note this options will only take effect when `propertiesFormat` is set to `list` #### Defined in -[options/declarations.ts:401](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-markdown/src/options/declarations.ts#L401) +[options/declarations.ts:402](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/options/declarations.ts#L402) *** @@ -702,7 +703,7 @@ In addition you can control the alignment of the header text. #### Defined in -[options/declarations.ts:431](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-markdown/src/options/declarations.ts#L431) +[options/declarations.ts:432](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/options/declarations.ts#L432) ## Utility @@ -732,7 +733,7 @@ If undefined all urls will be relative. #### Defined in -[options/declarations.ts:452](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-markdown/src/options/declarations.ts#L452) +[options/declarations.ts:453](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/options/declarations.ts#L453) *** @@ -764,7 +765,7 @@ This option would typically be used when source code comes from an external libr #### Defined in -[options/declarations.ts:473](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-markdown/src/options/declarations.ts#L473) +[options/declarations.ts:474](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/options/declarations.ts#L474) *** @@ -792,7 +793,7 @@ This option should be used when parsers require a custom anchor prefix. #### Defined in -[options/declarations.ts:486](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-markdown/src/options/declarations.ts#L486) +[options/declarations.ts:487](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/options/declarations.ts#L487) *** @@ -817,7 +818,7 @@ This option should be used if there are issues with anchoring to symbols within #### Defined in -[options/declarations.ts:500](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-markdown/src/options/declarations.ts#L500) +[options/declarations.ts:501](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/options/declarations.ts#L501) *** @@ -841,7 +842,48 @@ This option can be used for engines that require the preservation of anchor link #### Defined in -[options/declarations.ts:513](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-markdown/src/options/declarations.ts#L513) +[options/declarations.ts:514](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/options/declarations.ts#L514) + +*** + +### textContentMappings + +> `const` **textContentMappings**: `Partial`\<[`DeclarationOption`](https://typedoc.org/api/types/Configuration.DeclarationOption.html)> + +Defines placeholder text in main template that can be customized. Includes the main page header and breadcrumbs (if displayed), +page titles and page footer. + +Default values within curly braces \{} indicates a placeholder of dynamic text. + +* The `{projectName}` placeholder writes project's name . +* The `{kind}` writes the reflection kind of the page. +* The `{version}` placeholder writes package version (if includeVersion is `true`). + +If you are looking for general localization support please see [localization](). + +#### Default Value + +```ts +{ + help: 'Change specific text placeholders in the template.', + type: ParameterType.Object, + defaultValue: TEXT_CONTENT_MAPPINGS, + validate(value) { + if (!value || typeof value !== 'object') { + throw new Error('[typedoc-plugin-markdown] textContentMappings must be an object.'); + } + for (const val of Object.values(value)) { + if (typeof val !== 'string') { + throw new Error(`[typedoc-plugin-markdown] All values of textContentMappings must be strings.`); + } + } + }, +} +``` + +#### Defined in + +[options/declarations.ts:534](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/options/declarations.ts#L534) *** @@ -891,45 +933,4 @@ export function load(app: MarkdownApplication) { #### Defined in -[options/declarations.ts:549](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-markdown/src/options/declarations.ts#L549) - -*** - -### textContentMappings - -> `const` **textContentMappings**: `Partial`\<[`DeclarationOption`](https://typedoc.org/api/types/Configuration.DeclarationOption.html)> - -Defines placeholder text in main template that can be customized. Includes the main page header and breadcrumbs (if displayed), -page titles and page footer. - -Default values within curly braces \{} indicates a placeholder of dynamic text. - -* The `{projectName}` placeholder writes project's name . -* The `{kind}` writes the reflection kind of the page. -* The `{version}` placeholder writes package version (if includeVersion is `true`). - -If you are looking for general localization support please see [localization](). - -#### Default Value - -```ts -{ - help: 'Change specific text placeholders in the template.', - type: ParameterType.Object, - defaultValue: TEXT_CONTENT_MAPPINGS, - validate(value) { - if (!value || typeof value !== 'object') { - throw new Error('[typedoc-plugin-markdown] textContentMappings must be an object.'); - } - for (const val of Object.values(value)) { - if (typeof val !== 'string') { - throw new Error(`[typedoc-plugin-markdown] All values of textContentMappings must be strings.`); - } - } - }, -} -``` - -#### Defined in - -[options/declarations.ts:573](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-markdown/src/options/declarations.ts#L573) +[options/declarations.ts:584](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/options/declarations.ts#L584) diff --git a/developer-docs/typedoc-plugin-markdown/options/namespaces/maps/README.md b/devguide/typedoc-plugin-markdown/options/namespaces/maps/README.md similarity index 84% rename from developer-docs/typedoc-plugin-markdown/options/namespaces/maps/README.md rename to devguide/typedoc-plugin-markdown/options/namespaces/maps/README.md index 21bfdcbf..c7833077 100644 --- a/developer-docs/typedoc-plugin-markdown/options/namespaces/maps/README.md +++ b/devguide/typedoc-plugin-markdown/options/namespaces/maps/README.md @@ -1,4 +1,4 @@ -[Packages Index](../../../../README.md) / [typedoc-plugin-markdown](../../../README.md) / [options](../../README.md) / maps +[Home](../../../../README.md) / [typedoc-plugin-markdown](../../../README.md) / [options](../../README.md) / maps # maps diff --git a/developer-docs/typedoc-plugin-markdown/options/namespaces/maps/enumerations/IndexFormat.md b/devguide/typedoc-plugin-markdown/options/namespaces/maps/enumerations/IndexFormat.md similarity index 59% rename from developer-docs/typedoc-plugin-markdown/options/namespaces/maps/enumerations/IndexFormat.md rename to devguide/typedoc-plugin-markdown/options/namespaces/maps/enumerations/IndexFormat.md index f4044b6d..490f9575 100644 --- a/developer-docs/typedoc-plugin-markdown/options/namespaces/maps/enumerations/IndexFormat.md +++ b/devguide/typedoc-plugin-markdown/options/namespaces/maps/enumerations/IndexFormat.md @@ -1,4 +1,4 @@ -[Packages Index](../../../../../README.md) / [typedoc-plugin-markdown](../../../../README.md) / [options](../../../README.md) / [maps](../README.md) / IndexFormat +[Home](../../../../../README.md) / [typedoc-plugin-markdown](../../../../README.md) / [options](../../../README.md) / [maps](../README.md) / IndexFormat # Enumeration: IndexFormat diff --git a/developer-docs/typedoc-plugin-markdown/options/namespaces/maps/enumerations/OutputFileStrategy.md b/devguide/typedoc-plugin-markdown/options/namespaces/maps/enumerations/OutputFileStrategy.md similarity index 61% rename from developer-docs/typedoc-plugin-markdown/options/namespaces/maps/enumerations/OutputFileStrategy.md rename to devguide/typedoc-plugin-markdown/options/namespaces/maps/enumerations/OutputFileStrategy.md index 0e90154f..9cca0c13 100644 --- a/developer-docs/typedoc-plugin-markdown/options/namespaces/maps/enumerations/OutputFileStrategy.md +++ b/devguide/typedoc-plugin-markdown/options/namespaces/maps/enumerations/OutputFileStrategy.md @@ -1,4 +1,4 @@ -[Packages Index](../../../../../README.md) / [typedoc-plugin-markdown](../../../../README.md) / [options](../../../README.md) / [maps](../README.md) / OutputFileStrategy +[Home](../../../../../README.md) / [typedoc-plugin-markdown](../../../../README.md) / [options](../../../README.md) / [maps](../README.md) / OutputFileStrategy # Enumeration: OutputFileStrategy diff --git a/developer-docs/typedoc-plugin-markdown/options/namespaces/maps/enumerations/ReflectionFormat.md b/devguide/typedoc-plugin-markdown/options/namespaces/maps/enumerations/ReflectionFormat.md similarity index 64% rename from developer-docs/typedoc-plugin-markdown/options/namespaces/maps/enumerations/ReflectionFormat.md rename to devguide/typedoc-plugin-markdown/options/namespaces/maps/enumerations/ReflectionFormat.md index b6bb7d2f..5d2cc6fc 100644 --- a/developer-docs/typedoc-plugin-markdown/options/namespaces/maps/enumerations/ReflectionFormat.md +++ b/devguide/typedoc-plugin-markdown/options/namespaces/maps/enumerations/ReflectionFormat.md @@ -1,4 +1,4 @@ -[Packages Index](../../../../../README.md) / [typedoc-plugin-markdown](../../../../README.md) / [options](../../../README.md) / [maps](../README.md) / ReflectionFormat +[Home](../../../../../README.md) / [typedoc-plugin-markdown](../../../../README.md) / [options](../../../README.md) / [maps](../README.md) / ReflectionFormat # Enumeration: ReflectionFormat diff --git a/developer-docs/typedoc-plugin-markdown/renderer/README.md b/devguide/typedoc-plugin-markdown/renderer/README.md similarity index 91% rename from developer-docs/typedoc-plugin-markdown/renderer/README.md rename to devguide/typedoc-plugin-markdown/renderer/README.md index b471590f..137ddbf4 100644 --- a/developer-docs/typedoc-plugin-markdown/renderer/README.md +++ b/devguide/typedoc-plugin-markdown/renderer/README.md @@ -1,4 +1,4 @@ -[Packages Index](../../README.md) / [typedoc-plugin-markdown](../README.md) / renderer +[Home](../../README.md) / [typedoc-plugin-markdown](../README.md) / renderer # renderer @@ -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/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-markdown/src/renderer/overrides.ts#L16) +[renderer/overrides.ts:16](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/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/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-markdown/src/renderer/overrides.ts#L38) +[renderer/overrides.ts:38](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/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/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-markdown/src/renderer/packages.ts#L11) +[renderer/packages.ts:11](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/renderer/packages.ts#L11) diff --git a/devguide/typedoc-plugin-markdown/theme/README.md b/devguide/typedoc-plugin-markdown/theme/README.md new file mode 100644 index 00000000..c6e8ddfc --- /dev/null +++ b/devguide/typedoc-plugin-markdown/theme/README.md @@ -0,0 +1,14 @@ +[Home](../../README.md) / [typedoc-plugin-markdown](../README.md) / theme + +# theme + +Contains all functionality relevant to the theme. + +## Index + +### Theme Classes + +| Class | Description | +| ------------------------------------------------------- | ----------------------------------------------------------------------------------- | +| [MarkdownTheme](classes/MarkdownTheme.md) | The main theme class for the plugin. | +| [MarkdownThemeContext](classes/MarkdownThemeContext.md) | The theme context class that is provided as context on the rendering of every page. | diff --git a/developer-docs/typedoc-plugin-markdown/theme/classes/MarkdownTheme.md b/devguide/typedoc-plugin-markdown/theme/classes/MarkdownTheme.md similarity index 78% rename from developer-docs/typedoc-plugin-markdown/theme/classes/MarkdownTheme.md rename to devguide/typedoc-plugin-markdown/theme/classes/MarkdownTheme.md index 30a9b3d0..48ad03a0 100644 --- a/developer-docs/typedoc-plugin-markdown/theme/classes/MarkdownTheme.md +++ b/devguide/typedoc-plugin-markdown/theme/classes/MarkdownTheme.md @@ -1,8 +1,9 @@ -[Packages Index](../../../README.md) / [typedoc-plugin-markdown](../../README.md) / [theme](../README.md) / MarkdownTheme +[Home](../../../README.md) / [typedoc-plugin-markdown](../../README.md) / [theme](../README.md) / MarkdownTheme # Class: MarkdownTheme The main theme class for the plugin. + The class controls how TypeDoc models are mapped to files and templates and extends TypeDoc's base Theme class. You would typically only be interested in overriding the the theme's render context instance. @@ -25,18 +26,6 @@ The API follows the implementation of [TypeDoc's custom theming](https://github. * [projectTemplate()](#projecttemplate) * [reflectionTemplate()](#reflectiontemplate) -## Example - -```ts -export function load(app) { - app.renderer.defineTheme('customTheme', MyMarkdownTheme); -} - -class MyMarkdownTheme extends MarkdownTheme { - ... -} -``` - ## Extends * [`Theme`](https://typedoc.org/api/classes/Theme.html) @@ -63,7 +52,7 @@ class MyMarkdownTheme extends MarkdownTheme { #### Defined in -[theme/markdown-theme.ts:38](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts#L38) +[theme/markdown-theme.ts:29](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts#L29) ## Methods @@ -77,10 +66,10 @@ Renders a template and page model to a string. #### Parameters -| Parameter | Type | -| ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `page` | [`MarkdownPageEvent`](../../events/classes/MarkdownPageEvent.md)\<[`Reflection`](https://typedoc.org/api/classes/Models.Reflection.html)> | -| `template` | [`RenderTemplate`](../../types/type-aliases/RenderTemplate.md)\<[`MarkdownPageEvent`](../../events/classes/MarkdownPageEvent.md)\<[`Reflection`](https://typedoc.org/api/classes/Models.Reflection.html)>> | +| Parameter | Type | +| ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `page` | [`MarkdownPageEvent`](../../events/classes/MarkdownPageEvent.md)\<[`Reflection`](https://typedoc.org/api/classes/Reflection.html)> | +| `template` | [`RenderTemplate`](../../types/type-aliases/RenderTemplate.md)\<[`MarkdownPageEvent`](../../events/classes/MarkdownPageEvent.md)\<[`Reflection`](https://typedoc.org/api/classes/Reflection.html)>> | #### Returns @@ -92,7 +81,7 @@ Renders a template and page model to a string. #### Defined in -[theme/markdown-theme.ts:47](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts#L47) +[theme/markdown-theme.ts:38](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts#L38) *** @@ -106,9 +95,9 @@ This method can be overridden to provide an alternative theme context. #### Parameters -| Parameter | Type | -| --------- | ----------------------------------------------------------------------------------------------------------------------------------------- | -| `page` | [`MarkdownPageEvent`](../../events/classes/MarkdownPageEvent.md)\<[`Reflection`](https://typedoc.org/api/classes/Models.Reflection.html)> | +| Parameter | Type | +| --------- | ---------------------------------------------------------------------------------------------------------------------------------- | +| `page` | [`MarkdownPageEvent`](../../events/classes/MarkdownPageEvent.md)\<[`Reflection`](https://typedoc.org/api/classes/Reflection.html)> | #### Returns @@ -116,13 +105,13 @@ This method can be overridden to provide an alternative theme context. #### Defined in -[theme/markdown-theme.ts:64](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts#L64) +[theme/markdown-theme.ts:55](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts#L55) *** ### getUrls() -> **getUrls**(`project`): [`UrlMapping`](../../types/interfaces/UrlMapping.md)\<[`Reflection`](https://typedoc.org/api/classes/Models.Reflection.html)>\[] +> **getUrls**(`project`): [`UrlMapping`](../../types/interfaces/UrlMapping.md)\<[`Reflection`](https://typedoc.org/api/classes/Reflection.html)>\[] Maps the models of the given project to the desired output files. @@ -134,7 +123,7 @@ Maps the models of the given project to the desired output files. #### Returns -[`UrlMapping`](../../types/interfaces/UrlMapping.md)\<[`Reflection`](https://typedoc.org/api/classes/Models.Reflection.html)>\[] +[`UrlMapping`](../../types/interfaces/UrlMapping.md)\<[`Reflection`](https://typedoc.org/api/classes/Reflection.html)>\[] #### Overrides @@ -142,7 +131,7 @@ Maps the models of the given project to the desired output files. #### Defined in -[theme/markdown-theme.ts:71](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts#L71) +[theme/markdown-theme.ts:62](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts#L62) *** @@ -164,7 +153,7 @@ Map the models of the given project to a navigation structure. #### Defined in -[theme/markdown-theme.ts:78](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts#L78) +[theme/markdown-theme.ts:69](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts#L69) *** @@ -187,7 +176,7 @@ Map the models of the given project to a navigation structure. #### Defined in -[theme/markdown-theme.ts:85](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts#L85) +[theme/markdown-theme.ts:76](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts#L76) *** @@ -209,7 +198,7 @@ Map the models of the given project to a navigation structure. #### Defined in -[theme/markdown-theme.ts:209](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts#L209) +[theme/markdown-theme.ts:200](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts#L200) *** @@ -231,7 +220,7 @@ Map the models of the given project to a navigation structure. #### Defined in -[theme/markdown-theme.ts:216](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts#L216) +[theme/markdown-theme.ts:207](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts#L207) *** @@ -253,7 +242,7 @@ Map the models of the given project to a navigation structure. #### Defined in -[theme/markdown-theme.ts:223](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts#L223) +[theme/markdown-theme.ts:214](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts#L214) *** @@ -275,4 +264,4 @@ Map the models of the given project to a navigation structure. #### Defined in -[theme/markdown-theme.ts:230](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts#L230) +[theme/markdown-theme.ts:221](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts#L221) diff --git a/developer-docs/typedoc-plugin-markdown/theme/classes/MarkdownThemeContext.md b/devguide/typedoc-plugin-markdown/theme/classes/MarkdownThemeContext.md similarity index 84% rename from developer-docs/typedoc-plugin-markdown/theme/classes/MarkdownThemeContext.md rename to devguide/typedoc-plugin-markdown/theme/classes/MarkdownThemeContext.md index d9e8a517..774dbd88 100644 --- a/developer-docs/typedoc-plugin-markdown/theme/classes/MarkdownThemeContext.md +++ b/devguide/typedoc-plugin-markdown/theme/classes/MarkdownThemeContext.md @@ -1,8 +1,9 @@ -[Packages Index](../../../README.md) / [typedoc-plugin-markdown](../../README.md) / [theme](../README.md) / MarkdownThemeContext +[Home](../../../README.md) / [typedoc-plugin-markdown](../../README.md) / [theme](../README.md) / MarkdownThemeContext # Class: MarkdownThemeContext The theme context class that is provided as context on the rendering of every page. + It is heavily influenced by the equivalent [DefaultThemeRenderContext](https://typedoc.org/api/classes/DefaultThemeRenderContext.html) from the default theme. This class can be used to customize the theme output by extending the class and overriding the templates, partials and helpers. @@ -116,11 +117,11 @@ This class can be used to customize the theme output by extending the class and #### Parameters -| Parameter | Type | Description | -| --------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------- | -| `theme` | [`MarkdownTheme`](MarkdownTheme.md) | The theme instance. | -| `page` | [`MarkdownPageEvent`](../../events/classes/MarkdownPageEvent.md)\<[`Reflection`](https://typedoc.org/api/classes/Models.Reflection.html)> | The current page event. | -| `options` | [`Options`](https://typedoc.org/api/classes/Configuration.Options.html) | The options provided to the application. | +| Parameter | Type | Description | +| --------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------- | +| `theme` | [`MarkdownTheme`](MarkdownTheme.md) | The theme instance. | +| `page` | [`MarkdownPageEvent`](../../events/classes/MarkdownPageEvent.md)\<[`Reflection`](https://typedoc.org/api/classes/Reflection.html)> | The current page event. | +| `options` | [`Options`](https://typedoc.org/api/types/Configuration.Options.html) | The options provided to the application. | #### Returns @@ -128,7 +129,7 @@ This class can be used to customize the theme output by extending the class and #### Defined in -[theme/markdown-theme-context.ts:45](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts#L45) +[theme/markdown-themeContext.ts:48](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/theme/markdown-themeContext.ts#L48) ## Properties @@ -140,7 +141,7 @@ Properties are passed into the constructor and are used to provide context to th #### Defined in -[theme/markdown-theme-context.ts:39](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts#L39) +[theme/markdown-themeContext.ts:42](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/theme/markdown-themeContext.ts#L42) *** @@ -150,7 +151,7 @@ Properties are passed into the constructor and are used to provide context to th #### Defined in -[theme/markdown-theme-context.ts:40](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts#L40) +[theme/markdown-themeContext.ts:43](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/theme/markdown-themeContext.ts#L43) *** @@ -162,31 +163,31 @@ The theme instance. #### Defined in -[theme/markdown-theme-context.ts:49](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts#L49) +[theme/markdown-themeContext.ts:52](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/theme/markdown-themeContext.ts#L52) *** ### page -> `readonly` **page**: [`MarkdownPageEvent`](../../events/classes/MarkdownPageEvent.md)\<[`Reflection`](https://typedoc.org/api/classes/Models.Reflection.html)> +> `readonly` **page**: [`MarkdownPageEvent`](../../events/classes/MarkdownPageEvent.md)\<[`Reflection`](https://typedoc.org/api/classes/Reflection.html)> The current page event. #### Defined in -[theme/markdown-theme-context.ts:53](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts#L53) +[theme/markdown-themeContext.ts:56](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/theme/markdown-themeContext.ts#L56) *** ### options -> `readonly` **options**: [`Options`](https://typedoc.org/api/classes/Configuration.Options.html) +> `readonly` **options**: [`Options`](https://typedoc.org/api/types/Configuration.Options.html) The options provided to the application. #### Defined in -[theme/markdown-theme-context.ts:57](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts#L57) +[theme/markdown-themeContext.ts:60](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/theme/markdown-themeContext.ts#L60) *** @@ -200,7 +201,7 @@ This is required for generating package specific documentation. #### Defined in -[theme/markdown-theme-context.ts:69](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts#L69) +[theme/markdown-themeContext.ts:72](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/theme/markdown-themeContext.ts#L72) ## Methods @@ -226,7 +227,7 @@ Returns the package meta data for a given package name when entrypointStrategy i #### Defined in -[theme/markdown-theme-context.ts:119](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts#L119) +[theme/markdown-themeContext.ts:122](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/theme/markdown-themeContext.ts#L122) *** @@ -251,7 +252,7 @@ If public path is set, it will be used as the base URL. #### Defined in -[theme/markdown-theme-context.ts:131](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts#L131) +[theme/markdown-themeContext.ts:134](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/theme/markdown-themeContext.ts#L134) *** @@ -275,7 +276,7 @@ Hook into the TypeDoc rendering system. #### Defined in -[theme/markdown-theme-context.ts:161](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts#L161) +[theme/markdown-themeContext.ts:164](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/theme/markdown-themeContext.ts#L164) ## Resources @@ -355,7 +356,7 @@ Template that maps to individual reflection models. #### Defined in -[theme/markdown-theme-context.ts:77](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts#L77) +[theme/markdown-themeContext.ts:80](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/theme/markdown-themeContext.ts#L80) *** @@ -385,14 +386,14 @@ Partials are categorised by their use: ##### Parameters -| Parameter | Type | -| ------------------------ | -------------------------------------------------------------- | -| `model` | [`Comment`](https://typedoc.org/api/types/Models.Comment.html) | -| `options` | `object` | -| `options.headingLevel`? | `number` | -| `options.showSummary`? | `boolean` | -| `options.showTags`? | `boolean` | -| `options.isTableColumn`? | `boolean` | +| Parameter | Type | +| ------------------------ | ---------------------------------------------------------------- | +| `model` | [`Comment`](https://typedoc.org/api/classes/Models.Comment.html) | +| `options` | `object` | +| `options.headingLevel`? | `number` | +| `options.showSummary`? | `boolean` | +| `options.showTags`? | `boolean` | +| `options.isTableColumn`? | `boolean` | ##### Returns @@ -404,9 +405,9 @@ Partials are categorised by their use: ##### Parameters -| Parameter | Type | -| --------- | --------------------------------------------------------------------------------------- | -| `model` | [`CommentDisplayPart`](https://typedoc.org/api/types/Models.CommentDisplayPart.html)\[] | +| Parameter | Type | +| --------- | ----------------------------------------------------------------------------------------- | +| `model` | [`CommentDisplayPart`](https://typedoc.org/api/classes/Models.CommentDisplayPart.html)\[] | ##### Returns @@ -434,11 +435,11 @@ Partials are categorised by their use: ##### Parameters -| Parameter | Type | -| ---------------------- | --------------------------------------------------------------------------------------- | -| `model` | [`ReflectionCategory`](https://typedoc.org/api/types/Models.ReflectionCategory.html)\[] | -| `options` | `object` | -| `options.headingLevel` | `number` | +| Parameter | Type | +| ---------------------- | -------------------------------------------------------------------------------------------------- | +| `model` | [`ReflectionCategory`](https://typedoc.org/api/types/ReflectionCategory.DeclarationOption.html)\[] | +| `options` | `object` | +| `options.headingLevel` | `number` | ##### Returns @@ -450,12 +451,12 @@ Partials are categorised by their use: ##### Parameters -| Parameter | Type | -| ---------------------- | ----------------------------------------------------------------------------------- | -| `model` | [`ReflectionGroup`](https://typedoc.org/api/classes/Models.ReflectionGroup.html)\[] | -| `options` | `object` | -| `options.headingLevel` | `number` | -| `options.kind` | [`ReflectionKind`](https://typedoc.org/api/enums/Models.ReflectionKind-1.html) | +| Parameter | Type | +| ---------------------- | ------------------------------------------------------------------------------ | +| `model` | [`ReflectionGroup`](https://typedoc.org/api/classes/ReflectionGroup.html)\[] | +| `options` | `object` | +| `options.headingLevel` | `number` | +| `options.kind` | [`ReflectionKind`](https://typedoc.org/api/enums/Models.ReflectionKind-1.html) | ##### Returns @@ -609,9 +610,9 @@ Partials are categorised by their use: ##### Parameters -| Parameter | Type | -| --------- | ---------------------------------------------------------------------------------------- | -| `model` | [`SignatureReflection`](https://typedoc.org/api/classes/Models.SignatureReflection.html) | +| Parameter | Type | +| --------- | --------------------------------------------------------------------------------- | +| `model` | [`SignatureReflection`](https://typedoc.org/api/classes/SignatureReflection.html) | ##### Returns @@ -623,11 +624,11 @@ Partials are categorised by their use: ##### Parameters -| Parameter | Type | -| ---------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `model` | [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html) \| [`SignatureReflection`](https://typedoc.org/api/classes/Models.SignatureReflection.html) | -| `options` | `object` | -| `options.headingLevel` | `number` | +| Parameter | Type | +| ---------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `model` | [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html) \| [`SignatureReflection`](https://typedoc.org/api/classes/SignatureReflection.html) | +| `options` | `object` | +| `options.headingLevel` | `number` | ##### Returns @@ -671,9 +672,9 @@ Renders a top-level member that contains group and child members such as Classes ##### Parameters -| Parameter | Type | -| --------- | ------------------------------------------------------------------------------------------- | -| `model` | [`ParameterReflection`](https://typedoc.org/api/classes/Models.ParameterReflection.html)\[] | +| Parameter | Type | +| --------- | ------------------------------------------------------------------------------------ | +| `model` | [`ParameterReflection`](https://typedoc.org/api/classes/ParameterReflection.html)\[] | ##### Returns @@ -685,9 +686,9 @@ Renders a top-level member that contains group and child members such as Classes ##### Parameters -| Parameter | Type | -| --------- | ------------------------------------------------------------------------------------------- | -| `model` | [`ParameterReflection`](https://typedoc.org/api/classes/Models.ParameterReflection.html)\[] | +| Parameter | Type | +| --------- | ------------------------------------------------------------------------------------ | +| `model` | [`ParameterReflection`](https://typedoc.org/api/classes/ParameterReflection.html)\[] | ##### Returns @@ -719,9 +720,9 @@ There is no association list partial for properties as these are handled as a st ##### Parameters -| Parameter | Type | -| --------- | ---------------------------------------------------------------------------------------- | -| `model` | [`ReferenceReflection`](https://typedoc.org/api/classes/Models.ReferenceReflection.html) | +| Parameter | Type | +| --------- | --------------------------------------------------------------------------------- | +| `model` | [`ReferenceReflection`](https://typedoc.org/api/classes/ReferenceReflection.html) | ##### Returns @@ -749,14 +750,14 @@ There is no association list partial for properties as these are handled as a st ##### Parameters -| Parameter | Type | -| ----------------------------- | ---------------------------------------------------------------------------------------- | -| `model` | [`SignatureReflection`](https://typedoc.org/api/classes/Models.SignatureReflection.html) | -| `options` | `object` | -| `options.headingLevel` | `number` | -| `options.nested`? | `boolean` | -| `options.accessor`? | `string` | -| `options.multipleSignatures`? | `boolean` | +| Parameter | Type | +| ----------------------------- | --------------------------------------------------------------------------------- | +| `model` | [`SignatureReflection`](https://typedoc.org/api/classes/SignatureReflection.html) | +| `options` | `object` | +| `options.headingLevel` | `number` | +| `options.nested`? | `boolean` | +| `options.accessor`? | `string` | +| `options.multipleSignatures`? | `boolean` | ##### Returns @@ -768,9 +769,9 @@ There is no association list partial for properties as these are handled as a st ##### Parameters -| Parameter | Type | -| --------- | ------------------------------------------------------------------------------------------- | -| `model` | [`ParameterReflection`](https://typedoc.org/api/classes/Models.ParameterReflection.html)\[] | +| Parameter | Type | +| --------- | ------------------------------------------------------------------------------------ | +| `model` | [`ParameterReflection`](https://typedoc.org/api/classes/ParameterReflection.html)\[] | ##### Returns @@ -782,11 +783,11 @@ There is no association list partial for properties as these are handled as a st ##### Parameters -| Parameter | Type | -| ---------------------- | ---------------------------------------------------------------------------------------- | -| `model` | [`SignatureReflection`](https://typedoc.org/api/classes/Models.SignatureReflection.html) | -| `options` | `object` | -| `options.headingLevel` | `number` | +| Parameter | Type | +| ---------------------- | --------------------------------------------------------------------------------- | +| `model` | [`SignatureReflection`](https://typedoc.org/api/classes/SignatureReflection.html) | +| `options` | `object` | +| `options.headingLevel` | `number` | ##### Returns @@ -798,12 +799,12 @@ There is no association list partial for properties as these are handled as a st ##### Parameters -| Parameter | Type | -| ---------------------- | ---------------------------------------------------------------------------------------- | -| `model` | [`SignatureReflection`](https://typedoc.org/api/classes/Models.SignatureReflection.html) | -| `options`? | `object` | -| `options.accessor`? | `string` | -| `options.includeType`? | `boolean` | +| Parameter | Type | +| ---------------------- | --------------------------------------------------------------------------------- | +| `model` | [`SignatureReflection`](https://typedoc.org/api/classes/SignatureReflection.html) | +| `options`? | `object` | +| `options.accessor`? | `string` | +| `options.includeType`? | `boolean` | ##### Returns @@ -832,11 +833,11 @@ There is no association list partial for properties as these are handled as a st ##### Parameters -| Parameter | Type | -| ---------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `model` | [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html) \| [`SignatureReflection`](https://typedoc.org/api/classes/Models.SignatureReflection.html) | -| `options` | `object` | -| `options.headingLevel` | `number` | +| Parameter | Type | +| ---------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `model` | [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html) \| [`SignatureReflection`](https://typedoc.org/api/classes/SignatureReflection.html) | +| `options` | `object` | +| `options.headingLevel` | `number` | ##### Returns @@ -865,9 +866,9 @@ There is no association list partial for properties as these are handled as a st ##### Parameters -| Parameter | Type | -| --------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | -| `model` | [`ReferenceType`](https://typedoc.org/api/classes/Models.ReferenceType.html) \| [`ArrayType`](https://typedoc.org/api/types/Models.ArrayType.html) | +| Parameter | Type | +| --------- | --------------------------------------------------------------------------------------------------------------------------------------------- | +| `model` | [`ReferenceType`](https://typedoc.org/api/classes/ReferenceType.html) \| [`ArrayType`](https://typedoc.org/api/classes/Models.ArrayType.html) | ##### Returns @@ -879,11 +880,11 @@ There is no association list partial for properties as these are handled as a st ##### Parameters -| Parameter | Type | -| ------------------------ | --------------------------------------------------------------------- | -| `model` | [`SomeType`](https://typedoc.org/api/classes/Models.SomeType.html)\[] | -| `options`? | `object` | -| `options.forceCollapse`? | `boolean` | +| Parameter | Type | +| ------------------------ | -------------------------------------------------------------- | +| `model` | [`SomeType`](https://typedoc.org/api/classes/SomeType.html)\[] | +| `options`? | `object` | +| `options.forceCollapse`? | `boolean` | ##### Returns @@ -943,9 +944,9 @@ There is no association list partial for properties as these are handled as a st ##### Parameters -| Parameter | Type | -| --------- | --------------------------------------------------------------------------------------------------- | -| `model` | [`TypeParameterReflection`](https://typedoc.org/api/classes/Models.TypeParameterReflection.html)\[] | +| Parameter | Type | +| --------- | -------------------------------------------------------------------------------------------- | +| `model` | [`TypeParameterReflection`](https://typedoc.org/api/classes/TypeParameterReflection.html)\[] | ##### Returns @@ -957,9 +958,9 @@ There is no association list partial for properties as these are handled as a st ##### Parameters -| Parameter | Type | -| --------- | --------------------------------------------------------------------------------------------------- | -| `model` | [`TypeParameterReflection`](https://typedoc.org/api/classes/Models.TypeParameterReflection.html)\[] | +| Parameter | Type | +| --------- | -------------------------------------------------------------------------------------------- | +| `model` | [`TypeParameterReflection`](https://typedoc.org/api/classes/TypeParameterReflection.html)\[] | ##### Returns @@ -1017,9 +1018,9 @@ There is no association list partial for properties as these are handled as a st ##### Parameters -| Parameter | Type | -| --------- | ------------------------------------------------------------------ | -| `model` | [`ArrayType`](https://typedoc.org/api/types/Models.ArrayType.html) | +| Parameter | Type | +| --------- | -------------------------------------------------------------------- | +| `model` | [`ArrayType`](https://typedoc.org/api/classes/Models.ArrayType.html) | ##### Returns @@ -1031,9 +1032,9 @@ There is no association list partial for properties as these are handled as a st ##### Parameters -| Parameter | Type | -| --------- | ------------------------------------------------------------------------------ | -| `model` | [`ConditionalType`](https://typedoc.org/api/types/Models.ConditionalType.html) | +| Parameter | Type | +| --------- | -------------------------------------------------------------------------------- | +| `model` | [`ConditionalType`](https://typedoc.org/api/classes/Models.ConditionalType.html) | ##### Returns @@ -1045,9 +1046,9 @@ There is no association list partial for properties as these are handled as a st ##### Parameters -| Parameter | Type | -| --------- | ---------------------------------------------------------------------------------- | -| `model` | [`IndexedAccessType`](https://typedoc.org/api/types/Models.IndexedAccessType.html) | +| Parameter | Type | +| --------- | --------------------------------------------------------------------------------------------- | +| `model` | [`IndexedAccessType`](https://typedoc.org/api/types/IndexedAccessType.DeclarationOption.html) | ##### Returns @@ -1059,9 +1060,9 @@ There is no association list partial for properties as these are handled as a st ##### Parameters -| Parameter | Type | -| --------- | ------------------------------------------------------------------------ | -| `model` | [`InferredType`](https://typedoc.org/api/types/Models.InferredType.html) | +| Parameter | Type | +| --------- | ----------------------------------------------------------------------------------- | +| `model` | [`InferredType`](https://typedoc.org/api/types/InferredType.DeclarationOption.html) | ##### Returns @@ -1073,9 +1074,9 @@ There is no association list partial for properties as these are handled as a st ##### Parameters -| Parameter | Type | -| --------- | -------------------------------------------------------------------------------- | -| `model` | [`IntersectionType`](https://typedoc.org/api/types/Models.IntersectionType.html) | +| Parameter | Type | +| --------- | ------------------------------------------------------------------------------------------- | +| `model` | [`IntersectionType`](https://typedoc.org/api/types/IntersectionType.DeclarationOption.html) | ##### Returns @@ -1087,9 +1088,9 @@ There is no association list partial for properties as these are handled as a st ##### Parameters -| Parameter | Type | -| --------- | -------------------------------------------------------------------------- | -| `model` | [`IntrinsicType`](https://typedoc.org/api/types/Models.IntrinsicType.html) | +| Parameter | Type | +| --------- | ------------------------------------------------------------------------------------- | +| `model` | [`IntrinsicType`](https://typedoc.org/api/types/IntrinsicType.DeclarationOption.html) | ##### Returns @@ -1101,9 +1102,9 @@ There is no association list partial for properties as these are handled as a st ##### Parameters -| Parameter | Type | -| --------- | ---------------------------------------------------------------------- | -| `model` | [`LiteralType`](https://typedoc.org/api/types/Models.LiteralType.html) | +| Parameter | Type | +| --------- | --------------------------------------------------------------------------------- | +| `model` | [`LiteralType`](https://typedoc.org/api/types/LiteralType.DeclarationOption.html) | ##### Returns @@ -1115,9 +1116,9 @@ There is no association list partial for properties as these are handled as a st ##### Parameters -| Parameter | Type | -| --------- | -------------------------------------------------------------------------------- | -| `model` | [`NamedTupleMember`](https://typedoc.org/api/types/Models.NamedTupleMember.html) | +| Parameter | Type | +| --------- | ------------------------------------------------------------------------------------------- | +| `model` | [`NamedTupleMember`](https://typedoc.org/api/types/NamedTupleMember.DeclarationOption.html) | ##### Returns @@ -1129,9 +1130,9 @@ There is no association list partial for properties as these are handled as a st ##### Parameters -| Parameter | Type | -| --------- | ------------------------------------------------------------------ | -| `model` | [`QueryType`](https://typedoc.org/api/types/Models.QueryType.html) | +| Parameter | Type | +| --------- | -------------------------------------------------------------------- | +| `model` | [`QueryType`](https://typedoc.org/api/classes/Models.QueryType.html) | ##### Returns @@ -1143,9 +1144,9 @@ There is no association list partial for properties as these are handled as a st ##### Parameters -| Parameter | Type | -| --------- | ---------------------------------------------------------------------------- | -| `model` | [`ReferenceType`](https://typedoc.org/api/classes/Models.ReferenceType.html) | +| Parameter | Type | +| --------- | --------------------------------------------------------------------- | +| `model` | [`ReferenceType`](https://typedoc.org/api/classes/ReferenceType.html) | ##### Returns @@ -1171,11 +1172,11 @@ There is no association list partial for properties as these are handled as a st ##### Parameters -| Parameter | Type | -| ----------------------------- | ------------------------------------------------------------------------------------------- | -| `model` | [`SignatureReflection`](https://typedoc.org/api/classes/Models.SignatureReflection.html)\[] | -| `options`? | `object` | -| `options.forceParameterType`? | `boolean` | +| Parameter | Type | +| ----------------------------- | ------------------------------------------------------------------------------------ | +| `model` | [`SignatureReflection`](https://typedoc.org/api/classes/SignatureReflection.html)\[] | +| `options`? | `object` | +| `options.forceParameterType`? | `boolean` | ##### Returns @@ -1187,11 +1188,11 @@ There is no association list partial for properties as these are handled as a st ##### Parameters -| Parameter | Type | -| ------------------------ | ------------------------------------------------------------------------------ | -| `model` | [`ReflectionType`](https://typedoc.org/api/classes/Models.ReflectionType.html) | -| `options`? | `object` | -| `options.forceCollapse`? | `boolean` | +| Parameter | Type | +| ------------------------ | ----------------------------------------------------------------------- | +| `model` | [`ReflectionType`](https://typedoc.org/api/classes/ReflectionType.html) | +| `options`? | `object` | +| `options.forceCollapse`? | `boolean` | ##### Returns @@ -1203,9 +1204,9 @@ There is no association list partial for properties as these are handled as a st ##### Parameters -| Parameter | Type | -| --------- | ------------------------------------------------------------------ | -| `model`? | [`SomeType`](https://typedoc.org/api/classes/Models.SomeType.html) | +| Parameter | Type | +| --------- | ----------------------------------------------------------- | +| `model`? | [`SomeType`](https://typedoc.org/api/classes/SomeType.html) | ##### Returns @@ -1217,9 +1218,9 @@ There is no association list partial for properties as these are handled as a st ##### Parameters -| Parameter | Type | -| --------- | -------------------------------------------------------------------- | -| `model` | [`TupleType`](https://typedoc.org/api/classes/Models.TupleType.html) | +| Parameter | Type | +| --------- | ------------------------------------------------------------- | +| `model` | [`TupleType`](https://typedoc.org/api/classes/TupleType.html) | ##### Returns @@ -1231,9 +1232,9 @@ There is no association list partial for properties as these are handled as a st ##### Parameters -| Parameter | Type | -| --------- | ------------------------------------------------------------------------------ | -| `model` | [`TypeOperatorType`](https://typedoc.org/api/interfaces/TypeOperatorType.html) | +| Parameter | Type | +| --------- | ------------------------------------------------------------------------------------------------- | +| `model` | [`TypeOperatorType`](https://typedoc.org/api/TypeDocOptions,TypeOperatorType/TypeDocOptions.html) | ##### Returns @@ -1245,9 +1246,9 @@ There is no association list partial for properties as these are handled as a st ##### Parameters -| Parameter | Type | -| --------- | ------------------------------------------------------------------ | -| `model` | [`UnionType`](https://typedoc.org/api/types/Models.UnionType.html) | +| Parameter | Type | +| --------- | ----------------------------------------------------------------------------- | +| `model` | [`UnionType`](https://typedoc.org/api/types/UnionType.DeclarationOption.html) | ##### Returns @@ -1259,9 +1260,9 @@ There is no association list partial for properties as these are handled as a st ##### Parameters -| Parameter | Type | -| --------- | ---------------------------------------------------------------------- | -| `model` | [`UnknownType`](https://typedoc.org/api/types/Models.UnknownType.html) | +| Parameter | Type | +| --------- | --------------------------------------------------------------------------------- | +| `model` | [`UnknownType`](https://typedoc.org/api/types/UnknownType.DeclarationOption.html) | ##### Returns @@ -1269,7 +1270,7 @@ There is no association list partial for properties as these are handled as a st #### Defined in -[theme/markdown-theme-context.ts:97](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts#L97) +[theme/markdown-themeContext.ts:100](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/theme/markdown-themeContext.ts#L100) *** @@ -1291,9 +1292,9 @@ Please note that partials: ##### Parameters -| Parameter | Type | -| --------- | --------------------------------------------------------------------------------------- | -| `model` | [`CommentDisplayPart`](https://typedoc.org/api/types/Models.CommentDisplayPart.html)\[] | +| Parameter | Type | +| --------- | ----------------------------------------------------------------------------------------- | +| `model` | [`CommentDisplayPart`](https://typedoc.org/api/classes/Models.CommentDisplayPart.html)\[] | ##### Returns @@ -1301,7 +1302,7 @@ Please note that partials: #### getDeclarationType() -> **getDeclarationType**: (`model`) => `undefined` | [`SomeType`](https://typedoc.org/api/classes/Models.SomeType.html) +> **getDeclarationType**: (`model`) => `undefined` | [`SomeType`](https://typedoc.org/api/classes/SomeType.html) ##### Parameters @@ -1311,7 +1312,7 @@ Please note that partials: ##### Returns -`undefined` | [`SomeType`](https://typedoc.org/api/classes/Models.SomeType.html) +`undefined` | [`SomeType`](https://typedoc.org/api/classes/SomeType.html) #### getDescriptionForReflection() @@ -1378,9 +1379,9 @@ Please note that partials: ##### Parameters -| Parameter | Type | -| --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `group` | [`ReflectionCategory`](https://typedoc.org/api/types/Models.ReflectionCategory.html) \| [`ReflectionGroup`](https://typedoc.org/api/classes/Models.ReflectionGroup.html) | +| Parameter | Type | +| --------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `group` | [`ReflectionCategory`](https://typedoc.org/api/types/ReflectionCategory.DeclarationOption.html) \| [`ReflectionGroup`](https://typedoc.org/api/classes/ReflectionGroup.html) | ##### Returns @@ -1392,11 +1393,11 @@ Please note that partials: ##### Parameters -| Parameter | Type | -| ------------------- | ------------------------------------------------------------------ | -| `model` | [`SomeType`](https://typedoc.org/api/classes/Models.SomeType.html) | -| `options`? | `object` | -| `options.isTarget`? | `boolean` | +| Parameter | Type | +| ------------------- | ----------------------------------------------------------- | +| `model` | [`SomeType`](https://typedoc.org/api/classes/SomeType.html) | +| `options`? | `object` | +| `options.isTarget`? | `boolean` | ##### Returns @@ -1436,9 +1437,9 @@ Please note that partials: ##### Parameters -| Parameter | Type | -| --------- | ---------------------------------------------------------------------------------------- | -| `model` | [`ParameterReflection`](https://typedoc.org/api/classes/Models.ParameterReflection.html) | +| Parameter | Type | +| --------- | --------------------------------------------------------------------------------- | +| `model` | [`ParameterReflection`](https://typedoc.org/api/classes/ParameterReflection.html) | ##### Returns @@ -1450,10 +1451,10 @@ Please note that partials: ##### Parameters -| Parameter | Type | -| ------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------- | -| `stringWithPlaceholders` | `string` | -| `page` | [`MarkdownPageEvent`](../../events/classes/MarkdownPageEvent.md)\<[`Reflection`](https://typedoc.org/api/classes/Models.Reflection.html)> | +| Parameter | Type | +| ------------------------ | ---------------------------------------------------------------------------------------------------------------------------------- | +| `stringWithPlaceholders` | `string` | +| `page` | [`MarkdownPageEvent`](../../events/classes/MarkdownPageEvent.md)\<[`Reflection`](https://typedoc.org/api/classes/Reflection.html)> | ##### Returns @@ -1479,9 +1480,9 @@ Please note that partials: ##### Parameters -| Parameter | Type | -| ----------------- | -------------------------------------------------------------------------------- | -| `reflectionFlags` | [`ReflectionFlags`](https://typedoc.org/api/classes/Models.ReflectionFlags.html) | +| Parameter | Type | +| ----------------- | ------------------------------------------------------------------------- | +| `reflectionFlags` | [`ReflectionFlags`](https://typedoc.org/api/classes/ReflectionFlags.html) | ##### Returns @@ -1493,9 +1494,9 @@ Please note that partials: ##### Parameters -| Parameter | Type | -| --------- | ------------------------------------------------------------------ | -| `model`? | [`SomeType`](https://typedoc.org/api/classes/Models.SomeType.html) | +| Parameter | Type | +| --------- | ----------------------------------------------------------- | +| `model`? | [`SomeType`](https://typedoc.org/api/classes/SomeType.html) | ##### Returns @@ -1507,9 +1508,9 @@ Please note that partials: ##### Parameters -| Parameter | Type | -| --------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `model` | [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html) \| [`SignatureReflection`](https://typedoc.org/api/classes/Models.SignatureReflection.html) | +| Parameter | Type | +| --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `model` | [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html) \| [`SignatureReflection`](https://typedoc.org/api/classes/SignatureReflection.html) | ##### Returns @@ -1532,4 +1533,4 @@ Please note that partials: #### Defined in -[theme/markdown-theme-context.ts:110](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts#L110) +[theme/markdown-themeContext.ts:113](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/theme/markdown-themeContext.ts#L113) diff --git a/developer-docs/typedoc-plugin-markdown/types/README.md b/devguide/typedoc-plugin-markdown/types/README.md similarity index 96% rename from developer-docs/typedoc-plugin-markdown/types/README.md rename to devguide/typedoc-plugin-markdown/types/README.md index ed4830b3..e95d1421 100644 --- a/developer-docs/typedoc-plugin-markdown/types/README.md +++ b/devguide/typedoc-plugin-markdown/types/README.md @@ -1,4 +1,4 @@ -[Packages Index](../../README.md) / [typedoc-plugin-markdown](../README.md) / types +[Home](../../README.md) / [typedoc-plugin-markdown](../README.md) / types # types @@ -11,7 +11,7 @@ All plugin types are exported from this module. | Interface | Description | | ------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------- | | [TranslatableStrings](interfaces/TranslatableStrings.md) | The model of translatable strings specific to the Markdown theme. | -| [MarkdownApplication](interfaces/MarkdownApplication.md) | This interface is essentially an extended typing of TypeDoc's [`Application`](https://typedoc.org/api/classes/Application.html) instance. | +| [MarkdownApplication](interfaces/MarkdownApplication.md) | This interface is essentially an extended typing of TypeDoc's [`Application`](https://typedoc.org/api/classes/Application.html) instance.\`\` | | [MarkdownRendererHooks](interfaces/MarkdownRendererHooks.md) | Describes the hooks available to inject output in the markdown theme. | | [MarkdownRenderer](interfaces/MarkdownRenderer.md) | An extended typing of TypeDoc's [`Renderer`](https://typedoc.org/api/classes/Renderer.html) class that includes updated typings for hooks and async jobs. | | [PluginOptions](interfaces/PluginOptions.md) | Describes the options declared by the plugin. | diff --git a/developer-docs/typedoc-plugin-markdown/types/interfaces/MarkdownApplication.md b/devguide/typedoc-plugin-markdown/types/interfaces/MarkdownApplication.md similarity index 53% rename from developer-docs/typedoc-plugin-markdown/types/interfaces/MarkdownApplication.md rename to devguide/typedoc-plugin-markdown/types/interfaces/MarkdownApplication.md index 357e03e2..f0c433b0 100644 --- a/developer-docs/typedoc-plugin-markdown/types/interfaces/MarkdownApplication.md +++ b/devguide/typedoc-plugin-markdown/types/interfaces/MarkdownApplication.md @@ -1,8 +1,8 @@ -[Packages Index](../../../README.md) / [typedoc-plugin-markdown](../../README.md) / [types](../README.md) / MarkdownApplication +[Home](../../../README.md) / [typedoc-plugin-markdown](../../README.md) / [types](../README.md) / MarkdownApplication # Interface: MarkdownApplication -This interface is essentially an extended typing of TypeDoc's [`Application`](https://typedoc.org/api/classes/Application.html) instance. +This interface is essentially an extended typing of TypeDoc's [`Application`](https://typedoc.org/api/classes/Application.html) instance.\`\` ## Contents @@ -10,16 +10,6 @@ This interface is essentially an extended typing of TypeDoc's [`Application`](ht * [Properties](#properties) * [renderer](#renderer) -## Example - -```ts -import { MarkdownApplication } from 'typedoc-plugin-markdown'; - -export function load(app: MarkdownApplication) { - ... -} -``` - ## Extends * [`Application`](https://typedoc.org/api/classes/Application.html) @@ -38,4 +28,4 @@ Re-types the `renderer` instance to [`MarkdownRenderer`](MarkdownRenderer.md). #### Defined in -[types/markdown-application.ts:22](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-markdown/src/types/markdown-application.ts#L22) +[types/markdown-application.ts:11](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/types/markdown-application.ts#L11) diff --git a/developer-docs/typedoc-plugin-markdown/types/interfaces/MarkdownRenderer.md b/devguide/typedoc-plugin-markdown/types/interfaces/MarkdownRenderer.md similarity index 55% rename from developer-docs/typedoc-plugin-markdown/types/interfaces/MarkdownRenderer.md rename to devguide/typedoc-plugin-markdown/types/interfaces/MarkdownRenderer.md index fe473186..2d460ddd 100644 --- a/developer-docs/typedoc-plugin-markdown/types/interfaces/MarkdownRenderer.md +++ b/devguide/typedoc-plugin-markdown/types/interfaces/MarkdownRenderer.md @@ -1,4 +1,4 @@ -[Packages Index](../../../README.md) / [typedoc-plugin-markdown](../../README.md) / [types](../README.md) / MarkdownRenderer +[Home](../../../README.md) / [typedoc-plugin-markdown](../../README.md) / [types](../README.md) / MarkdownRenderer # Interface: MarkdownRenderer @@ -14,28 +14,6 @@ An extended typing of TypeDoc's [`Renderer`](https://typedoc.org/api/classes/Ren * [preRenderAsyncJobs](#prerenderasyncjobs) * [postRenderAsyncJobs](#postrenderasyncjobs) -## Example - -```ts -import { MarkdownApplication } from 'typedoc-plugin-markdown'; - -export function load(app: MarkdownApplication) { - -app.renderer.markdownHooks.on( - 'page.begin', () => '> This is some markdown at the top of the page', -); - -app.renderer.preRenderAsyncJobs.push(async (output: MarkdownRendererEvent) => { - await doSomethingAsync(output); -}); - -app.renderer.postRenderAsyncJobs.push(async (output: MarkdownRendererEvent)) => { - await doSomethingAsync(output); -}); - -} -``` - ## Extends * [`Renderer`](https://typedoc.org/api/classes/Renderer.html) @@ -50,7 +28,7 @@ Replaces the event hooks typings the [`MarkdownRendererHooks`](MarkdownRendererH #### Defined in -[types/markdown-renderer.ts:36](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-markdown/src/types/markdown-renderer.ts#L36) +[types/markdown-renderer.ts:13](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/types/markdown-renderer.ts#L13) *** @@ -62,7 +40,7 @@ Replaces the event hooks typings the [`MarkdownRendererHooks`](MarkdownRendererH #### Defined in -[types/markdown-renderer.ts:38](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-markdown/src/types/markdown-renderer.ts#L38) +[types/markdown-renderer.ts:15](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/types/markdown-renderer.ts#L15) *** @@ -89,7 +67,7 @@ Replaces the event hooks typings the [`MarkdownRendererHooks`](MarkdownRendererH #### Defined in -[types/markdown-renderer.ts:40](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-markdown/src/types/markdown-renderer.ts#L40) +[types/markdown-renderer.ts:17](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/types/markdown-renderer.ts#L17) *** @@ -105,7 +83,7 @@ Re-types the returned argument argument to [`MarkdownRendererEvent`](../../event #### Defined in -[types/markdown-renderer.ts:47](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-markdown/src/types/markdown-renderer.ts#L47) +[types/markdown-renderer.ts:24](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/types/markdown-renderer.ts#L24) *** @@ -121,4 +99,4 @@ Re-types the returned argument argument to [`MarkdownRendererEvent`](../../event #### Defined in -[types/markdown-renderer.ts:51](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-markdown/src/types/markdown-renderer.ts#L51) +[types/markdown-renderer.ts:28](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/types/markdown-renderer.ts#L28) diff --git a/developer-docs/typedoc-plugin-markdown/types/interfaces/MarkdownRendererHooks.md b/devguide/typedoc-plugin-markdown/types/interfaces/MarkdownRendererHooks.md similarity index 65% rename from developer-docs/typedoc-plugin-markdown/types/interfaces/MarkdownRendererHooks.md rename to devguide/typedoc-plugin-markdown/types/interfaces/MarkdownRendererHooks.md index 419398ef..3bba453c 100644 --- a/developer-docs/typedoc-plugin-markdown/types/interfaces/MarkdownRendererHooks.md +++ b/devguide/typedoc-plugin-markdown/types/interfaces/MarkdownRendererHooks.md @@ -1,4 +1,4 @@ -[Packages Index](../../../README.md) / [typedoc-plugin-markdown](../../README.md) / [types](../README.md) / MarkdownRendererHooks +[Home](../../../README.md) / [typedoc-plugin-markdown](../../README.md) / [types](../README.md) / MarkdownRendererHooks # Interface: MarkdownRendererHooks @@ -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/352ce41370cee18034e72b7c2f3874bbfe56f96f/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/7934b23566f374f44fe6de5fd9240ab185bf799f/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/352ce41370cee18034e72b7c2f3874bbfe56f96f/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/7934b23566f374f44fe6de5fd9240ab185bf799f/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/352ce41370cee18034e72b7c2f3874bbfe56f96f/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/7934b23566f374f44fe6de5fd9240ab185bf799f/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/352ce41370cee18034e72b7c2f3874bbfe56f96f/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/7934b23566f374f44fe6de5fd9240ab185bf799f/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/352ce41370cee18034e72b7c2f3874bbfe56f96f/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/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/types/markdown-renderer-hooks.ts#L40) diff --git a/developer-docs/typedoc-plugin-markdown/types/interfaces/NavigationItem.md b/devguide/typedoc-plugin-markdown/types/interfaces/NavigationItem.md similarity index 70% rename from developer-docs/typedoc-plugin-markdown/types/interfaces/NavigationItem.md rename to devguide/typedoc-plugin-markdown/types/interfaces/NavigationItem.md index 3837ee2e..96116fda 100644 --- a/developer-docs/typedoc-plugin-markdown/types/interfaces/NavigationItem.md +++ b/devguide/typedoc-plugin-markdown/types/interfaces/NavigationItem.md @@ -1,4 +1,4 @@ -[Packages Index](../../../README.md) / [typedoc-plugin-markdown](../../README.md) / [types](../README.md) / NavigationItem +[Home](../../../README.md) / [typedoc-plugin-markdown](../../README.md) / [types](../README.md) / NavigationItem # Interface: NavigationItem @@ -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/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-markdown/src/types/theme.ts#L29) +[types/theme.ts:29](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/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/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-markdown/src/types/theme.ts#L30) +[types/theme.ts:30](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/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/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-markdown/src/types/theme.ts#L31) +[types/theme.ts:31](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/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/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-markdown/src/types/theme.ts#L32) +[types/theme.ts:32](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/types/theme.ts#L32) diff --git a/developer-docs/typedoc-plugin-markdown/types/interfaces/PackageMetaData.md b/devguide/typedoc-plugin-markdown/types/interfaces/PackageMetaData.md similarity index 56% rename from developer-docs/typedoc-plugin-markdown/types/interfaces/PackageMetaData.md rename to devguide/typedoc-plugin-markdown/types/interfaces/PackageMetaData.md index 9642acdb..0eef08da 100644 --- a/developer-docs/typedoc-plugin-markdown/types/interfaces/PackageMetaData.md +++ b/devguide/typedoc-plugin-markdown/types/interfaces/PackageMetaData.md @@ -1,4 +1,4 @@ -[Packages Index](../../../README.md) / [typedoc-plugin-markdown](../../README.md) / [types](../README.md) / PackageMetaData +[Home](../../../README.md) / [typedoc-plugin-markdown](../../README.md) / [types](../README.md) / PackageMetaData # Interface: PackageMetaData @@ -12,14 +12,14 @@ 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/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-markdown/src/types/theme.ts#L10) +[types/theme.ts:10](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/types/theme.ts#L10) *** ### options -> **options**: [`Options`](https://typedoc.org/api/classes/Configuration.Options.html) +> **options**: [`Options`](https://typedoc.org/api/types/Configuration.Options.html) #### Defined in -[types/theme.ts:11](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-markdown/src/types/theme.ts#L11) +[types/theme.ts:11](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/types/theme.ts#L11) diff --git a/developer-docs/typedoc-plugin-markdown/types/interfaces/PluginOptions.md b/devguide/typedoc-plugin-markdown/types/interfaces/PluginOptions.md similarity index 83% rename from developer-docs/typedoc-plugin-markdown/types/interfaces/PluginOptions.md rename to devguide/typedoc-plugin-markdown/types/interfaces/PluginOptions.md index c77a9a95..8b2f0058 100644 --- a/developer-docs/typedoc-plugin-markdown/types/interfaces/PluginOptions.md +++ b/devguide/typedoc-plugin-markdown/types/interfaces/PluginOptions.md @@ -1,4 +1,4 @@ -[Packages Index](../../../README.md) / [typedoc-plugin-markdown](../../README.md) / [types](../README.md) / PluginOptions +[Home](../../../README.md) / [typedoc-plugin-markdown](../../README.md) / [types](../README.md) / PluginOptions # Interface: PluginOptions @@ -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/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-markdown/src/types/options.ts#L11) +[types/options.ts:11](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/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/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-markdown/src/types/options.ts#L16) +[types/options.ts:16](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/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/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-markdown/src/types/options.ts#L21) +[types/options.ts:21](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/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/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-markdown/src/types/options.ts#L26) +[types/options.ts:26](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/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/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-markdown/src/types/options.ts#L31) +[types/options.ts:31](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/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/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-markdown/src/types/options.ts#L36) +[types/options.ts:36](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/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/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-markdown/src/types/options.ts#L41) +[types/options.ts:41](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/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/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-markdown/src/types/options.ts#L46) +[types/options.ts:46](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/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/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-markdown/src/types/options.ts#L51) +[types/options.ts:51](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/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/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-markdown/src/types/options.ts#L56) +[types/options.ts:56](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/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/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-markdown/src/types/options.ts#L61) +[types/options.ts:61](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/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/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-markdown/src/types/options.ts#L66) +[types/options.ts:66](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/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/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-markdown/src/types/options.ts#L71) +[types/options.ts:71](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/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/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-markdown/src/types/options.ts#L76) +[types/options.ts:76](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/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/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-markdown/src/types/options.ts#L81) +[types/options.ts:81](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/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/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-markdown/src/types/options.ts#L86) +[types/options.ts:86](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/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/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-markdown/src/types/options.ts#L91) +[types/options.ts:91](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/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/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-markdown/src/types/options.ts#L96) +[types/options.ts:96](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/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/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-markdown/src/types/options.ts#L108) +[types/options.ts:108](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/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/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-markdown/src/types/options.ts#L113) +[types/options.ts:113](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/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/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-markdown/src/types/options.ts#L122) +[types/options.ts:122](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/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/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-markdown/src/types/options.ts#L127) +[types/options.ts:127](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/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/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-markdown/src/types/options.ts#L132) +[types/options.ts:132](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/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/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-markdown/src/types/options.ts#L137) +[types/options.ts:137](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/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/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-markdown/src/types/options.ts#L142) +[types/options.ts:142](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/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/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-markdown/src/types/options.ts#L147) +[types/options.ts:147](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/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/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-markdown/src/types/options.ts#L152) +[types/options.ts:152](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/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/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-markdown/src/types/options.ts#L157) +[types/options.ts:157](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/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/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-markdown/src/types/options.ts#L170) +[types/options.ts:170](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/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/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-markdown/src/types/options.ts#L182) +[types/options.ts:182](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/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/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-markdown/src/types/options.ts#L187) +[types/options.ts:187](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/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/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-markdown/src/types/options.ts#L192) +[types/options.ts:192](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/types/options.ts#L192) diff --git a/developer-docs/typedoc-plugin-markdown/types/interfaces/TemplateMapping.md b/devguide/typedoc-plugin-markdown/types/interfaces/TemplateMapping.md similarity index 68% rename from developer-docs/typedoc-plugin-markdown/types/interfaces/TemplateMapping.md rename to devguide/typedoc-plugin-markdown/types/interfaces/TemplateMapping.md index 796a0b22..58944802 100644 --- a/developer-docs/typedoc-plugin-markdown/types/interfaces/TemplateMapping.md +++ b/devguide/typedoc-plugin-markdown/types/interfaces/TemplateMapping.md @@ -1,4 +1,4 @@ -[Packages Index](../../../README.md) / [typedoc-plugin-markdown](../../README.md) / [types](../README.md) / TemplateMapping +[Home](../../../README.md) / [typedoc-plugin-markdown](../../README.md) / [types](../README.md) / TemplateMapping # Interface: TemplateMapping @@ -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/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-markdown/src/types/theme.ts#L39) +[types/theme.ts:39](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/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/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-markdown/src/types/theme.ts#L40) +[types/theme.ts:40](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/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/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-markdown/src/types/theme.ts#L41) +[types/theme.ts:41](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/types/theme.ts#L41) diff --git a/developer-docs/typedoc-plugin-markdown/types/interfaces/TranslatableStrings.md b/devguide/typedoc-plugin-markdown/types/interfaces/TranslatableStrings.md similarity index 54% rename from developer-docs/typedoc-plugin-markdown/types/interfaces/TranslatableStrings.md rename to devguide/typedoc-plugin-markdown/types/interfaces/TranslatableStrings.md index 591dca46..e5ba12f2 100644 --- a/developer-docs/typedoc-plugin-markdown/types/interfaces/TranslatableStrings.md +++ b/devguide/typedoc-plugin-markdown/types/interfaces/TranslatableStrings.md @@ -1,4 +1,4 @@ -[Packages Index](../../../README.md) / [typedoc-plugin-markdown](../../README.md) / [types](../README.md) / TranslatableStrings +[Home](../../../README.md) / [typedoc-plugin-markdown](../../README.md) / [types](../README.md) / TranslatableStrings # Interface: TranslatableStrings @@ -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/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-markdown/src/types/internationalization.ts#L11) +[types/internationalization.ts:11](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/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/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-markdown/src/types/internationalization.ts#L12) +[types/internationalization.ts:12](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/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/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-markdown/src/types/internationalization.ts#L13) +[types/internationalization.ts:13](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/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/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-markdown/src/types/internationalization.ts#L14) +[types/internationalization.ts:14](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/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/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-markdown/src/types/internationalization.ts#L15) +[types/internationalization.ts:15](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/types/internationalization.ts#L15) *** @@ -62,7 +62,7 @@ The model of translatable strings specific to the Markdown theme. #### Defined in -[types/internationalization.ts:16](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-markdown/src/types/internationalization.ts#L16) +[types/internationalization.ts:16](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/types/internationalization.ts#L16) *** @@ -72,7 +72,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/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-markdown/src/types/internationalization.ts#L17) +[types/internationalization.ts:17](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/types/internationalization.ts#L17) *** @@ -82,7 +82,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/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-markdown/src/types/internationalization.ts#L18) +[types/internationalization.ts:18](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/types/internationalization.ts#L18) *** @@ -92,7 +92,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/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-markdown/src/types/internationalization.ts#L19) +[types/internationalization.ts:19](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/types/internationalization.ts#L19) *** @@ -102,7 +102,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/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-markdown/src/types/internationalization.ts#L20) +[types/internationalization.ts:20](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/types/internationalization.ts#L20) *** @@ -112,7 +112,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/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-markdown/src/types/internationalization.ts#L21) +[types/internationalization.ts:21](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/types/internationalization.ts#L21) *** @@ -122,7 +122,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/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-markdown/src/types/internationalization.ts#L22) +[types/internationalization.ts:22](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/types/internationalization.ts#L22) *** @@ -132,7 +132,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/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-markdown/src/types/internationalization.ts#L23) +[types/internationalization.ts:23](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/types/internationalization.ts#L23) *** @@ -142,4 +142,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/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-markdown/src/types/internationalization.ts#L24) +[types/internationalization.ts:24](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/types/internationalization.ts#L24) diff --git a/developer-docs/typedoc-plugin-markdown/types/interfaces/UrlMapping.md b/devguide/typedoc-plugin-markdown/types/interfaces/UrlMapping.md similarity index 78% rename from developer-docs/typedoc-plugin-markdown/types/interfaces/UrlMapping.md rename to devguide/typedoc-plugin-markdown/types/interfaces/UrlMapping.md index f5666aba..2a969a18 100644 --- a/developer-docs/typedoc-plugin-markdown/types/interfaces/UrlMapping.md +++ b/devguide/typedoc-plugin-markdown/types/interfaces/UrlMapping.md @@ -1,4 +1,4 @@ -[Packages Index](../../../README.md) / [typedoc-plugin-markdown](../../README.md) / [types](../README.md) / UrlMapping +[Home](../../../README.md) / [typedoc-plugin-markdown](../../README.md) / [types](../README.md) / UrlMapping # Interface: UrlMapping\ @@ -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/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-markdown/src/types/theme.ts#L19) +[types/theme.ts:19](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/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/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-markdown/src/types/theme.ts#L20) +[types/theme.ts:20](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/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/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-markdown/src/types/theme.ts#L21) +[types/theme.ts:21](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/types/theme.ts#L21) diff --git a/developer-docs/typedoc-plugin-markdown/types/interfaces/UrlOption.md b/devguide/typedoc-plugin-markdown/types/interfaces/UrlOption.md similarity index 72% rename from developer-docs/typedoc-plugin-markdown/types/interfaces/UrlOption.md rename to devguide/typedoc-plugin-markdown/types/interfaces/UrlOption.md index f3b573c9..e1896070 100644 --- a/developer-docs/typedoc-plugin-markdown/types/interfaces/UrlOption.md +++ b/devguide/typedoc-plugin-markdown/types/interfaces/UrlOption.md @@ -1,4 +1,4 @@ -[Packages Index](../../../README.md) / [typedoc-plugin-markdown](../../README.md) / [types](../README.md) / UrlOption +[Home](../../../README.md) / [typedoc-plugin-markdown](../../README.md) / [types](../README.md) / UrlOption # Interface: UrlOption @@ -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/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-markdown/src/types/theme.ts#L48) +[types/theme.ts:48](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/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/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-markdown/src/types/theme.ts#L49) +[types/theme.ts:49](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/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/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-markdown/src/types/theme.ts#L50) +[types/theme.ts:50](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/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/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-markdown/src/types/theme.ts#L51) +[types/theme.ts:51](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/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/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-markdown/src/types/theme.ts#L52) +[types/theme.ts:52](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/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/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-markdown/src/types/theme.ts#L53) +[types/theme.ts:53](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/types/theme.ts#L53) diff --git a/developer-docs/typedoc-plugin-markdown/types/type-aliases/RenderTemplate.md b/devguide/typedoc-plugin-markdown/types/type-aliases/RenderTemplate.md similarity index 70% rename from developer-docs/typedoc-plugin-markdown/types/type-aliases/RenderTemplate.md rename to devguide/typedoc-plugin-markdown/types/type-aliases/RenderTemplate.md index 7190f0dd..c8f7fedf 100644 --- a/developer-docs/typedoc-plugin-markdown/types/type-aliases/RenderTemplate.md +++ b/devguide/typedoc-plugin-markdown/types/type-aliases/RenderTemplate.md @@ -1,4 +1,4 @@ -[Packages Index](../../../README.md) / [typedoc-plugin-markdown](../../README.md) / [types](../README.md) / RenderTemplate +[Home](../../../README.md) / [typedoc-plugin-markdown](../../README.md) / [types](../README.md) / RenderTemplate # Type Alias: RenderTemplate()\ @@ -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/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-markdown/src/types/theme.ts#L59) +[types/theme.ts:59](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-markdown/src/types/theme.ts#L59) diff --git a/developer-docs/typedoc-plugin-remark/README.md b/devguide/typedoc-plugin-remark/README.md similarity index 84% rename from developer-docs/typedoc-plugin-remark/README.md rename to devguide/typedoc-plugin-remark/README.md index c23b586b..4fb14c53 100644 --- a/developer-docs/typedoc-plugin-remark/README.md +++ b/devguide/typedoc-plugin-remark/README.md @@ -1,4 +1,4 @@ -[Packages Index](../README.md) / typedoc-plugin-remark +[Home](../README.md) / typedoc-plugin-remark # typedoc-plugin-remark @@ -6,10 +6,10 @@ ## Contents -* [What does the package do?](#what-does-the-package-do) +* [What Does the Package Do?](#what-does-the-package-do) * [Modules](#modules) -## What does the package do? +## What Does the Package Do? * Exposes some additional options to TypeDoc. * Initializes a new remark processor and transform that syntax tree (mdast) using plugins. diff --git a/developer-docs/typedoc-plugin-remark/index/README.md b/devguide/typedoc-plugin-remark/index/README.md similarity index 77% rename from developer-docs/typedoc-plugin-remark/index/README.md rename to devguide/typedoc-plugin-remark/index/README.md index 53489110..e1077a9f 100644 --- a/developer-docs/typedoc-plugin-remark/index/README.md +++ b/devguide/typedoc-plugin-remark/index/README.md @@ -1,4 +1,4 @@ -[Packages Index](../../README.md) / [typedoc-plugin-remark](../README.md) / index +[Home](../../README.md) / [typedoc-plugin-remark](../README.md) / index # index @@ -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/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-remark/src/index.ts#L12) +[index.ts:12](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-remark/src/index.ts#L12) diff --git a/developer-docs/typedoc-plugin-remark/options/README.md b/devguide/typedoc-plugin-remark/options/README.md similarity index 81% rename from developer-docs/typedoc-plugin-remark/options/README.md rename to devguide/typedoc-plugin-remark/options/README.md index 257371cf..bc3feb9a 100644 --- a/developer-docs/typedoc-plugin-remark/options/README.md +++ b/devguide/typedoc-plugin-remark/options/README.md @@ -1,4 +1,4 @@ -[Packages Index](../../README.md) / [typedoc-plugin-remark](../README.md) / options +[Home](../../README.md) / [typedoc-plugin-remark](../README.md) / options # options diff --git a/developer-docs/typedoc-plugin-remark/options/namespaces/declarations/README.md b/devguide/typedoc-plugin-remark/options/namespaces/declarations/README.md similarity index 88% rename from developer-docs/typedoc-plugin-remark/options/namespaces/declarations/README.md rename to devguide/typedoc-plugin-remark/options/namespaces/declarations/README.md index e4679924..a19b7e75 100644 --- a/developer-docs/typedoc-plugin-remark/options/namespaces/declarations/README.md +++ b/devguide/typedoc-plugin-remark/options/namespaces/declarations/README.md @@ -1,4 +1,4 @@ -[Packages Index](../../../../README.md) / [typedoc-plugin-remark](../../../README.md) / [options](../../README.md) / declarations +[Home](../../../../README.md) / [typedoc-plugin-remark](../../../README.md) / [options](../../README.md) / declarations # declarations @@ -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/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-remark/src/options/declarations.ts#L14) +[options/declarations.ts:14](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/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/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-remark/src/options/declarations.ts#L34) +[options/declarations.ts:34](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-remark/src/options/declarations.ts#L34) diff --git a/developer-docs/typedoc-plugin-remark/options/namespaces/helpers/README.md b/devguide/typedoc-plugin-remark/options/namespaces/helpers/README.md similarity index 73% rename from developer-docs/typedoc-plugin-remark/options/namespaces/helpers/README.md rename to devguide/typedoc-plugin-remark/options/namespaces/helpers/README.md index c883a821..6cbef8e5 100644 --- a/developer-docs/typedoc-plugin-remark/options/namespaces/helpers/README.md +++ b/devguide/typedoc-plugin-remark/options/namespaces/helpers/README.md @@ -1,4 +1,4 @@ -[Packages Index](../../../../README.md) / [typedoc-plugin-remark](../../../README.md) / [options](../../README.md) / helpers +[Home](../../../../README.md) / [typedoc-plugin-remark](../../../README.md) / [options](../../README.md) / helpers # helpers @@ -21,4 +21,4 @@ ### Defined in -[options/helpers.ts:3](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-remark/src/options/helpers.ts#L3) +[options/helpers.ts:3](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-remark/src/options/helpers.ts#L3) diff --git a/developer-docs/typedoc-plugin-remark/types/README.md b/devguide/typedoc-plugin-remark/types/README.md similarity index 82% rename from developer-docs/typedoc-plugin-remark/types/README.md rename to devguide/typedoc-plugin-remark/types/README.md index fb7a7466..2d20bcb4 100644 --- a/developer-docs/typedoc-plugin-remark/types/README.md +++ b/devguide/typedoc-plugin-remark/types/README.md @@ -1,4 +1,4 @@ -[Packages Index](../../README.md) / [typedoc-plugin-remark](../README.md) / types +[Home](../../README.md) / [typedoc-plugin-remark](../README.md) / types # types diff --git a/developer-docs/typedoc-plugin-remark/types/interfaces/PluginOptions.md b/devguide/typedoc-plugin-remark/types/interfaces/PluginOptions.md similarity index 69% rename from developer-docs/typedoc-plugin-remark/types/interfaces/PluginOptions.md rename to devguide/typedoc-plugin-remark/types/interfaces/PluginOptions.md index 4d0a0fa4..92e8f74c 100644 --- a/developer-docs/typedoc-plugin-remark/types/interfaces/PluginOptions.md +++ b/devguide/typedoc-plugin-remark/types/interfaces/PluginOptions.md @@ -1,4 +1,4 @@ -[Packages Index](../../../README.md) / [typedoc-plugin-remark](../../README.md) / [types](../README.md) / PluginOptions +[Home](../../../README.md) / [typedoc-plugin-remark](../../README.md) / [types](../README.md) / PluginOptions # Interface: PluginOptions @@ -14,7 +14,7 @@ An array of remark plugin names. #### Defined in -[types/options.ts:11](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-remark/src/types/options.ts#L11) +[types/options.ts:11](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/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/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-remark/src/types/options.ts#L16) +[types/options.ts:16](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-remark/src/types/options.ts#L16) diff --git a/developer-docs/typedoc-vitepress-theme/README.md b/devguide/typedoc-vitepress-theme/README.md similarity index 83% rename from developer-docs/typedoc-vitepress-theme/README.md rename to devguide/typedoc-vitepress-theme/README.md index bffc909c..3bc1ca31 100644 --- a/developer-docs/typedoc-vitepress-theme/README.md +++ b/devguide/typedoc-vitepress-theme/README.md @@ -1,4 +1,4 @@ -[Packages Index](../README.md) / typedoc-vitepress-theme +[Home](../README.md) / typedoc-vitepress-theme # typedoc-vitepress-theme @@ -6,10 +6,10 @@ ## Contents -* [What does the package do?](#what-does-the-package-do) +* [What Does the Package Do?](#what-does-the-package-do) * [Modules](#modules) -## What does the package do? +## What Does the Package Do? * Exposes some additional options to TypeDoc. * Presets relevant typedoc-plugin-markdown options. diff --git a/devguide/typedoc-vitepress-theme/index/README.md b/devguide/typedoc-vitepress-theme/index/README.md new file mode 100644 index 00000000..0d246557 --- /dev/null +++ b/devguide/typedoc-vitepress-theme/index/README.md @@ -0,0 +1,23 @@ +[Home](../../README.md) / [typedoc-vitepress-theme](../README.md) / index + +# index + +The plugin entrypoint and bootstrapping of the plugin. + +## load() + +> **load**(`app`): `void` + +### Parameters + +| Parameter | Type | +| --------- | ---------------------------------------------------------------------------------------------- | +| `app` | [`MarkdownApplication`](../../typedoc-plugin-markdown/types/interfaces/MarkdownApplication.md) | + +### Returns + +`void` + +### Defined in + +[index.ts:18](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-vitepress-theme/src/index.ts#L18) diff --git a/developer-docs/docusaurus-plugin-typedoc/options/README.md b/devguide/typedoc-vitepress-theme/options/README.md similarity index 80% rename from developer-docs/docusaurus-plugin-typedoc/options/README.md rename to devguide/typedoc-vitepress-theme/options/README.md index e98c51e7..b811096c 100644 --- a/developer-docs/docusaurus-plugin-typedoc/options/README.md +++ b/devguide/typedoc-vitepress-theme/options/README.md @@ -1,4 +1,4 @@ -[Packages Index](../../README.md) / [docusaurus-plugin-typedoc](../README.md) / options +[Home](../../README.md) / [typedoc-vitepress-theme](../README.md) / options # options diff --git a/developer-docs/typedoc-vitepress-theme/options/namespaces/declarations/README.md b/devguide/typedoc-vitepress-theme/options/namespaces/declarations/README.md similarity index 91% rename from developer-docs/typedoc-vitepress-theme/options/namespaces/declarations/README.md rename to devguide/typedoc-vitepress-theme/options/namespaces/declarations/README.md index 629cfb53..430a022b 100644 --- a/developer-docs/typedoc-vitepress-theme/options/namespaces/declarations/README.md +++ b/devguide/typedoc-vitepress-theme/options/namespaces/declarations/README.md @@ -1,4 +1,4 @@ -[Packages Index](../../../../README.md) / [typedoc-vitepress-theme](../../../README.md) / [options](../../README.md) / declarations +[Home](../../../../README.md) / [typedoc-vitepress-theme](../../../README.md) / [options](../../README.md) / declarations # declarations @@ -45,7 +45,7 @@ Requires the following config: ### Defined in -[options/declarations.ts:30](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-vitepress-theme/src/options/declarations.ts#L30) +[options/declarations.ts:30](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-vitepress-theme/src/options/declarations.ts#L30) *** @@ -81,4 +81,4 @@ Pretty format the sidebar JSON. ### Defined in -[options/declarations.ts:56](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-vitepress-theme/src/options/declarations.ts#L56) +[options/declarations.ts:56](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-vitepress-theme/src/options/declarations.ts#L56) diff --git a/developer-docs/typedoc-vitepress-theme/options/namespaces/presets/README.md b/devguide/typedoc-vitepress-theme/options/namespaces/presets/README.md similarity index 70% rename from developer-docs/typedoc-vitepress-theme/options/namespaces/presets/README.md rename to devguide/typedoc-vitepress-theme/options/namespaces/presets/README.md index d20a52ca..70fed150 100644 --- a/developer-docs/typedoc-vitepress-theme/options/namespaces/presets/README.md +++ b/devguide/typedoc-vitepress-theme/options/namespaces/presets/README.md @@ -1,4 +1,4 @@ -[Packages Index](../../../../README.md) / [typedoc-vitepress-theme](../../../README.md) / [options](../../README.md) / presets +[Home](../../../../README.md) / [typedoc-vitepress-theme](../../../README.md) / [options](../../README.md) / presets # presets @@ -16,4 +16,4 @@ ### Defined in -[options/presets.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-vitepress-theme/src/options/presets.ts#L1) +[options/presets.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-vitepress-theme/src/options/presets.ts#L1) diff --git a/developer-docs/docusaurus-plugin-typedoc/types/README.md b/devguide/typedoc-vitepress-theme/types/README.md similarity index 84% rename from developer-docs/docusaurus-plugin-typedoc/types/README.md rename to devguide/typedoc-vitepress-theme/types/README.md index 88782c1f..7d433a59 100644 --- a/developer-docs/docusaurus-plugin-typedoc/types/README.md +++ b/devguide/typedoc-vitepress-theme/types/README.md @@ -1,4 +1,4 @@ -[Packages Index](../../README.md) / [docusaurus-plugin-typedoc](../README.md) / types +[Home](../../README.md) / [typedoc-vitepress-theme](../README.md) / types # types diff --git a/developer-docs/typedoc-vitepress-theme/types/interfaces/PluginOptions.md b/devguide/typedoc-vitepress-theme/types/interfaces/PluginOptions.md similarity index 68% rename from developer-docs/typedoc-vitepress-theme/types/interfaces/PluginOptions.md rename to devguide/typedoc-vitepress-theme/types/interfaces/PluginOptions.md index 83e4f11a..2c4f8fce 100644 --- a/developer-docs/typedoc-vitepress-theme/types/interfaces/PluginOptions.md +++ b/devguide/typedoc-vitepress-theme/types/interfaces/PluginOptions.md @@ -1,4 +1,4 @@ -[Packages Index](../../../README.md) / [typedoc-vitepress-theme](../../README.md) / [types](../README.md) / PluginOptions +[Home](../../../README.md) / [typedoc-vitepress-theme](../../README.md) / [types](../README.md) / PluginOptions # Interface: PluginOptions @@ -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/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-vitepress-theme/src/types/options.ts#L11) +[types/options.ts:11](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/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/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-vitepress-theme/src/types/options.ts#L16) +[types/options.ts:16](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-vitepress-theme/src/types/options.ts#L16) diff --git a/developer-docs/typedoc-vitepress-theme/types/interfaces/Sidebar.md b/devguide/typedoc-vitepress-theme/types/interfaces/Sidebar.md similarity index 67% rename from developer-docs/typedoc-vitepress-theme/types/interfaces/Sidebar.md rename to devguide/typedoc-vitepress-theme/types/interfaces/Sidebar.md index 49ddd567..e72d04a4 100644 --- a/developer-docs/typedoc-vitepress-theme/types/interfaces/Sidebar.md +++ b/devguide/typedoc-vitepress-theme/types/interfaces/Sidebar.md @@ -1,4 +1,4 @@ -[Packages Index](../../../README.md) / [typedoc-vitepress-theme](../../README.md) / [types](../README.md) / Sidebar +[Home](../../../README.md) / [typedoc-vitepress-theme](../../README.md) / [types](../README.md) / Sidebar # Interface: Sidebar @@ -10,7 +10,7 @@ #### Defined in -[types/options.ts:23](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-vitepress-theme/src/types/options.ts#L23) +[types/options.ts:23](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/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/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-vitepress-theme/src/types/options.ts#L24) +[types/options.ts:24](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/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/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-vitepress-theme/src/types/options.ts#L25) +[types/options.ts:25](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/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/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-vitepress-theme/src/types/options.ts#L26) +[types/options.ts:26](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-vitepress-theme/src/types/options.ts#L26) diff --git a/devtools/packages/prebuild-options/tasks/generate-models.ts b/devtools/packages/prebuild-options/tasks/generate-models.ts index f67faf2c..508212b0 100644 --- a/devtools/packages/prebuild-options/tasks/generate-models.ts +++ b/devtools/packages/prebuild-options/tasks/generate-models.ts @@ -68,6 +68,7 @@ import { ManuallyValidatedOption } from 'typedoc'`); theme_event: []; theme_extends: []; theme_extended_by: []; + theme_globals: []; theme_member: []; theme_member_plural: []; theme_modifier: []; diff --git a/packages/typedoc-plugin-markdown/.docs/plugins/typedoc-ignore-typeparam.mjs b/devtools/typedoc-plugins/typedoc-ignore-typeparam.mjs similarity index 100% rename from packages/typedoc-plugin-markdown/.docs/plugins/typedoc-ignore-typeparam.mjs rename to devtools/typedoc-plugins/typedoc-ignore-typeparam.mjs diff --git a/packages/typedoc-plugin-markdown/.docs/plugins/typedoc-nextra.mjs b/devtools/typedoc-plugins/typedoc-nextra.mjs similarity index 100% rename from packages/typedoc-plugin-markdown/.docs/plugins/typedoc-nextra.mjs rename to devtools/typedoc-plugins/typedoc-nextra.mjs diff --git a/devtools/typedoc-plugins/typedoc-symbols.mjs b/devtools/typedoc-plugins/typedoc-symbols.mjs new file mode 100644 index 00000000..ae165620 --- /dev/null +++ b/devtools/typedoc-plugins/typedoc-symbols.mjs @@ -0,0 +1,79 @@ +export function load(app) { + app.converter.addUnknownSymbolResolver((ref) => { + if (ref.moduleSource === 'typedoc') { + const symbol = ref.symbolReference.path[0].path; + const enums = ['ReflectionKind']; + const configuration = [ + 'DeclarationOption', + 'Options', + 'ManuallyValidatedOption', + ]; + const types = [ + 'IndexedAccessType', + 'InferredType', + 'IntersectionType', + 'IntrinsicType', + 'LiteralType', + 'NamedTupleMember', + 'ReflectionCategory', + 'RenderTemplate', + 'UnionType', + 'UnknownType', + ]; + const interfaces = ['TypeDocOptions', 'TypeOperatorType']; + const classes = [ + 'Application', + 'DefaultThemeRenderContext', + 'Event', + 'EventHooks', + 'PageEvent', + 'ParameterReflection', + 'ProjectReflection', + 'ReferenceReflection', + 'ReferenceType', + 'Reflection', + 'ReflectionFlags', + 'ReflectionGroup', + 'ReflectionType', + 'Renderer', + 'RendererEvent', + 'SignatureReflection', + 'SomeType', + 'Theme', + 'TupleType', + 'TypeParameterReflection', + 'UrlMapping', + ]; + const models = [ + 'ArrayType', + 'Comment', + 'CommentDisplayPart', + 'ConditionalType', + 'ContainerReflection', + 'DeclarationHierarchy', + 'DeclarationReflection', + 'ProjectReflection', + 'QueryType', + ]; + + if (models.includes(symbol)) { + return `https://typedoc.org/api/classes/Models.${symbol}.html`; + } + if (classes.includes(symbol)) { + return `https://typedoc.org/api/classes/${symbol}.html`; + } + if (enums.includes(symbol)) { + return `https://typedoc.org/api/enums/Models.${symbol}-1.html`; + } + if (interfaces.includes(symbol)) { + return `https://typedoc.org/api/${interfaces}/TypeDocOptions.html`; + } + if (configuration.includes(symbol)) { + return `https://typedoc.org/api/types/Configuration.${symbol}.html`; + } + if (types.includes(symbol)) { + return `https://typedoc.org/api/types/${symbol}.DeclarationOption.html`; + } + } + }); +} diff --git a/docs/global.css b/docs/global.css index 693b1326..de492cd4 100644 --- a/docs/global.css +++ b/docs/global.css @@ -8,6 +8,7 @@ .nextra-toc a[href^='#source'], .nextra-toc a[href^='#overrides'], .nextra-toc a[href^='#see'], +.nextra-toc a[href^='#example'], .nextra-toc a[href^='#deprecated'] { display: none; } diff --git a/docs/pages/api-docs/Class.MarkdownPageEvent.mdx b/docs/pages/api-docs/Class.MarkdownPageEvent.mdx index 277c6b9c..8d974a85 100644 --- a/docs/pages/api-docs/Class.MarkdownPageEvent.mdx +++ b/docs/pages/api-docs/Class.MarkdownPageEvent.mdx @@ -1,16 +1,6 @@ # MarkdownPageEvent -An event emitted by before and after the markup of a page is rendered. - -## Example - -```ts -export function load(app: MarkdownApplication) { - app.renderer.on(MarkdownPageEvent.BEGIN, (page: MarkdownPageEvent) => { - page.contents = page.contents.replace('foo', 'bar'); - }); -}); -``` +An event emitted before and after the markdown of a page is rendered. ## Extends diff --git a/docs/pages/api-docs/Class.MarkdownRendererEvent.mdx b/docs/pages/api-docs/Class.MarkdownRendererEvent.mdx index 4d37a8d2..50afa066 100644 --- a/docs/pages/api-docs/Class.MarkdownRendererEvent.mdx +++ b/docs/pages/api-docs/Class.MarkdownRendererEvent.mdx @@ -2,14 +2,6 @@ An event emitted at the beginning and end of the rendering process. -## Example - -```ts -app.renderer.on(MarkdownRendererEvent.BEGIN, (event) => { - console.log(`Render Starting for ${event.project.name}!`); -}); -``` - ## Extends - [`Event`](https://typedoc.org/api/classes/Event.html) @@ -50,7 +42,7 @@ The path of the directory the documentation should be written to. ### urls? -> `optional` **urls**: [`UrlMapping`](/api-docs/Interface.UrlMapping.mdx)\<[`Reflection`](https://typedoc.org/api/classes/Models.Reflection.html)\>[] +> `optional` **urls**: [`UrlMapping`](/api-docs/Interface.UrlMapping.mdx)\<[`Reflection`](https://typedoc.org/api/classes/Reflection.html)\>[] A list of all pages that should be generated. diff --git a/docs/pages/api-docs/Class.MarkdownTheme.mdx b/docs/pages/api-docs/Class.MarkdownTheme.mdx index fb68aeb6..5f4c6c0b 100644 --- a/docs/pages/api-docs/Class.MarkdownTheme.mdx +++ b/docs/pages/api-docs/Class.MarkdownTheme.mdx @@ -1,24 +1,13 @@ # MarkdownTheme The main theme class for the plugin. + The class controls how TypeDoc models are mapped to files and templates and extends TypeDoc's base Theme class. You would typically only be interested in overriding the the theme's render context instance. The API follows the implementation of [TypeDoc's custom theming](https://github.com/TypeStrong/typedoc/blob/master/internal-docs/custom-themes.md) with some minor adjustments. -## Example - -```ts -export function load(app) { - app.renderer.defineTheme('customTheme', MyMarkdownTheme); -} - -class MyMarkdownTheme extends MarkdownTheme { - ... -} -``` - ## Extends - [`Theme`](https://typedoc.org/api/classes/Theme.html) @@ -57,7 +46,7 @@ This method can be overridden to provide an alternative theme context. | Parameter | Type | | :------ | :------ | -| `page` | [`MarkdownPageEvent`](/api-docs/Class.MarkdownPageEvent.mdx)\<[`Reflection`](https://typedoc.org/api/classes/Models.Reflection.html)\> | +| `page` | [`MarkdownPageEvent`](/api-docs/Class.MarkdownPageEvent.mdx)\<[`Reflection`](https://typedoc.org/api/classes/Reflection.html)\> | #### Returns @@ -67,7 +56,7 @@ This method can be overridden to provide an alternative theme context. ### getUrls() -> **getUrls**(`project`): [`UrlMapping`](/api-docs/Interface.UrlMapping.mdx)\<[`Reflection`](https://typedoc.org/api/classes/Models.Reflection.html)\>[] +> **getUrls**(`project`): [`UrlMapping`](/api-docs/Interface.UrlMapping.mdx)\<[`Reflection`](https://typedoc.org/api/classes/Reflection.html)\>[] Maps the models of the given project to the desired output files. @@ -79,7 +68,7 @@ Maps the models of the given project to the desired output files. #### Returns -[`UrlMapping`](/api-docs/Interface.UrlMapping.mdx)\<[`Reflection`](https://typedoc.org/api/classes/Models.Reflection.html)\>[] +[`UrlMapping`](/api-docs/Interface.UrlMapping.mdx)\<[`Reflection`](https://typedoc.org/api/classes/Reflection.html)\>[] #### Overrides diff --git a/docs/pages/api-docs/Class.MarkdownThemeContext.mdx b/docs/pages/api-docs/Class.MarkdownThemeContext.mdx index 97373766..bd5c3a26 100644 --- a/docs/pages/api-docs/Class.MarkdownThemeContext.mdx +++ b/docs/pages/api-docs/Class.MarkdownThemeContext.mdx @@ -1,6 +1,7 @@ # MarkdownThemeContext The theme context class that is provided as context on the rendering of every page. + It is heavily influenced by the equivalent [DefaultThemeRenderContext](https://typedoc.org/api/classes/DefaultThemeRenderContext.html) from the default theme. This class can be used to customize the theme output by extending the class and overriding the templates, partials and helpers. @@ -16,8 +17,8 @@ This class can be used to customize the theme output by extending the class and | Parameter | Type | Description | | :------ | :------ | :------ | | `theme` | [`MarkdownTheme`](/api-docs/Class.MarkdownTheme.mdx) | The theme instance. | -| `page` | [`MarkdownPageEvent`](/api-docs/Class.MarkdownPageEvent.mdx)\<[`Reflection`](https://typedoc.org/api/classes/Models.Reflection.html)\> | The current page event. | -| `options` | [`Options`](https://typedoc.org/api/classes/Configuration.Options.html) | The options provided to the application. | +| `page` | [`MarkdownPageEvent`](/api-docs/Class.MarkdownPageEvent.mdx)\<[`Reflection`](https://typedoc.org/api/classes/Reflection.html)\> | The current page event. | +| `options` | [`Options`](https://typedoc.org/api/types/Configuration.Options.html) | The options provided to the application. | #### Returns @@ -64,7 +65,7 @@ Properties are passed into the constructor and are used to provide context to th ### page -> `readonly` **page**: [`MarkdownPageEvent`](/api-docs/Class.MarkdownPageEvent.mdx)\<[`Reflection`](https://typedoc.org/api/classes/Models.Reflection.html)\> +> `readonly` **page**: [`MarkdownPageEvent`](/api-docs/Class.MarkdownPageEvent.mdx)\<[`Reflection`](https://typedoc.org/api/classes/Reflection.html)\> The current page event. @@ -72,7 +73,7 @@ The current page event. ### options -> `readonly` **options**: [`Options`](https://typedoc.org/api/classes/Configuration.Options.html) +> `readonly` **options**: [`Options`](https://typedoc.org/api/types/Configuration.Options.html) The options provided to the application. @@ -182,7 +183,7 @@ Partials are categorised by their use: | Parameter | Type | | :------ | :------ | -| `model` | [`Comment`](https://typedoc.org/api/types/Models.Comment.html) | +| `model` | [`Comment`](https://typedoc.org/api/classes/Models.Comment.html) | | `options` | `object` | | `options.headingLevel`? | `number` | | `options.showSummary`? | `boolean` | @@ -201,7 +202,7 @@ Partials are categorised by their use: | Parameter | Type | | :------ | :------ | -| `model` | [`CommentDisplayPart`](https://typedoc.org/api/types/Models.CommentDisplayPart.html)[] | +| `model` | [`CommentDisplayPart`](https://typedoc.org/api/classes/Models.CommentDisplayPart.html)[] | ##### Returns @@ -231,7 +232,7 @@ Partials are categorised by their use: | Parameter | Type | | :------ | :------ | -| `model` | [`ReflectionCategory`](https://typedoc.org/api/types/Models.ReflectionCategory.html)[] | +| `model` | [`ReflectionCategory`](https://typedoc.org/api/types/ReflectionCategory.DeclarationOption.html)[] | | `options` | `object` | | `options.headingLevel` | `number` | @@ -247,7 +248,7 @@ Partials are categorised by their use: | Parameter | Type | | :------ | :------ | -| `model` | [`ReflectionGroup`](https://typedoc.org/api/classes/Models.ReflectionGroup.html)[] | +| `model` | [`ReflectionGroup`](https://typedoc.org/api/classes/ReflectionGroup.html)[] | | `options` | `object` | | `options.headingLevel` | `number` | | `options.kind` | [`ReflectionKind`](https://typedoc.org/api/enums/Models.ReflectionKind-1.html) | @@ -406,7 +407,7 @@ Partials are categorised by their use: | Parameter | Type | | :------ | :------ | -| `model` | [`SignatureReflection`](https://typedoc.org/api/classes/Models.SignatureReflection.html) | +| `model` | [`SignatureReflection`](https://typedoc.org/api/classes/SignatureReflection.html) | ##### Returns @@ -420,7 +421,7 @@ Partials are categorised by their use: | Parameter | Type | | :------ | :------ | -| `model` | [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html) \| [`SignatureReflection`](https://typedoc.org/api/classes/Models.SignatureReflection.html) | +| `model` | [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html) \| [`SignatureReflection`](https://typedoc.org/api/classes/SignatureReflection.html) | | `options` | `object` | | `options.headingLevel` | `number` | @@ -468,7 +469,7 @@ Renders a top-level member that contains group and child members such as Classes | Parameter | Type | | :------ | :------ | -| `model` | [`ParameterReflection`](https://typedoc.org/api/classes/Models.ParameterReflection.html)[] | +| `model` | [`ParameterReflection`](https://typedoc.org/api/classes/ParameterReflection.html)[] | ##### Returns @@ -482,7 +483,7 @@ Renders a top-level member that contains group and child members such as Classes | Parameter | Type | | :------ | :------ | -| `model` | [`ParameterReflection`](https://typedoc.org/api/classes/Models.ParameterReflection.html)[] | +| `model` | [`ParameterReflection`](https://typedoc.org/api/classes/ParameterReflection.html)[] | ##### Returns @@ -516,7 +517,7 @@ There is no association list partial for properties as these are handled as a st | Parameter | Type | | :------ | :------ | -| `model` | [`ReferenceReflection`](https://typedoc.org/api/classes/Models.ReferenceReflection.html) | +| `model` | [`ReferenceReflection`](https://typedoc.org/api/classes/ReferenceReflection.html) | ##### Returns @@ -546,7 +547,7 @@ There is no association list partial for properties as these are handled as a st | Parameter | Type | | :------ | :------ | -| `model` | [`SignatureReflection`](https://typedoc.org/api/classes/Models.SignatureReflection.html) | +| `model` | [`SignatureReflection`](https://typedoc.org/api/classes/SignatureReflection.html) | | `options` | `object` | | `options.headingLevel` | `number` | | `options.nested`? | `boolean` | @@ -565,7 +566,7 @@ There is no association list partial for properties as these are handled as a st | Parameter | Type | | :------ | :------ | -| `model` | [`ParameterReflection`](https://typedoc.org/api/classes/Models.ParameterReflection.html)[] | +| `model` | [`ParameterReflection`](https://typedoc.org/api/classes/ParameterReflection.html)[] | ##### Returns @@ -579,7 +580,7 @@ There is no association list partial for properties as these are handled as a st | Parameter | Type | | :------ | :------ | -| `model` | [`SignatureReflection`](https://typedoc.org/api/classes/Models.SignatureReflection.html) | +| `model` | [`SignatureReflection`](https://typedoc.org/api/classes/SignatureReflection.html) | | `options` | `object` | | `options.headingLevel` | `number` | @@ -595,7 +596,7 @@ There is no association list partial for properties as these are handled as a st | Parameter | Type | | :------ | :------ | -| `model` | [`SignatureReflection`](https://typedoc.org/api/classes/Models.SignatureReflection.html) | +| `model` | [`SignatureReflection`](https://typedoc.org/api/classes/SignatureReflection.html) | | `options`? | `object` | | `options.accessor`? | `string` | | `options.includeType`? | `boolean` | @@ -629,7 +630,7 @@ There is no association list partial for properties as these are handled as a st | Parameter | Type | | :------ | :------ | -| `model` | [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html) \| [`SignatureReflection`](https://typedoc.org/api/classes/Models.SignatureReflection.html) | +| `model` | [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html) \| [`SignatureReflection`](https://typedoc.org/api/classes/SignatureReflection.html) | | `options` | `object` | | `options.headingLevel` | `number` | @@ -662,7 +663,7 @@ There is no association list partial for properties as these are handled as a st | Parameter | Type | | :------ | :------ | -| `model` | [`ReferenceType`](https://typedoc.org/api/classes/Models.ReferenceType.html) \| [`ArrayType`](https://typedoc.org/api/types/Models.ArrayType.html) | +| `model` | [`ReferenceType`](https://typedoc.org/api/classes/ReferenceType.html) \| [`ArrayType`](https://typedoc.org/api/classes/Models.ArrayType.html) | ##### Returns @@ -676,7 +677,7 @@ There is no association list partial for properties as these are handled as a st | Parameter | Type | | :------ | :------ | -| `model` | [`SomeType`](https://typedoc.org/api/classes/Models.SomeType.html)[] | +| `model` | [`SomeType`](https://typedoc.org/api/classes/SomeType.html)[] | | `options`? | `object` | | `options.forceCollapse`? | `boolean` | @@ -740,7 +741,7 @@ There is no association list partial for properties as these are handled as a st | Parameter | Type | | :------ | :------ | -| `model` | [`TypeParameterReflection`](https://typedoc.org/api/classes/Models.TypeParameterReflection.html)[] | +| `model` | [`TypeParameterReflection`](https://typedoc.org/api/classes/TypeParameterReflection.html)[] | ##### Returns @@ -754,7 +755,7 @@ There is no association list partial for properties as these are handled as a st | Parameter | Type | | :------ | :------ | -| `model` | [`TypeParameterReflection`](https://typedoc.org/api/classes/Models.TypeParameterReflection.html)[] | +| `model` | [`TypeParameterReflection`](https://typedoc.org/api/classes/TypeParameterReflection.html)[] | ##### Returns @@ -814,7 +815,7 @@ There is no association list partial for properties as these are handled as a st | Parameter | Type | | :------ | :------ | -| `model` | [`ArrayType`](https://typedoc.org/api/types/Models.ArrayType.html) | +| `model` | [`ArrayType`](https://typedoc.org/api/classes/Models.ArrayType.html) | ##### Returns @@ -828,7 +829,7 @@ There is no association list partial for properties as these are handled as a st | Parameter | Type | | :------ | :------ | -| `model` | [`ConditionalType`](https://typedoc.org/api/types/Models.ConditionalType.html) | +| `model` | [`ConditionalType`](https://typedoc.org/api/classes/Models.ConditionalType.html) | ##### Returns @@ -842,7 +843,7 @@ There is no association list partial for properties as these are handled as a st | Parameter | Type | | :------ | :------ | -| `model` | [`IndexedAccessType`](https://typedoc.org/api/types/Models.IndexedAccessType.html) | +| `model` | [`IndexedAccessType`](https://typedoc.org/api/types/IndexedAccessType.DeclarationOption.html) | ##### Returns @@ -856,7 +857,7 @@ There is no association list partial for properties as these are handled as a st | Parameter | Type | | :------ | :------ | -| `model` | [`InferredType`](https://typedoc.org/api/types/Models.InferredType.html) | +| `model` | [`InferredType`](https://typedoc.org/api/types/InferredType.DeclarationOption.html) | ##### Returns @@ -870,7 +871,7 @@ There is no association list partial for properties as these are handled as a st | Parameter | Type | | :------ | :------ | -| `model` | [`IntersectionType`](https://typedoc.org/api/types/Models.IntersectionType.html) | +| `model` | [`IntersectionType`](https://typedoc.org/api/types/IntersectionType.DeclarationOption.html) | ##### Returns @@ -884,7 +885,7 @@ There is no association list partial for properties as these are handled as a st | Parameter | Type | | :------ | :------ | -| `model` | [`IntrinsicType`](https://typedoc.org/api/types/Models.IntrinsicType.html) | +| `model` | [`IntrinsicType`](https://typedoc.org/api/types/IntrinsicType.DeclarationOption.html) | ##### Returns @@ -898,7 +899,7 @@ There is no association list partial for properties as these are handled as a st | Parameter | Type | | :------ | :------ | -| `model` | [`LiteralType`](https://typedoc.org/api/types/Models.LiteralType.html) | +| `model` | [`LiteralType`](https://typedoc.org/api/types/LiteralType.DeclarationOption.html) | ##### Returns @@ -912,7 +913,7 @@ There is no association list partial for properties as these are handled as a st | Parameter | Type | | :------ | :------ | -| `model` | [`NamedTupleMember`](https://typedoc.org/api/types/Models.NamedTupleMember.html) | +| `model` | [`NamedTupleMember`](https://typedoc.org/api/types/NamedTupleMember.DeclarationOption.html) | ##### Returns @@ -926,7 +927,7 @@ There is no association list partial for properties as these are handled as a st | Parameter | Type | | :------ | :------ | -| `model` | [`QueryType`](https://typedoc.org/api/types/Models.QueryType.html) | +| `model` | [`QueryType`](https://typedoc.org/api/classes/Models.QueryType.html) | ##### Returns @@ -940,7 +941,7 @@ There is no association list partial for properties as these are handled as a st | Parameter | Type | | :------ | :------ | -| `model` | [`ReferenceType`](https://typedoc.org/api/classes/Models.ReferenceType.html) | +| `model` | [`ReferenceType`](https://typedoc.org/api/classes/ReferenceType.html) | ##### Returns @@ -968,7 +969,7 @@ There is no association list partial for properties as these are handled as a st | Parameter | Type | | :------ | :------ | -| `model` | [`SignatureReflection`](https://typedoc.org/api/classes/Models.SignatureReflection.html)[] | +| `model` | [`SignatureReflection`](https://typedoc.org/api/classes/SignatureReflection.html)[] | | `options`? | `object` | | `options.forceParameterType`? | `boolean` | @@ -984,7 +985,7 @@ There is no association list partial for properties as these are handled as a st | Parameter | Type | | :------ | :------ | -| `model` | [`ReflectionType`](https://typedoc.org/api/classes/Models.ReflectionType.html) | +| `model` | [`ReflectionType`](https://typedoc.org/api/classes/ReflectionType.html) | | `options`? | `object` | | `options.forceCollapse`? | `boolean` | @@ -1000,7 +1001,7 @@ There is no association list partial for properties as these are handled as a st | Parameter | Type | | :------ | :------ | -| `model`? | [`SomeType`](https://typedoc.org/api/classes/Models.SomeType.html) | +| `model`? | [`SomeType`](https://typedoc.org/api/classes/SomeType.html) | ##### Returns @@ -1014,7 +1015,7 @@ There is no association list partial for properties as these are handled as a st | Parameter | Type | | :------ | :------ | -| `model` | [`TupleType`](https://typedoc.org/api/classes/Models.TupleType.html) | +| `model` | [`TupleType`](https://typedoc.org/api/classes/TupleType.html) | ##### Returns @@ -1028,7 +1029,7 @@ There is no association list partial for properties as these are handled as a st | Parameter | Type | | :------ | :------ | -| `model` | [`TypeOperatorType`](https://typedoc.org/api/interfaces/TypeOperatorType.html) | +| `model` | [`TypeOperatorType`](https://typedoc.org/api/TypeDocOptions,TypeOperatorType/TypeDocOptions.html) | ##### Returns @@ -1042,7 +1043,7 @@ There is no association list partial for properties as these are handled as a st | Parameter | Type | | :------ | :------ | -| `model` | [`UnionType`](https://typedoc.org/api/types/Models.UnionType.html) | +| `model` | [`UnionType`](https://typedoc.org/api/types/UnionType.DeclarationOption.html) | ##### Returns @@ -1056,7 +1057,7 @@ There is no association list partial for properties as these are handled as a st | Parameter | Type | | :------ | :------ | -| `model` | [`UnknownType`](https://typedoc.org/api/types/Models.UnknownType.html) | +| `model` | [`UnknownType`](https://typedoc.org/api/types/UnknownType.DeclarationOption.html) | ##### Returns @@ -1084,7 +1085,7 @@ Please note that partials: | Parameter | Type | | :------ | :------ | -| `model` | [`CommentDisplayPart`](https://typedoc.org/api/types/Models.CommentDisplayPart.html)[] | +| `model` | [`CommentDisplayPart`](https://typedoc.org/api/classes/Models.CommentDisplayPart.html)[] | ##### Returns @@ -1092,7 +1093,7 @@ Please note that partials: #### getDeclarationType() -> **getDeclarationType**: (`model`) => `undefined` \| [`SomeType`](https://typedoc.org/api/classes/Models.SomeType.html) +> **getDeclarationType**: (`model`) => `undefined` \| [`SomeType`](https://typedoc.org/api/classes/SomeType.html) ##### Parameters @@ -1102,7 +1103,7 @@ Please note that partials: ##### Returns -`undefined` \| [`SomeType`](https://typedoc.org/api/classes/Models.SomeType.html) +`undefined` \| [`SomeType`](https://typedoc.org/api/classes/SomeType.html) #### getDescriptionForReflection() @@ -1171,7 +1172,7 @@ Please note that partials: | Parameter | Type | | :------ | :------ | -| `group` | [`ReflectionCategory`](https://typedoc.org/api/types/Models.ReflectionCategory.html) \| [`ReflectionGroup`](https://typedoc.org/api/classes/Models.ReflectionGroup.html) | +| `group` | [`ReflectionCategory`](https://typedoc.org/api/types/ReflectionCategory.DeclarationOption.html) \| [`ReflectionGroup`](https://typedoc.org/api/classes/ReflectionGroup.html) | ##### Returns @@ -1185,7 +1186,7 @@ Please note that partials: | Parameter | Type | | :------ | :------ | -| `model` | [`SomeType`](https://typedoc.org/api/classes/Models.SomeType.html) | +| `model` | [`SomeType`](https://typedoc.org/api/classes/SomeType.html) | | `options`? | `object` | | `options.isTarget`? | `boolean` | @@ -1229,7 +1230,7 @@ Please note that partials: | Parameter | Type | | :------ | :------ | -| `model` | [`ParameterReflection`](https://typedoc.org/api/classes/Models.ParameterReflection.html) | +| `model` | [`ParameterReflection`](https://typedoc.org/api/classes/ParameterReflection.html) | ##### Returns @@ -1244,7 +1245,7 @@ Please note that partials: | Parameter | Type | | :------ | :------ | | `stringWithPlaceholders` | `string` | -| `page` | [`MarkdownPageEvent`](/api-docs/Class.MarkdownPageEvent.mdx)\<[`Reflection`](https://typedoc.org/api/classes/Models.Reflection.html)\> | +| `page` | [`MarkdownPageEvent`](/api-docs/Class.MarkdownPageEvent.mdx)\<[`Reflection`](https://typedoc.org/api/classes/Reflection.html)\> | ##### Returns @@ -1272,7 +1273,7 @@ Please note that partials: | Parameter | Type | | :------ | :------ | -| `reflectionFlags` | [`ReflectionFlags`](https://typedoc.org/api/classes/Models.ReflectionFlags.html) | +| `reflectionFlags` | [`ReflectionFlags`](https://typedoc.org/api/classes/ReflectionFlags.html) | ##### Returns @@ -1286,7 +1287,7 @@ Please note that partials: | Parameter | Type | | :------ | :------ | -| `model`? | [`SomeType`](https://typedoc.org/api/classes/Models.SomeType.html) | +| `model`? | [`SomeType`](https://typedoc.org/api/classes/SomeType.html) | ##### Returns @@ -1300,7 +1301,7 @@ Please note that partials: | Parameter | Type | | :------ | :------ | -| `model` | [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html) \| [`SignatureReflection`](https://typedoc.org/api/classes/Models.SignatureReflection.html) | +| `model` | [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html) \| [`SignatureReflection`](https://typedoc.org/api/classes/SignatureReflection.html) | ##### Returns diff --git a/docs/pages/api-docs/Document.Customizing-Output.mdx b/docs/pages/api-docs/Document.Customizing-Output.mdx index b26cd415..af2fb407 100644 --- a/docs/pages/api-docs/Document.Customizing-Output.mdx +++ b/docs/pages/api-docs/Document.Customizing-Output.mdx @@ -1,16 +1,22 @@ # Customizing Output It is possible to customize the output of the generated markdown files by creating local plugins. - All these concepts follow an adapted version of [TypeDoc's core customization implementation](https://github.com/TypeStrong/typedoc/blob/master/internal-docs/custom-themes.md). +See the [Local Plugins](/api-docs/Document.Local-Plugins) guide for implementation details. + ## Hooks -Hooks allows strings to be injected into the output in specific locations and are the most basic form form of customization. +Hooks allows strings to be injected into the output in specific locations and are the most basic form of customization. -```ts filename="custom-theme.ts" -// Add a hook to insert markdown at the top of the page. -export function load(app: MarkdownApplication) { +### Example + +```ts filename="custom-plugin.mjs" +// @ts-check +/** + * @param {import('typedoc-plugin-markdown').MarkdownApplication} app + */ +export function load(app) { app.renderer.markdownHooks.on('page.end', () => `**Generated using \`page.end\` hook**`); } ``` @@ -23,24 +29,78 @@ export function load(app: MarkdownApplication) { Events are more powerful than hooks and allow for more complex customizations and provide a context that can be used to modify the output. -```ts filename="custom-plugin.ts" -export function load(app: MarkdownApplication) { - app.renderer.on(MarkdownPageEvent.END, (page: MarkdownPageEvent) => { - page.contents = page.contents.replace('foo', 'bar'); - }); +### Renderer Events + +Renderer events are emitted at the beginning (before pages are rendered) and end (after pages are rendered) of the rendering process. +You would typically use this event to modify urls or navigation structure. + +#### Example + +```ts filename="custom-plugin.mjs" +// @ts-check +/** + * @param {import('typedoc-plugin-markdown').MarkdownApplication} app + */ +export function load(app) { + app.renderer.on( + MarkdownRendererEvent.BEGIN, + /** + * @param {import('typedoc-plugin-markdown').MarkdownRendererEvent} renderer + */ + (renderer) => { + renderer.urls = event.urls.map((urlMapping) => { + const newUrl = urlMapping.url.replace('foo', 'bar'); + urlMapping.url = newUrl; + urlMapping.model.url = newUrl; // also required + return urlMapping; + }); + }, + ); } ``` -### See +#### See + +- [MarkdownRendererEvent](/api-docs/Class.MarkdownRendererEvent). + +### Page Events -- [MarkdownRendererEvent](https://typedoc-plugin-markdown.org/api-docs/Class.MarkdownRendererEvent). -- [MarkdownPageEvent](https://typedoc-plugin-markdown.org/api-docs/Class.MarkdownPageEvent). +Page events emitted before and after the markdown of each page is rendered. +You would typically use this event to modify content of a page. + +#### Example + +```ts filename="custom-plugin.mjs" +// @ts-check +/** + * @param {import('typedoc-plugin-markdown').MarkdownApplication} app + */ +export function load(app) { + app.renderer.on( + MarkdownPageEvent.BEGIN, + /** + * @param {import('typedoc-plugin-markdown').MarkdownPageEvent} page + */ + (page) => { + page.contents = page.contents.replace('foo', 'bar'); + }, + ); +} +``` + +#### See + +- [MarkdownPageEvent](/api-docs/Class.MarkdownPageEvent). ## Async Jobs Async jobs are used to perform asynchronous tasks before or after rendering with a provided context. -```ts filename="custom-plugin.ts" +```ts filename="custom-plugin.mjs" +// @ts-check +/** + * @param {import('typedoc-plugin-markdown').MarkdownApplication} app + */ export function load(app: MarkdownApplication) { app.renderer.preRenderAsyncJobs.push(async (renderer) => { await doSomethingAsync(renderer); @@ -58,12 +118,12 @@ If there are some specific customization not achievable with hooks or events the This implementation follows an adapted version of [TypeDoc's custom theming implementation](https://github.com/TypeStrong/typedoc/blob/master/internal-docs/custom-themes.md). -In theory all available templates, partials and helpers can be overriden with custom implementations. +### Example This code defines a new theme called “customTheme”: -```ts filename="custom-plugin.ts" -export function load(app: MarkdownApplication) { +```ts +export function load(app) { app.renderer.defineTheme('customTheme', MyMarkdownTheme); } @@ -81,7 +141,7 @@ The theme can then be consumed by the `theme` option: The themes can be extended to provide custom partials, helpers and templates by proving a custom render context class. -```ts filename="custom-theme.ts" +```ts class MyMarkdownTheme extends MarkdownTheme { getRenderContext(page) { return new MyMarkdownThemeContext(this, page, this.application.options); @@ -118,9 +178,7 @@ Use my new helper - ${this.helpers.newHelper()} } ``` -Please see the [Custom Theme API](/api-docs#custom-theme) for more information. - ### See -- [MarkdownTheme](https://typedoc-plugin-markdown.org/api-docs/Class.MarkdownTheme). -- [MarkdownThemeContext](https://typedoc-plugin-markdown.org/api-docs/Class.MarkdownThemeContext). +- [MarkdownTheme](/api-docs/Class.MarkdownTheme). +- [MarkdownThemeContext](/api-docs/Class.MarkdownThemeContext). diff --git a/docs/pages/api-docs/Document.Local-Plugins.mdx b/docs/pages/api-docs/Document.Local-Plugins.mdx index a5681381..e9c8627e 100644 --- a/docs/pages/api-docs/Document.Local-Plugins.mdx +++ b/docs/pages/api-docs/Document.Local-Plugins.mdx @@ -17,7 +17,7 @@ export function load(app) { } ``` -The plugin can then be consumed by adding the path to the plugin in the typedoc.json file: +The plugin can then be consumed by adding the path to the plugin in your `typedoc.json` file: ```json filename="typedoc.json" { @@ -25,7 +25,7 @@ The plugin can then be consumed by adding the path to the plugin in the typedoc. } ``` -Note plugins can either be consumed as either CommonJs or ESM. +Note plugins can either be consumed as CommonJs or ESM. ## See diff --git a/docs/pages/api-docs/Document.Navigation.mdx b/docs/pages/api-docs/Document.Utilizing-Navigation.mdx similarity index 97% rename from docs/pages/api-docs/Document.Navigation.mdx rename to docs/pages/api-docs/Document.Utilizing-Navigation.mdx index 744d2e47..5ab82ae8 100644 --- a/docs/pages/api-docs/Document.Navigation.mdx +++ b/docs/pages/api-docs/Document.Utilizing-Navigation.mdx @@ -1,4 +1,4 @@ -# Navigation +# Utilizing Navigation If required, a navigation model can be provided to the output. This is useful if you want to provide a custom sidebar/navigation implementation (if relevant to your environment). diff --git a/docs/pages/api-docs/Interface.MarkdownApplication.mdx b/docs/pages/api-docs/Interface.MarkdownApplication.mdx new file mode 100644 index 00000000..e8a8cc37 --- /dev/null +++ b/docs/pages/api-docs/Interface.MarkdownApplication.mdx @@ -0,0 +1,19 @@ +# MarkdownApplication + +This interface is essentially an extended typing of TypeDoc's [`Application`](https://typedoc.org/api/classes/Application.html) instance.`` + +## Extends + +- [`Application`](https://typedoc.org/api/classes/Application.html) + +## Properties + +### renderer + +> **renderer**: [`MarkdownRenderer`](/api-docs/Interface.MarkdownRenderer.mdx) + +Re-types the `renderer` instance to [`MarkdownRenderer`](/api-docs/Interface.MarkdownRenderer.mdx). + +#### Overrides + +`Application.renderer` diff --git a/docs/pages/api-docs/Interface.MarkdownRenderer.mdx b/docs/pages/api-docs/Interface.MarkdownRenderer.mdx new file mode 100644 index 00000000..e43b03ec --- /dev/null +++ b/docs/pages/api-docs/Interface.MarkdownRenderer.mdx @@ -0,0 +1,39 @@ +# MarkdownRenderer + +An extended typing of TypeDoc's [`Renderer`](https://typedoc.org/api/classes/Renderer.html) class that includes updated typings for hooks and async jobs. + +## Extends + +- [`Renderer`](https://typedoc.org/api/classes/Renderer.html) + +## Properties + +### markdownHooks + +> **markdownHooks**: [`EventHooks`](https://typedoc.org/api/classes/EventHooks.html)\<[`MarkdownRendererHooks`](/api-docs/Interface.MarkdownRendererHooks.mdx), `string`\> + +Replaces the event hooks typings the [`MarkdownRendererHooks`](/api-docs/Interface.MarkdownRendererHooks.mdx) used by the plugin. + +*** + +### preRenderAsyncJobs + +> **preRenderAsyncJobs**: (`output`) => `Promise`\<`void`\>[] + +Re-types the returned argument argument to [`MarkdownRendererEvent`](/api-docs/Class.MarkdownRendererEvent.mdx). + +#### Overrides + +`Renderer.preRenderAsyncJobs` + +*** + +### postRenderAsyncJobs + +> **postRenderAsyncJobs**: (`output`) => `Promise`\<`void`\>[] + +Re-types the returned argument argument to [`MarkdownRendererEvent`](/api-docs/Class.MarkdownRendererEvent.mdx). + +#### Overrides + +`Renderer.postRenderAsyncJobs` diff --git a/docs/pages/api-docs/_meta.js b/docs/pages/api-docs/_meta.js index 862c1a65..8e3f318e 100644 --- a/docs/pages/api-docs/_meta.js +++ b/docs/pages/api-docs/_meta.js @@ -6,20 +6,26 @@ export default { }, 'Document.Local-Plugins': 'Local Plugins', 'Document.Customizing-Output': 'Customizing Output', - 'Document.Navigation': 'Navigation', - Classes: { + 'Document.Utilizing-Navigation': 'Utilizing Navigation', + Events: { type: 'separator', - title: 'Classes', + title: 'Events', }, 'Class.MarkdownPageEvent': 'MarkdownPageEvent', 'Class.MarkdownRendererEvent': 'MarkdownRendererEvent', - 'Class.MarkdownThemeContext': 'MarkdownThemeContext', + 'Theme Classes': { + type: 'separator', + title: 'Theme Classes', + }, 'Class.MarkdownTheme': 'MarkdownTheme', + 'Class.MarkdownThemeContext': 'MarkdownThemeContext', Interfaces: { type: 'separator', title: 'Interfaces', }, + 'Interface.MarkdownApplication': 'MarkdownApplication', 'Interface.MarkdownRendererHooks': 'MarkdownRendererHooks', + 'Interface.MarkdownRenderer': 'MarkdownRenderer', 'Interface.PluginOptions': 'PluginOptions', 'Interface.UrlMapping': 'UrlMapping', 'Interface.NavigationItem': 'NavigationItem', diff --git a/docs/pages/api-docs/index.mdx b/docs/pages/api-docs/index.mdx index 6a714d2c..6d9f64eb 100644 --- a/docs/pages/api-docs/index.mdx +++ b/docs/pages/api-docs/index.mdx @@ -9,22 +9,29 @@ If you are interested more generally in the TypeDoc API please visit [https://ty | :------ | :------ | | [Local Plugins](/api-docs/Document.Local-Plugins.mdx) | How to write local plugins to consume APIs. | | [Customizing Output](/api-docs/Document.Customizing-Output.mdx) | How to extend and customize output. | -| [Navigation](/api-docs/Document.Navigation.mdx) | How to create a custom navigation structure. | +| [Utilizing Navigation](/api-docs/Document.Utilizing-Navigation.mdx) | How to create a custom navigation structure. | -## Classes +## Events | Class | Description | | :------ | :------ | -| [MarkdownPageEvent](/api-docs/Class.MarkdownPageEvent.mdx) | An event emitted by before and after the markup of a page is rendered. | +| [MarkdownPageEvent](/api-docs/Class.MarkdownPageEvent.mdx) | An event emitted before and after the markdown of a page is rendered. | | [MarkdownRendererEvent](/api-docs/Class.MarkdownRendererEvent.mdx) | An event emitted at the beginning and end of the rendering process. | -| [MarkdownThemeContext](/api-docs/Class.MarkdownThemeContext.mdx) | The theme context class that is provided as context on the rendering of every page. It is heavily influenced by the equivalent [DefaultThemeRenderContext](https://typedoc.org/api/classes/DefaultThemeRenderContext.html) from the default theme. | -| [MarkdownTheme](/api-docs/Class.MarkdownTheme.mdx) | The main theme class for the plugin. The class controls how TypeDoc models are mapped to files and templates and extends TypeDoc's base Theme class. | + +## Theme Classes + +| Class | Description | +| :------ | :------ | +| [MarkdownTheme](/api-docs/Class.MarkdownTheme.mdx) | The main theme class for the plugin. | +| [MarkdownThemeContext](/api-docs/Class.MarkdownThemeContext.mdx) | The theme context class that is provided as context on the rendering of every page. | ## Interfaces | Interface | Description | | :------ | :------ | +| [MarkdownApplication](/api-docs/Interface.MarkdownApplication.mdx) | This interface is essentially an extended typing of TypeDoc's [`Application`](https://typedoc.org/api/classes/Application.html) instance.`` | | [MarkdownRendererHooks](/api-docs/Interface.MarkdownRendererHooks.mdx) | Describes the hooks available to inject output in the markdown theme. | +| [MarkdownRenderer](/api-docs/Interface.MarkdownRenderer.mdx) | An extended typing of TypeDoc's [`Renderer`](https://typedoc.org/api/classes/Renderer.html) class that includes updated typings for hooks and async jobs. | | [PluginOptions](/api-docs/Interface.PluginOptions.mdx) | Describes the options declared by the plugin. | | [UrlMapping](/api-docs/Interface.UrlMapping.mdx) | The model used to define the URL mapping structure. | | [NavigationItem](/api-docs/Interface.NavigationItem.mdx) | The model used to define the navigation structure. | diff --git a/docs/pages/docs/changelog/v4.1.mdx b/docs/pages/docs/changelog/v4.1.mdx index eed45007..25943f4e 100644 --- a/docs/pages/docs/changelog/v4.1.mdx +++ b/docs/pages/docs/changelog/v4.1.mdx @@ -14,8 +14,7 @@ This release contains required internal api fixes and theme updates to support T - Theme support for TypeDoc's 0.26 localization model. - Theme support for TypeDoc's 0.26 documents implementation. - Exposed a new key `"htmlTable"` to formatting options enabling block elements to render as intended inside table cells. - Affects all existing formatting options. Fixes - [(#618)](https://github.com/typedoc2md/typedoc-plugin-markdown/issues/618). + Affects all existing formatting options. - Added new formatting options , and diff --git a/docs/pages/docs/options.mdx b/docs/pages/docs/options.mdx index 316e88a5..20ce763a 100644 --- a/docs/pages/docs/options.mdx +++ b/docs/pages/docs/options.mdx @@ -25,8 +25,8 @@ Options that are used to configure how files are output. Options that are used to configure how the output is structured and displayed. - [--hidePageHeader](./options/display-options.mdx#--hidepageheader) -- [--hidePageTitle](./options/display-options.mdx#--hidepagetitle) - [--hideBreadcrumbs](./options/display-options.mdx#--hidebreadcrumbs) +- [--hidePageTitle](./options/display-options.mdx#--hidepagetitle) - [--hideGroupHeadings](./options/display-options.mdx#--hidegroupheadings) - [--useCodeBlocks](./options/display-options.mdx#--usecodeblocks) - [--expandObjects](./options/display-options.mdx#--expandobjects) @@ -49,5 +49,5 @@ Options that are used for general configuration and utility purposes. - [--anchorPrefix](./options/utility-options.mdx#--anchorprefix) - [--useHTMLAnchors](./options/utility-options.mdx#--usehtmlanchors) - [--preserveAnchorCasing](./options/utility-options.mdx#--preserveanchorcasing) -- [--navigationModel](./options/utility-options.mdx#--navigationmodel) - [--textContentMappings](./options/utility-options.mdx#--textcontentmappings) +- [--navigationModel](./options/utility-options.mdx#--navigationmodel) diff --git a/docs/pages/docs/options/display-options.mdx b/docs/pages/docs/options/display-options.mdx index b0610495..8f50c816 100644 --- a/docs/pages/docs/options/display-options.mdx +++ b/docs/pages/docs/options/display-options.mdx @@ -16,27 +16,27 @@ Options that are used to configure how the output is structured and displayed. } ``` -## --hidePageTitle +## --hideBreadcrumbs -Do not print page title. +Do not print breadcrumbs. > Accepts a boolean value. Defaults to `false`. ```json filename="typedoc.json" { - "hidePageTitle": false + "hideBreadcrumbs": false } ``` -## --hideBreadcrumbs +## --hidePageTitle -Do not print breadcrumbs. +Do not print page title. > Accepts a boolean value. Defaults to `false`. ```json filename="typedoc.json" { - "hideBreadcrumbs": false + "hidePageTitle": false } ``` diff --git a/docs/pages/docs/options/file-options.mdx b/docs/pages/docs/options/file-options.mdx index 0117bfe8..cf06ecd1 100644 --- a/docs/pages/docs/options/file-options.mdx +++ b/docs/pages/docs/options/file-options.mdx @@ -108,11 +108,12 @@ Typically markdown files are recognised by the `.md` or `.markdown` file extensi > Accepts a string value. Defaults to `"README"`. -The entry page is the root page of the documentation, equivalent to `index.html` for web pages. +The `entryFileName` in this context is the root page of the documentation and each module directory. +This is essentially the equivalent to `index.html` for web pages. `README` is recognised when browsing folders on repos and Wikis and is the plugin default. `index` might be more suitable for static site generators. -The content of this file will be resolved in the following order: +The content of root documentation file will be resolved in the following order: 1. The value of the [`entryModule`](#entrymodule) option (if defined). 2. The resolved Readme file (skipped if the [`readme`](https://typedoc.org/options/input/#readme) option is set to `none`). diff --git a/docs/pages/docs/options/utility-options.mdx b/docs/pages/docs/options/utility-options.mdx index fb1bc8cd..df0c0523 100644 --- a/docs/pages/docs/options/utility-options.mdx +++ b/docs/pages/docs/options/utility-options.mdx @@ -93,6 +93,36 @@ This option can be used for engines that require the preservation of anchor link } ``` +## --textContentMappings + +Change specific text placeholders in the template. + +> + +Defines placeholder text in main template that can be customized. Includes the main page header and breadcrumbs (if displayed), +page titles and page footer. + +Default values within curly braces {} indicates a placeholder of dynamic text. + +- The `{projectName}` placeholder writes project's name . +- The `{kind}` writes the reflection kind of the page. +- The `{version}` placeholder writes package version (if includeVersion is `true`). + +If you are looking for general localization support please see [localization](). + +```json filename="typedoc.json" +{ + "textContentMappings": { + "header.title": "{projectName} {version}", + "header.docs": "Docs", + "breadcrumbs.home": "{projectName} {version}", + "title.indexPage": "{projectName} {version}", + "title.memberPage": "{kind}: {name}", + "footer.text": "" + } +} +``` + ## --navigationModel @@ -135,33 +165,3 @@ export function load(app: MarkdownApplication) { } } ``` - -## --textContentMappings - -Change specific text placeholders in the template. - -> - -Defines placeholder text in main template that can be customized. Includes the main page header and breadcrumbs (if displayed), -page titles and page footer. - -Default values within curly braces {} indicates a placeholder of dynamic text. - -- The `{projectName}` placeholder writes project's name . -- The `{kind}` writes the reflection kind of the page. -- The `{version}` placeholder writes package version (if includeVersion is `true`). - -If you are looking for general localization support please see [localization](). - -```json filename="typedoc.json" -{ - "textContentMappings": { - "header.title": "{projectName} {version}", - "header.docs": "Docs", - "breadcrumbs.home": "{projectName} {version}", - "title.indexPage": "{projectName} {version}", - "title.memberPage": "{kind}: {name}", - "footer.text": "" - } -} -``` diff --git a/docs/pages/docs/typedoc-usage.mdx b/docs/pages/docs/typedoc-usage.mdx index 17a598da..5ef0526f 100644 --- a/docs/pages/docs/typedoc-usage.mdx +++ b/docs/pages/docs/typedoc-usage.mdx @@ -29,8 +29,8 @@ Below is a list of which TypeDoc Output options are supported or not: - `--theme` Yes ✅ (theme should be MarkdownTheme instance) - `--cleanOutputDir` Yes ✅ - `--basePath` Yes ✅ -- `--hideParameterTypesInTitle` No ❌ (use [`--expandParameters`](/docs/options#expandparameters)) -- `--navigation` No ❌ (use [`--navigationModel`](/docs/options#navigationmodel)) +- `--hideParameterTypesInTitle` No ❌ (use ) +- `--navigation` No ❌ (use ) - `--titleLink` No ❌ - `--navigationLinks` No ❌ - `--sidebarLinks` No ❌ diff --git a/packages/README.md b/packages/README.md new file mode 100644 index 00000000..68c2a21f --- /dev/null +++ b/packages/README.md @@ -0,0 +1,50 @@ +# Developer Guide + +## Monorepo Overview + +This is a simple monorepo managed by [npm workspaces](https://docs.npmjs.com/cli/v7/using-npm/workspaces). + +Please view individual packages for further insights: + +- {@link typedoc-plugin-markdown} is the core package and is the package that is used to generate the markdown documentation. +- {@link typedoc-plugin-frontmatter} and {@link typedoc-plugin-remark} provide metadata or adjust the output. +- {@link typedoc-github-wiki-theme}, {@link typedoc-gitlab-wiki-theme}, + {@link typedoc-vitepress-theme} and {@link docusaurus-plugin-typedoc} target specific implementations. + +## Machine Setup + +**1. Fork and clone the repository** + +Start by forking the repository to your own GitHub account. Then, clone the repository to your local machine. Please replace `` with your actual GitHub username. + +```bash +git clone git@github.com:/typedoc-plugin-markdown.git +``` + +**2. Install dependencies** + +Navigate to the repository root and install the necessary dependencies: + +```bash +cd typedoc-plugin-markdown + +npm install +``` + +**3. Build the packages and run tests** + +Finally, you can build all the packages and run the tests to ensure everything is set up correctly. + +Build all packages in the workspace: + +```bash +npm run build +``` + +Test all packages in the workspace: + +```bash +npm run test +``` + +If the project builds and the tests run successfully you are ready to start contributing to the project. diff --git a/packages/docusaurus-plugin-typedoc/OVERVIEW.md b/packages/docusaurus-plugin-typedoc/OVERVIEW.md index dc0dc0e3..b5c1c03e 100644 --- a/packages/docusaurus-plugin-typedoc/OVERVIEW.md +++ b/packages/docusaurus-plugin-typedoc/OVERVIEW.md @@ -2,7 +2,7 @@ "typedoc-vitepress-theme" is a "theme" in the sense that it targets output for VitePress. -## What does the package do? +## What Does the Package Do? - Exposes some additional options to TypeDoc. - Presets relevant typedoc-plugin-markdown options. diff --git a/packages/docusaurus-plugin-typedoc/test/specs/__snapshots__/docusaurus.spec.ts.snap b/packages/docusaurus-plugin-typedoc/test/specs/__snapshots__/docusaurus.spec.ts.snap index 65d49abd..f0dc9dac 100644 --- a/packages/docusaurus-plugin-typedoc/test/specs/__snapshots__/docusaurus.spec.ts.snap +++ b/packages/docusaurus-plugin-typedoc/test/specs/__snapshots__/docusaurus.spec.ts.snap @@ -3,94 +3,18 @@ exports[`Docusaurus: Defaults should render docs 1`] = ` "# docusaurus-plugin-typedoc -## Enumerations - -### CommentEnum - -#### Enumeration Members - -##### Member - -> **Member**: \`0\` - -##### MemberB - -> **MemberB**: \`1\` - -## Interfaces - -### CommentInterface\\ - -Comments form module comments +## Modules -Links using \`{@link}\` inline tags. - -- [CommentInterface](index.md#commentinterfacet-1) - Links to CommentInterface -- [Links to CommentInterface.prop](index.md#prop-2) -- [Links to CommentInterface.propb](index.md#propb-2) - -#### Extended by - -- [\`CommentInterfaceExtended\`](index.md#commentinterfaceextended-1) - -#### Type Parameters - -• **T** - -#### Properties - -##### prop - -> **prop**: \`string\` - -##### propb - -> **propb**: \`T\` - -*** - -### CommentInterfaceExtended - -Comments form module comments - -Links using \`{@link}\` inline tags. - -- [CommentInterface](index.md#commentinterfacet-1) - Links to CommentInterface -- [Links to CommentInterface.prop](index.md#prop-2) -- [Links to CommentInterface.propb](index.md#propb-2) - -#### Extends - -- [\`CommentInterface\`](index.md#commentinterfacet-1) \\<[\`CommentEnum\`](index.md#commentenum-1)\\> - -#### Properties - -##### prop - -> **prop**: \`string\` - -###### Inherited from - -[\`CommentInterface\`](index.md#commentinterfacet-1) . [\`prop\`](index.md#prop-2) - -##### propb - -> **propb**: [\`CommentEnum\`](index.md#commentenum-1) - -###### Inherited from - -[\`CommentInterface\`](index.md#commentinterfacet-1) . [\`propb\`](index.md#propb-2) - -##### propc - -> **propc**: \`string\` +- [links](links/index.md) +- [module-1](module-1/index.md) +- [module-2](module-2/index.md) " `; exports[`Docusaurus: Defaults should render sidebar 1`] = ` "// @ts-check /** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */ -const typedocSidebar = { items: [{"type":"category","label":"links","items":[{"type":"category","label":"Enumerations","items":[{"type":"doc","id":"out/default/links/enumerations/CommentEnum","label":"CommentEnum"}]},{"type":"category","label":"Interfaces","items":[{"type":"doc","id":"out/default/links/interfaces/CommentInterface","label":"CommentInterface"},{"type":"doc","id":"out/default/links/interfaces/CommentInterfaceExtended","label":"CommentInterfaceExtended"}]}],"link":{"type":"doc","id":"out/default/links/index"}},{"type":"category","label":"module-1","items":[{"type":"category","label":"Classes","items":[{"type":"doc","id":"out/default/module-1/classes/ClassA","label":"ClassA"},{"type":"doc","id":"out/default/module-1/classes/ClassB","label":"ClassB"}]},{"type":"category","label":"Interfaces","items":[{"type":"doc","id":"out/default/module-1/interfaces/InterfaceA","label":"InterfaceA"},{"type":"doc","id":"out/default/module-1/interfaces/InterfaceB","label":"InterfaceB"}]}],"link":{"type":"doc","id":"out/default/module-1/index"}},{"type":"category","label":"module-2","items":[{"type":"category","label":"Classes","items":[{"type":"doc","id":"out/default/module-2/classes/ClassA","label":"ClassA"},{"type":"doc","id":"out/default/module-2/classes/ClassB","label":"ClassB"}]},{"type":"category","label":"Interfaces","items":[{"type":"doc","id":"out/default/module-2/interfaces/InterfaceA","label":"InterfaceA"},{"type":"doc","id":"out/default/module-2/interfaces/InterfaceB","label":"InterfaceB"}]}],"link":{"type":"doc","id":"out/default/module-2/index"}},{"type":"category","label":"Classes","items":[{"type":"doc","id":"out/default/classes/ClassA","label":"ClassA"},{"type":"doc","id":"out/default/classes/ClassB","label":"ClassB"}]},{"type":"category","label":"Interfaces","items":[{"type":"doc","id":"out/default/interfaces/InterfaceA","label":"InterfaceA"},{"type":"doc","id":"out/default/interfaces/InterfaceB","label":"InterfaceB"}]},{"type":"category","label":"links","items":[{"type":"category","label":"Enumerations","items":[{"type":"doc","id":"out/default/links/enumerations/CommentEnum","label":"CommentEnum"}]},{"type":"category","label":"Interfaces","items":[{"type":"doc","id":"out/default/links/interfaces/CommentInterface","label":"CommentInterface"},{"type":"doc","id":"out/default/links/interfaces/CommentInterfaceExtended","label":"CommentInterfaceExtended"}]}],"link":{"type":"doc","id":"out/default/links/index"}},{"type":"category","label":"module-1","items":[{"type":"category","label":"Classes","items":[{"type":"doc","id":"out/default/module-1/classes/ClassA","label":"ClassA"},{"type":"doc","id":"out/default/module-1/classes/ClassB","label":"ClassB"}]},{"type":"category","label":"Interfaces","items":[{"type":"doc","id":"out/default/module-1/interfaces/InterfaceA","label":"InterfaceA"},{"type":"doc","id":"out/default/module-1/interfaces/InterfaceB","label":"InterfaceB"}]}],"link":{"type":"doc","id":"out/default/module-1/index"}},{"type":"category","label":"module-2","items":[{"type":"category","label":"Classes","items":[{"type":"doc","id":"out/default/module-2/classes/ClassA","label":"ClassA"},{"type":"doc","id":"out/default/module-2/classes/ClassB","label":"ClassB"}]},{"type":"category","label":"Interfaces","items":[{"type":"doc","id":"out/default/module-2/interfaces/InterfaceA","label":"InterfaceA"},{"type":"doc","id":"out/default/module-2/interfaces/InterfaceB","label":"InterfaceB"}]}],"link":{"type":"doc","id":"out/default/module-2/index"}},{"type":"category","label":"Classes","items":[{"type":"doc","id":"out/default/classes/ClassA","label":"ClassA"},{"type":"doc","id":"out/default/classes/ClassB","label":"ClassB"}]},{"type":"category","label":"Interfaces","items":[{"type":"doc","id":"out/default/interfaces/InterfaceA","label":"InterfaceA"},{"type":"doc","id":"out/default/interfaces/InterfaceB","label":"InterfaceB"}]}]}; +const typedocSidebar = { items: [{"type":"category","label":"links","items":[{"type":"category","label":"Enumerations","items":[{"type":"doc","id":"out/default/links/enumerations/CommentEnum","label":"CommentEnum"}]},{"type":"category","label":"Interfaces","items":[{"type":"doc","id":"out/default/links/interfaces/CommentInterface","label":"CommentInterface"},{"type":"doc","id":"out/default/links/interfaces/CommentInterfaceExtended","label":"CommentInterfaceExtended"}]}],"link":{"type":"doc","id":"out/default/links/index"}},{"type":"category","label":"module-1","items":[{"type":"category","label":"Classes","items":[{"type":"doc","id":"out/default/module-1/classes/ClassA","label":"ClassA"},{"type":"doc","id":"out/default/module-1/classes/ClassB","label":"ClassB"}]},{"type":"category","label":"Interfaces","items":[{"type":"doc","id":"out/default/module-1/interfaces/InterfaceA","label":"InterfaceA"},{"type":"doc","id":"out/default/module-1/interfaces/InterfaceB","label":"InterfaceB"}]}],"link":{"type":"doc","id":"out/default/module-1/index"}},{"type":"category","label":"module-2","items":[{"type":"category","label":"Classes","items":[{"type":"doc","id":"out/default/module-2/classes/ClassA","label":"ClassA"},{"type":"doc","id":"out/default/module-2/classes/ClassB","label":"ClassB"}]},{"type":"category","label":"Interfaces","items":[{"type":"doc","id":"out/default/module-2/interfaces/InterfaceA","label":"InterfaceA"},{"type":"doc","id":"out/default/module-2/interfaces/InterfaceB","label":"InterfaceB"}]}],"link":{"type":"doc","id":"out/default/module-2/index"}}]}; module.exports = typedocSidebar.items;" `; @@ -134,13 +58,13 @@ Comments form module comments Links using \`{@link}\` inline tags. -- [CommentInterface](index.md#commentinterfacet-1) - Links to CommentInterface -- [Links to CommentInterface.prop](index.md#prop-2) -- [Links to CommentInterface.propb](index.md#propb-2) +- [CommentInterface](index.md#commentinterfacet) - Links to CommentInterface +- [Links to CommentInterface.prop](index.md#prop) +- [Links to CommentInterface.propb](index.md#propb) #### Extended by -- [\`CommentInterfaceExtended\`](index.md#commentinterfaceextended-1) +- [\`CommentInterfaceExtended\`](index.md#commentinterfaceextended) #### Type Parameters @@ -164,13 +88,13 @@ Comments form module comments Links using \`{@link}\` inline tags. -- [CommentInterface](index.md#commentinterfacet-1) - Links to CommentInterface -- [Links to CommentInterface.prop](index.md#prop-2) -- [Links to CommentInterface.propb](index.md#propb-2) +- [CommentInterface](index.md#commentinterfacet) - Links to CommentInterface +- [Links to CommentInterface.prop](index.md#prop) +- [Links to CommentInterface.propb](index.md#propb) #### Extends -- [\`CommentInterface\`](index.md#commentinterfacet-1) \\<[\`CommentEnum\`](index.md#commentenum-1)\\> +- [\`CommentInterface\`](index.md#commentinterfacet) \\<[\`CommentEnum\`](index.md#commentenum)\\> #### Properties @@ -180,15 +104,15 @@ Links using \`{@link}\` inline tags. ###### Inherited from -[\`CommentInterface\`](index.md#commentinterfacet-1) . [\`prop\`](index.md#prop-2) +[\`CommentInterface\`](index.md#commentinterfacet) . [\`prop\`](index.md#prop) ##### propb -> **propb**: [\`CommentEnum\`](index.md#commentenum-1) +> **propb**: [\`CommentEnum\`](index.md#commentenum) ###### Inherited from -[\`CommentInterface\`](index.md#commentinterfacet-1) . [\`propb\`](index.md#propb-2) +[\`CommentInterface\`](index.md#commentinterfacet) . [\`propb\`](index.md#propb) ##### propc @@ -200,280 +124,6 @@ exports[`Docusaurus: Global Members should render sidebar 1`] = ` "// @ts-check /** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */ const typedocSidebar = { items: [ - { - "type": "category", - "label": "links", - "items": [ - { - "type": "category", - "label": "Enumerations", - "items": [ - { - "type": "doc", - "id": "out/global-members/links/enumerations/CommentEnum", - "label": "CommentEnum" - } - ] - }, - { - "type": "category", - "label": "Interfaces", - "items": [ - { - "type": "doc", - "id": "out/global-members/links/interfaces/CommentInterface", - "label": "CommentInterface" - }, - { - "type": "doc", - "id": "out/global-members/links/interfaces/CommentInterfaceExtended", - "label": "CommentInterfaceExtended" - } - ] - } - ], - "link": { - "type": "doc", - "id": "out/global-members/links/index" - } - }, - { - "type": "category", - "label": "module-1", - "items": [ - { - "type": "category", - "label": "Classes", - "items": [ - { - "type": "doc", - "id": "out/global-members/module-1/classes/ClassA", - "label": "ClassA" - }, - { - "type": "doc", - "id": "out/global-members/module-1/classes/ClassB", - "label": "ClassB" - } - ] - }, - { - "type": "category", - "label": "Interfaces", - "items": [ - { - "type": "doc", - "id": "out/global-members/module-1/interfaces/InterfaceA", - "label": "InterfaceA" - }, - { - "type": "doc", - "id": "out/global-members/module-1/interfaces/InterfaceB", - "label": "InterfaceB" - } - ] - } - ], - "link": { - "type": "doc", - "id": "out/global-members/module-1/index" - } - }, - { - "type": "category", - "label": "module-2", - "items": [ - { - "type": "category", - "label": "Classes", - "items": [ - { - "type": "doc", - "id": "out/global-members/module-2/classes/ClassA", - "label": "ClassA" - }, - { - "type": "doc", - "id": "out/global-members/module-2/classes/ClassB", - "label": "ClassB" - } - ] - }, - { - "type": "category", - "label": "Interfaces", - "items": [ - { - "type": "doc", - "id": "out/global-members/module-2/interfaces/InterfaceA", - "label": "InterfaceA" - }, - { - "type": "doc", - "id": "out/global-members/module-2/interfaces/InterfaceB", - "label": "InterfaceB" - } - ] - } - ], - "link": { - "type": "doc", - "id": "out/global-members/module-2/index" - } - }, - { - "type": "category", - "label": "Classes", - "items": [ - { - "type": "doc", - "id": "out/global-members/classes/ClassA", - "label": "ClassA" - }, - { - "type": "doc", - "id": "out/global-members/classes/ClassB", - "label": "ClassB" - } - ] - }, - { - "type": "category", - "label": "Interfaces", - "items": [ - { - "type": "doc", - "id": "out/global-members/interfaces/InterfaceA", - "label": "InterfaceA" - }, - { - "type": "doc", - "id": "out/global-members/interfaces/InterfaceB", - "label": "InterfaceB" - } - ] - }, - { - "type": "category", - "label": "links", - "items": [ - { - "type": "category", - "label": "Enumerations", - "items": [ - { - "type": "doc", - "id": "out/global-members/links/enumerations/CommentEnum", - "label": "CommentEnum" - } - ] - }, - { - "type": "category", - "label": "Interfaces", - "items": [ - { - "type": "doc", - "id": "out/global-members/links/interfaces/CommentInterface", - "label": "CommentInterface" - }, - { - "type": "doc", - "id": "out/global-members/links/interfaces/CommentInterfaceExtended", - "label": "CommentInterfaceExtended" - } - ] - } - ], - "link": { - "type": "doc", - "id": "out/global-members/links/index" - } - }, - { - "type": "category", - "label": "module-1", - "items": [ - { - "type": "category", - "label": "Classes", - "items": [ - { - "type": "doc", - "id": "out/global-members/module-1/classes/ClassA", - "label": "ClassA" - }, - { - "type": "doc", - "id": "out/global-members/module-1/classes/ClassB", - "label": "ClassB" - } - ] - }, - { - "type": "category", - "label": "Interfaces", - "items": [ - { - "type": "doc", - "id": "out/global-members/module-1/interfaces/InterfaceA", - "label": "InterfaceA" - }, - { - "type": "doc", - "id": "out/global-members/module-1/interfaces/InterfaceB", - "label": "InterfaceB" - } - ] - } - ], - "link": { - "type": "doc", - "id": "out/global-members/module-1/index" - } - }, - { - "type": "category", - "label": "module-2", - "items": [ - { - "type": "category", - "label": "Classes", - "items": [ - { - "type": "doc", - "id": "out/global-members/module-2/classes/ClassA", - "label": "ClassA" - }, - { - "type": "doc", - "id": "out/global-members/module-2/classes/ClassB", - "label": "ClassB" - } - ] - }, - { - "type": "category", - "label": "Interfaces", - "items": [ - { - "type": "doc", - "id": "out/global-members/module-2/interfaces/InterfaceA", - "label": "InterfaceA" - }, - { - "type": "doc", - "id": "out/global-members/module-2/interfaces/InterfaceB", - "label": "InterfaceB" - } - ] - } - ], - "link": { - "type": "doc", - "id": "out/global-members/module-2/index" - } - }, { "type": "category", "label": "Classes", diff --git a/packages/typedoc-github-wiki-theme/OVERVIEW.md b/packages/typedoc-github-wiki-theme/OVERVIEW.md index d90cb245..379b90bc 100644 --- a/packages/typedoc-github-wiki-theme/OVERVIEW.md +++ b/packages/typedoc-github-wiki-theme/OVERVIEW.md @@ -2,7 +2,7 @@ "typedoc-github-wiki-theme" is a "theme" in the sense that it targets output for GitHub Wiki. -## What does the package do? +## What Does the Package Do? - Exposes some additional options to TypeDoc. - Presets relevant typedoc-plugin-markdown options. diff --git a/packages/typedoc-gitlab-wiki-theme/OVERVIEW.md b/packages/typedoc-gitlab-wiki-theme/OVERVIEW.md index bd4c6237..00fccc17 100644 --- a/packages/typedoc-gitlab-wiki-theme/OVERVIEW.md +++ b/packages/typedoc-gitlab-wiki-theme/OVERVIEW.md @@ -2,7 +2,7 @@ "typedoc-gitlab-wiki-theme" is a "theme" in the sense that it targets output for GitLab Wiki. -## What does the package do? +## What Does the Package Do? - Exposes some additional options to TypeDoc. - Presets relevant typedoc-plugin-markdown options. diff --git a/packages/typedoc-plugin-frontmatter/OVERVIEW.md b/packages/typedoc-plugin-frontmatter/OVERVIEW.md index cfa049e5..a1427d41 100644 --- a/packages/typedoc-plugin-frontmatter/OVERVIEW.md +++ b/packages/typedoc-plugin-frontmatter/OVERVIEW.md @@ -2,7 +2,7 @@ "typedoc-plugin-frontmatter" is a utility package the prepends frontmatter to pages. -## What does the package do? +## What Does the Package Do? - Exposes some additional options to TypeDoc. - Prepends a YAML block to pages. diff --git a/packages/typedoc-plugin-markdown/.docs/typedoc.json b/packages/typedoc-plugin-markdown/.docs/typedoc.json deleted file mode 100644 index c9a205f7..00000000 --- a/packages/typedoc-plugin-markdown/.docs/typedoc.json +++ /dev/null @@ -1,106 +0,0 @@ -{ - "entryPoints": ["../src/public-api.ts"], - "out": "../../../docs/pages/api-docs", - "plugin": [ - "typedoc-plugin-markdown", - "./plugins/typedoc-nextra.mjs", - "./plugins/typedoc-ignore-typeparam.mjs" - ], - "outputFileStrategy": "members", - "fileExtension": ".mdx", - "publicPath": "/api-docs", - "indexFormat": "table", - "readme": "none", - "entryFileName": "index.md", - "hideBreadcrumbs": true, - "hidePageHeader": true, - "excludeGroups": false, - "expandObjects": false, - "parametersFormat": "table", - "expandParameters": false, - "groupOrder": ["Documents", "Events", "Classes"], - "tableColumnSettings": { - "hideOverrides": true, - "hideModifiers": true, - "hideDefaults": true, - "hideSources": true, - "leftAlignHeaders": true - }, - - "useCodeBlocks": false, - "textContentMappings": { - "title.memberPage": "{name}" - }, - "flattenOutputFiles": true, - "sortEntryPoints": false, - "name": "API", - "sort": ["required-first", "source-order"], - "includeVersion": false, - "categoryOrder": [ - "Application", - "Theme", - "Options", - "Page Partials", - "Container Partials", - "Member Partials", - "Comment Partials", - "Type Partials", - "*" - ], - "disableSources": true, - "excludeInternal": true, - "excludeExternals": true, - "excludePrivate": true, - "navigation": { - "includeCategories": true, - "includeGroups": false - }, - "externalSymbolLinkMappings": { - "typedoc": { - "ArrayType": "https://typedoc.org/api/types/Models.ArrayType.html", - "Application": "https://typedoc.org/api/classes/Application.html", - "Comment": "https://typedoc.org/api/types/Models.Comment.html", - "CommentDisplayPart": "https://typedoc.org/api/types/Models.CommentDisplayPart.html", - "ConditionalType": "https://typedoc.org/api/types/Models.ConditionalType.html", - "ContainerReflection": "https://typedoc.org/api/classes/Models.ContainerReflection.html", - "DeclarationHierarchy": "https://typedoc.org/api/classes/Models.DeclarationHierarchy.html", - "DeclarationReflection": "https://typedoc.org/api/classes/Models.DeclarationReflection.html", - "DefaultThemeRenderContext": "https://typedoc.org/api/classes/DefaultThemeRenderContext.html", - "Event": "https://typedoc.org/api/classes/Event.html", - "EventHooks": "https://typedoc.org/api/classes/EventHooks.html", - "IndexedAccessType": "https://typedoc.org/api/types/Models.IndexedAccessType.html", - "InferredType": "https://typedoc.org/api/types/Models.InferredType.html", - "IntersectionType": "https://typedoc.org/api/types/Models.IntersectionType.html", - "IntrinsicType": "https://typedoc.org/api/types/Models.IntrinsicType.html", - "LiteralType": "https://typedoc.org/api/types/Models.LiteralType.html", - "NamedTupleMember": "https://typedoc.org/api/types/Models.NamedTupleMember.html", - "ManuallyValidatedOption": "https://typedoc.org/api/types/Configuration.ManuallyValidatedOption.html", - "Options": "https://typedoc.org/api/classes/Configuration.Options.html", - "PageEvent": "https://typedoc.org/api/classes/PageEvent.html", - "ParameterReflection": "https://typedoc.org/api/classes/Models.ParameterReflection.html", - "ProjectReflection": "https://typedoc.org/api/classes/Models.ProjectReflection.html", - "ReferenceReflection": "https://typedoc.org/api/classes/Models.ReferenceReflection.html", - "ReferenceType": "https://typedoc.org/api/classes/Models.ReferenceType.html", - "Renderer": "https://typedoc.org/api/classes/Renderer.html", - "RendererEvent": "https://typedoc.org/api/classes/RendererEvent.html", - "RenderTemplate": "https://typedoc.org/api/types/RenderTemplate.html", - "Reflection": "https://typedoc.org/api/classes/Models.Reflection.html", - "ReflectionCategory": "https://typedoc.org/api/types/Models.ReflectionCategory.html", - "ReflectionFlags": "https://typedoc.org/api/classes/Models.ReflectionFlags.html", - "ReflectionGroup": "https://typedoc.org/api/classes/Models.ReflectionGroup.html", - "ReflectionKind": "https://typedoc.org/api/enums/Models.ReflectionKind-1.html", - "ReflectionType": "https://typedoc.org/api/classes/Models.ReflectionType.html", - "SignatureReflection": "https://typedoc.org/api/classes/Models.SignatureReflection.html", - "SomeType": "https://typedoc.org/api/classes/Models.SomeType.html", - "TypeParameterReflection": "https://typedoc.org/api/classes/Models.TypeParameterReflection.html", - "Theme": "https://typedoc.org/api/classes/Theme.html", - "TypeDocOptions": "https://typedoc.org/api/interfaces/TypeDocOptions.html", - "TypeOperatorType": "https://typedoc.org/api/interfaces/TypeOperatorType.html", - "TupleType": "https://typedoc.org/api/classes/Models.TupleType.html", - "QueryType": "https://typedoc.org/api/types/Models.QueryType.html", - "UnknownType": "https://typedoc.org/api/types/Models.UnknownType.html", - "UnionType": "https://typedoc.org/api/types/Models.UnionType.html", - "UrlMapping": "https://typedoc.org/api/classes/UrlMapping.html" - } - } -} diff --git a/packages/typedoc-plugin-markdown/OVERVIEW.md b/packages/typedoc-plugin-markdown/OVERVIEW.md index 59a26d4d..967fb579 100644 --- a/packages/typedoc-plugin-markdown/OVERVIEW.md +++ b/packages/typedoc-plugin-markdown/OVERVIEW.md @@ -2,7 +2,7 @@ The core package of this monorepo and is the package that is used to generate the markdown documentation. -## What does the package do? +## What Does the Package Do? - Extends some methods on the TypeDoc renderer to make compatible with Markdown output. - Exposes some additional options to TypeDoc. diff --git a/packages/typedoc-plugin-markdown/package.json b/packages/typedoc-plugin-markdown/package.json index aed62a48..01bcec08 100644 --- a/packages/typedoc-plugin-markdown/package.json +++ b/packages/typedoc-plugin-markdown/package.json @@ -13,13 +13,12 @@ "build": "tsc && tsc-alias", "build-and-run": "npm run build && npm run pretest", "pretest": "fixtures -c ./test/fixtures/config.ts", - "test:md": "node test/scripts/lint.md.mjs", - "test:mdx": "node test/scripts/lint.mdx.mjs", - "test": "npm run test:md && npm run test:mdx && jest", + "validate": "node test/scripts/lint.md.mjs && node test/scripts/lint.mdx.mjs", + "test": "npm run validate && jest", "test:update": "npm run build && npm run test -- -u", "playground": "npm run build && typedoc --options ./playground/typedoc.json", "schema": "ts-node ./.scripts/schema/generate-schema.ts", - "docs": "npm run build && typedoc --options ./.docs/typedoc.json" + "docs": "npm run build && typedoc --options ./typedoc.public.json" }, "author": "Thomas Grey", "license": "MIT", diff --git a/packages/typedoc-plugin-markdown/src/_typedoc.d.ts b/packages/typedoc-plugin-markdown/src/_typedoc.d.ts index bec89358..1b052573 100644 --- a/packages/typedoc-plugin-markdown/src/_typedoc.d.ts +++ b/packages/typedoc-plugin-markdown/src/_typedoc.d.ts @@ -71,6 +71,7 @@ declare module 'typedoc' { theme_event: []; theme_extends: []; theme_extended_by: []; + theme_globals: []; theme_member: []; theme_member_plural: []; theme_modifier: []; diff --git a/packages/typedoc-plugin-markdown/src/events/markdown-page-event.ts b/packages/typedoc-plugin-markdown/src/events/markdown-page-event.ts index 97815f78..af22f626 100644 --- a/packages/typedoc-plugin-markdown/src/events/markdown-page-event.ts +++ b/packages/typedoc-plugin-markdown/src/events/markdown-page-event.ts @@ -1,17 +1,9 @@ import { Event, ProjectReflection, Reflection } from 'typedoc'; /** - * An event emitted by before and after the markup of a page is rendered. + * An event emitted before and after the markdown of a page is rendered. * - * @example - * - * ```ts - * export function load(app: MarkdownApplication) { - * app.renderer.on(MarkdownPageEvent.BEGIN, (page: MarkdownPageEvent) => { - * page.contents = page.contents.replace('foo', 'bar'); - * }); - * }); - * ``` + * @event */ export class MarkdownPageEvent< /** @ignore **/ Model = Reflection, diff --git a/packages/typedoc-plugin-markdown/src/events/markdown-renderer-event.ts b/packages/typedoc-plugin-markdown/src/events/markdown-renderer-event.ts index 6bc403b0..32a3c804 100644 --- a/packages/typedoc-plugin-markdown/src/events/markdown-renderer-event.ts +++ b/packages/typedoc-plugin-markdown/src/events/markdown-renderer-event.ts @@ -6,13 +6,7 @@ import { Event, ProjectReflection, Reflection } from 'typedoc'; /** * An event emitted at the beginning and end of the rendering process. * - * @example - * - * ```ts - * app.renderer.on(MarkdownRendererEvent.BEGIN, (event) => { - * console.log(`Render Starting for ${event.project.name}!`); - * }); - * ``` + * @event */ export class MarkdownRendererEvent extends Event { /** diff --git a/packages/typedoc-plugin-markdown/src/index.ts b/packages/typedoc-plugin-markdown/src/index.ts index d0be5c71..51a25ddd 100644 --- a/packages/typedoc-plugin-markdown/src/index.ts +++ b/packages/typedoc-plugin-markdown/src/index.ts @@ -3,7 +3,6 @@ * * @module */ - import { MarkdownTheme } from '@plugin/theme'; import { getTranslatable } from 'internationalization/translatable'; import { declarations } from 'options'; @@ -19,23 +18,22 @@ import { Renderer, Theme, } from 'typedoc'; - /** - * The function that is called by TypeDoc to bootstrap the plugin. https://typedoc.org/guides/development/#plugins. + * The function that is called by TypeDoc to bootstrap the plugin. * * Here we expose additional TypeDoc options and make some adjustments. * * This method is not intended to be consumed in any other context that via the `plugin` option. + * + * @see https://typedoc.org/guides/development/#plugins. */ export function load(app: Application) { /** * ==================== * 1. Bootstrap Options - * ==================== - */ - - /** + * * Iterate over declaration definitions and to the container. + * ==================== */ Object.entries(declarations).forEach(([name, declaration]) => { app.options.addDeclaration({ diff --git a/packages/typedoc-plugin-markdown/src/internationalization/index.ts b/packages/typedoc-plugin-markdown/src/internationalization/index.ts index 50de6829..c9c65ad6 100644 --- a/packages/typedoc-plugin-markdown/src/internationalization/index.ts +++ b/packages/typedoc-plugin-markdown/src/internationalization/index.ts @@ -1,6 +1,10 @@ /** * Exposes additional i18n keys and translations used by the theme. * + * 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). + * * @module */ export * from './locales'; diff --git a/packages/typedoc-plugin-markdown/src/internationalization/locales/en.ts b/packages/typedoc-plugin-markdown/src/internationalization/locales/en.ts index 77a1dab4..2623f732 100644 --- a/packages/typedoc-plugin-markdown/src/internationalization/locales/en.ts +++ b/packages/typedoc-plugin-markdown/src/internationalization/locales/en.ts @@ -11,6 +11,7 @@ export const translatable: TranslatableStrings = { theme_event: 'Event', theme_extends: 'Extends', theme_extended_by: 'Extended by', + theme_globals: 'Globals', theme_member: 'Member', theme_member_plural: 'Members', theme_modifier: 'Modifier', diff --git a/packages/typedoc-plugin-markdown/src/internationalization/locales/index.ts b/packages/typedoc-plugin-markdown/src/internationalization/locales/index.ts index f0a635b4..1a3fe729 100644 --- a/packages/typedoc-plugin-markdown/src/internationalization/locales/index.ts +++ b/packages/typedoc-plugin-markdown/src/internationalization/locales/index.ts @@ -1,6 +1,10 @@ /** * List of plugin specific translations per locale. * + * 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). + * * @module */ diff --git a/packages/typedoc-plugin-markdown/src/internationalization/locales/jp.ts b/packages/typedoc-plugin-markdown/src/internationalization/locales/jp.ts index c7cb6e31..d5127e5c 100644 --- a/packages/typedoc-plugin-markdown/src/internationalization/locales/jp.ts +++ b/packages/typedoc-plugin-markdown/src/internationalization/locales/jp.ts @@ -12,6 +12,7 @@ export const translatable: Partial = { theme_event: 'イベント', theme_extends: '拡張', theme_extended_by: 'によって拡張された', + theme_globals: 'グローバル変数', theme_member: 'メンバー', theme_member_plural: 'メンバー', theme_modifier: '修飾子', diff --git a/packages/typedoc-plugin-markdown/src/internationalization/locales/ko.ts b/packages/typedoc-plugin-markdown/src/internationalization/locales/ko.ts index c30346e7..59a9adae 100644 --- a/packages/typedoc-plugin-markdown/src/internationalization/locales/ko.ts +++ b/packages/typedoc-plugin-markdown/src/internationalization/locales/ko.ts @@ -11,6 +11,7 @@ export const translatable: Partial = { theme_event: '이벤트', theme_extends: '확장', theme_extended_by: '에 의해 확장됨', + theme_globals: '전역', theme_member: '멤버', theme_member_plural: '멤버들', theme_modifier: '수정자', diff --git a/packages/typedoc-plugin-markdown/src/internationalization/locales/zh.ts b/packages/typedoc-plugin-markdown/src/internationalization/locales/zh.ts index ed47cbfd..e7a8a313 100644 --- a/packages/typedoc-plugin-markdown/src/internationalization/locales/zh.ts +++ b/packages/typedoc-plugin-markdown/src/internationalization/locales/zh.ts @@ -11,6 +11,7 @@ export const translatable: Partial = { theme_event: '事件', theme_extends: '扩展', theme_extended_by: '被扩展', + theme_globals: '全局变量', theme_member: '成员', theme_member_plural: '成员们', theme_modifier: '修饰符', diff --git a/packages/typedoc-plugin-markdown/src/options/declarations.ts b/packages/typedoc-plugin-markdown/src/options/declarations.ts index 948c7632..780b5db5 100644 --- a/packages/typedoc-plugin-markdown/src/options/declarations.ts +++ b/packages/typedoc-plugin-markdown/src/options/declarations.ts @@ -129,11 +129,12 @@ export const fileExtension: Partial = { }; /** - * The entry page is the root page of the documentation, equivalent to `index.html` for web pages. + * The `entryFileName` in this context is the root page of the documentation and each module directory. + * This is essentially the equivalent to `index.html` for web pages. * * `README` is recognised when browsing folders on repos and Wikis and is the plugin default. `index` might be more suitable for static site generators. * - * The content of this file will be resolved in the following order: + * The content of root documentation file will be resolved in the following order: * * 1. The value of the [`entryModule`](#entrymodule) option (if defined). * 2. The resolved Readme file (skipped if the [`readme`](https://typedoc.org/options/input/#readme) option is set to `none`). @@ -209,8 +210,8 @@ export const hidePageHeader: Partial = { /** * @category Display */ -export const hidePageTitle: Partial = { - help: 'Do not print page title.', +export const hideBreadcrumbs: Partial = { + help: 'Do not print breadcrumbs.', type: ParameterType.Boolean, defaultValue: false, }; @@ -218,8 +219,8 @@ export const hidePageTitle: Partial = { /** * @category Display */ -export const hideBreadcrumbs: Partial = { - help: 'Do not print breadcrumbs.', +export const hidePageTitle: Partial = { + help: 'Do not print page title.', type: ParameterType.Boolean, defaultValue: false, }; @@ -516,6 +517,40 @@ export const preserveAnchorCasing: Partial = { defaultValue: false, }; +/** + * Defines placeholder text in main template that can be customized. Includes the main page header and breadcrumbs (if displayed), + * page titles and page footer. + * + * Default values within curly braces {} indicates a placeholder of dynamic text. + * + * - The `{projectName}` placeholder writes project's name . + * - The `{kind}` writes the reflection kind of the page. + * - The `{version}` placeholder writes package version (if includeVersion is `true`). + * + * If you are looking for general localization support please see [localization](). + * + * @category Utility + */ +export const textContentMappings: Partial = { + help: 'Change specific text placeholders in the template.', + type: ParameterType.Object, + defaultValue: TEXT_CONTENT_MAPPINGS, + validate(value) { + if (!value || typeof value !== 'object') { + throw new Error( + '[typedoc-plugin-markdown] textContentMappings must be an object.', + ); + } + for (const val of Object.values(value)) { + if (typeof val !== 'string') { + throw new Error( + `[typedoc-plugin-markdown] All values of textContentMappings must be strings.`, + ); + } + } + }, +}; + /** * By default navigation is not written to file but can be consumed programmatically. * This is useful if you want to provide a custom sidebar/navigation implementation (if relevant to your environment). @@ -555,37 +590,3 @@ export const navigationModel: Partial = { excludeFolders: false, }, }; - -/** - * Defines placeholder text in main template that can be customized. Includes the main page header and breadcrumbs (if displayed), - * page titles and page footer. - * - * Default values within curly braces {} indicates a placeholder of dynamic text. - * - * - The `{projectName}` placeholder writes project's name . - * - The `{kind}` writes the reflection kind of the page. - * - The `{version}` placeholder writes package version (if includeVersion is `true`). - * - * If you are looking for general localization support please see [localization](). - * - * @category Utility - */ -export const textContentMappings: Partial = { - help: 'Change specific text placeholders in the template.', - type: ParameterType.Object, - defaultValue: TEXT_CONTENT_MAPPINGS, - validate(value) { - if (!value || typeof value !== 'object') { - throw new Error( - '[typedoc-plugin-markdown] textContentMappings must be an object.', - ); - } - for (const val of Object.values(value)) { - if (typeof val !== 'string') { - throw new Error( - `[typedoc-plugin-markdown] All values of textContentMappings must be strings.`, - ); - } - } - }, -}; diff --git a/packages/typedoc-plugin-markdown/src/options/index.ts b/packages/typedoc-plugin-markdown/src/options/index.ts index df042643..e574cc2b 100644 --- a/packages/typedoc-plugin-markdown/src/options/index.ts +++ b/packages/typedoc-plugin-markdown/src/options/index.ts @@ -1,6 +1,30 @@ /** * Contains all the option declarations and types used in the plugin. * + * Options exposed to TypeDoc are added as a named export to the declarations options. + * + * @example + * + * ```ts + * \/** + * * Some more detailed comments about the option. + * * + * * @category Display + * *\/ + * export const myNewOption: Partial = { + * help: 'A short description of the option.', + * type: ParameterType.Boolean, + * defaultValue: false, + * }; + * ``` + * + * This will be exposed to TypeDoc as a new option when bootstrapping the plugin, with the name of the option the name of the exported variable. + * + * In addition, when the `prebuild` task is run: + + * - The option type will be added to `TypeDocOptionsMap`. + * - The documentation will be updated using the JSDoc comments and categorized as per the `@category` tag. + * * @module */ export * as constants from './constants'; diff --git a/packages/typedoc-plugin-markdown/src/public-api.ts b/packages/typedoc-plugin-markdown/src/public-api.ts index 8f5c1163..d2b9eec4 100644 --- a/packages/typedoc-plugin-markdown/src/public-api.ts +++ b/packages/typedoc-plugin-markdown/src/public-api.ts @@ -2,9 +2,9 @@ * The public API of typedoc-plugin-markdown exposes some classes and types that can be used to customize the output of the plugin. * If you are interested more generally in the TypeDoc API please visit [https://typedoc.org](https://typedoc.org/api/). * - * @document ../supporting-docs/local-plugins.md - * @document ../supporting-docs/customizing-output.md - * @document ../supporting-docs/navigation.md + * @document ../supporting-docs/public/local-plugins.md + * @document ../supporting-docs/public/customizing-output.md + * @document ../supporting-docs/public/utilizing-navigation.md * * @module */ @@ -12,6 +12,8 @@ export { MarkdownPageEvent, MarkdownRendererEvent } from '@plugin/events'; export { MarkdownTheme, MarkdownThemeContext } from '@plugin/theme'; export { + MarkdownApplication, + MarkdownRenderer, MarkdownRendererHooks, NavigationItem, PluginOptions, diff --git a/packages/typedoc-plugin-markdown/src/theme/base/get-navigation.ts b/packages/typedoc-plugin-markdown/src/theme/base/get-navigation.ts deleted file mode 100644 index f9948d30..00000000 --- a/packages/typedoc-plugin-markdown/src/theme/base/get-navigation.ts +++ /dev/null @@ -1,329 +0,0 @@ -import { isQuoted } from '@plugin/libs/utils'; -import { OutputFileStrategy } from '@plugin/options/maps'; -import { MarkdownTheme } from '@plugin/theme'; -import { MarkdownRenderer, NavigationItem } from '@plugin/types'; -import * as path from 'path'; -import { - DeclarationReflection, - DocumentReflection, - EntryPointStrategy, - Options, - ProjectReflection, - ReflectionCategory, - ReflectionGroup, - ReflectionKind, -} from 'typedoc'; - -let theme: MarkdownTheme; -let project: ProjectReflection; -let options: Options; -let packagesMeta: any; -let navigationOptions: any; -const navigation: NavigationItem[] = []; -let isPackages: boolean; - -export function getNavigation( - markdownTheme: MarkdownTheme, - ProjectReflection: ProjectReflection, -) { - theme = markdownTheme; - project = ProjectReflection; - - options = theme.application.options; - navigationOptions = options.getValue('navigationModel'); - packagesMeta = (theme.application.renderer as MarkdownRenderer).packagesMeta; - isPackages = - options.getValue('entryPointStrategy') === EntryPointStrategy.Packages; - if (isPackages) { - if (Object.keys(packagesMeta)?.length === 1) { - buildNavigationFromProject(project); - } else { - project.children?.forEach((projectChild) => { - buildNavigationFromPackage(projectChild); - }); - } - } else { - buildNavigationFromProject(project); - } - - return navigation; -} - -function buildNavigationFromPackage(projectChild: DeclarationReflection) { - const fileExtension = options.getValue('fileExtension'); - - const entryFileName = `${path.parse(options.getValue('entryFileName')).name}${fileExtension}`; - - const preservePackageReadme = - Boolean(projectChild.readme) && !options.getValue('mergeReadme'); - - const packageOptions = packagesMeta[projectChild.name]?.options; - - const outputFileStrategy = packageOptions?.isSet('outputFileStrategy') - ? packageOptions.getValue('outputFileStrategy') - : options.getValue('outputFileStrategy'); - - const entryModule = packageOptions?.isSet('entryModule') - ? packageOptions.getValue('entryModule') - : options.getValue('entryModule'); - - const projectChildUrl = preservePackageReadme - ? `${path.dirname(projectChild.url as string)}/${entryFileName}` - : projectChild.url; - - const isModulesGroup = - projectChild?.groups && - projectChild?.groups[0].children.every( - (child) => child.kind === ReflectionKind.Module, - ); - - const children: NavigationItem[] = []; - - if ( - preservePackageReadme && - !isModulesGroup && - outputFileStrategy === OutputFileStrategy.Modules - ) { - children.push({ - title: theme.application.internationalization.proxy.kind_plural_module(), - path: projectChild.url, - kind: projectChild.kind, - }); - } - const childGroups = getReflectionGroups(projectChild, outputFileStrategy); - - if (childGroups) { - children.push( - ...childGroups.filter((child) => child.title !== entryModule), - ); - } - - navigation.push({ - title: projectChild.name, - kind: projectChild.kind, - children, - ...(projectChildUrl && { path: projectChildUrl }), - }); -} - -function buildNavigationFromProject( - project: ProjectReflection | DeclarationReflection, -) { - const entryModule = options.getValue('entryModule'); - - if (!navigationOptions.excludeCategories && project.categories?.length) { - navigation.push( - ...project.categories.map((category) => { - return { - title: category.title, - children: getCategoryGroupChildren(category), - }; - }), - ); - } else { - if (project.groups?.length) { - const isOnlyModules = project.children?.every( - (child) => child.kind === ReflectionKind.Module, - ); - if (isOnlyModules) { - project.groups?.forEach((projectGroup) => { - if (projectGroup.owningReflection.kind === ReflectionKind.Module) { - const children = getGroupChildren(projectGroup); - if (children?.length) { - navigation.push( - ...children.filter((child) => child.title !== entryModule), - ); - } - } else { - navigation.push({ - title: projectGroup.title, - children: projectGroup.children.map((child) => { - return { - title: child.name, - kind: child.kind, - path: child.url, - }; - }), - }); - } - }); - } else { - project.groups?.forEach((projectGroup) => { - const children = getGroupChildren(projectGroup); - const indexModule = projectGroup.children.find( - (child) => child.name === entryModule, - ); - if (children?.length) { - navigation.push({ - title: projectGroup.title, - children: children.filter((child) => child.title !== entryModule), - }); - } - if (indexModule) { - const children = - indexModule instanceof DeclarationReflection - ? getReflectionGroups(indexModule) - : []; - if (children) { - navigation.push(...children); - } - } - }); - } - } - } -} - -function getCategoryGroupChildren(group: ReflectionCategory) { - return group.children - ?.filter((child) => child.hasOwnDocument) - .map((child) => { - const children = - child instanceof DeclarationReflection - ? getReflectionGroups(child) - : []; - return { - title: child.name, - kind: child.kind, - url: child.url, - ...(children && { children }), - }; - }); -} - -function getGroupChildren( - group: ReflectionGroup, - outputFileStrategy?: OutputFileStrategy, -) { - if (!navigationOptions.excludeCategories && group?.categories?.length) { - return group.categories?.map((category) => { - return { - title: category.title, - children: getCategoryGroupChildren(category), - }; - }); - } - - return group.children - ?.filter((child) => child.hasOwnDocument) - .reduce((acc: NavigationItem[], child) => { - const mapping = theme.getTemplateMapping(child.kind, outputFileStrategy); - if (Boolean(mapping)) { - const children = - child instanceof DeclarationReflection && - !navigationOptions.excludeCategories && - child.categories?.length - ? child.categories - ?.map((category) => { - const catChildren = getCategoryGroupChildren(category); - return catChildren.length - ? { - title: category.title, - children: catChildren, - } - : null; - }) - .filter((cat) => Boolean(cat)) - : getReflectionGroups(child, outputFileStrategy); - return processChildren(acc, child, children as NavigationItem[]); - } - }, []); -} - -function getReflectionGroups( - reflection: DeclarationReflection | DocumentReflection, - outputFileStrategy?: OutputFileStrategy, -): NavigationItem[] | null { - if ( - reflection instanceof DeclarationReflection && - reflection.groups?.some((group) => group.allChildrenHaveOwnDocument()) - ) { - if (navigationOptions.excludeGroups) { - return reflection.childrenIncludingDocuments - ?.filter((child) => child.hasOwnDocument) - .reduce((acc, child) => { - const children = getReflectionGroups(child, outputFileStrategy); - return processChildren(acc, child, children); - }, []) as NavigationItem[]; - } - - const groupsWithoutDocs = reflection.groups?.filter( - (group) => - group.title !== ReflectionKind.pluralString(ReflectionKind.Document), - ); - - const isModulesGroup = - groupsWithoutDocs?.length && - groupsWithoutDocs[0].children.every( - (child) => child.kind === ReflectionKind.Module, - ); - - if (isModulesGroup) { - return getGroupChildren(groupsWithoutDocs[0], outputFileStrategy) || null; - } - - return reflection.groups - ?.map((group) => { - const groupChildren = getGroupChildren(group, outputFileStrategy); - if (groupChildren?.length) { - if (group.owningReflection.kind === ReflectionKind.Document) { - return groupChildren[0]; - } - return { - title: group.title, - children: groupChildren, - }; - } - return null; - }) - .filter((group) => Boolean(group)) as NavigationItem[]; - } - return null; -} - -function processChildren( - acc: NavigationItem[], - child: DeclarationReflection | DocumentReflection, - children: NavigationItem[] | null, -) { - if (!isQuoted(child.name) && !navigationOptions.excludeFolders) { - const titleParts = child.name.split('/'); - if (!child.name.startsWith('@') && titleParts.length > 1) { - let currentLevel = acc; - let currentItem: NavigationItem; - for (let i = 0; i < titleParts.length - 1; i++) { - currentItem = currentLevel?.find( - (item: NavigationItem) => item.title === titleParts[i], - ) as NavigationItem; - if (!currentItem) { - currentItem = { - title: titleParts[i], - children: [], - }; - currentLevel.push(currentItem); - } - if (currentItem) { - currentLevel = currentItem.children || []; - } - } - - currentLevel.push({ - title: titleParts[titleParts.length - 1], - kind: child.kind, - path: child.url, - ...(children && { children }), - }); - - return acc; - } - } - - acc.push({ - title: child.name, - kind: child.kind, - path: child.url, - ...(children && { children }), - }); - - return acc; -} diff --git a/packages/typedoc-plugin-markdown/src/theme/base/get-urls.ts b/packages/typedoc-plugin-markdown/src/theme/base/get-urls.ts deleted file mode 100644 index bfe21267..00000000 --- a/packages/typedoc-plugin-markdown/src/theme/base/get-urls.ts +++ /dev/null @@ -1,590 +0,0 @@ -import { - getFileNameWithExtension, - isQuoted, - removeFirstScopedDirectory, - slugify, - toPascalCase, -} from '@plugin/libs/utils'; -import { OutputFileStrategy } from '@plugin/options/maps'; -import { MarkdownTheme } from '@plugin/theme'; -import { - MarkdownRenderer, - TemplateMapping, - UrlMapping, - UrlOption, -} from '@plugin/types'; -import * as path from 'path'; -import { - DeclarationReflection, - DocumentReflection, - EntryPointStrategy, - Options, - ProjectReflection, - Reflection, - ReflectionKind, -} from 'typedoc'; - -let theme: MarkdownTheme; -let project: ProjectReflection; -let options: Options; -let packagesMeta: any; -let fileExtension: string; -let ignoreScopes: boolean; -let entryFileName: string; -let isPackages: boolean; -let flattenOutputFiles: boolean; - -const anchors: Record = {}; -const urls: UrlMapping[] = []; - -/** - * Map the models of the given project to the desired output files. - * Based on TypeDoc DefaultTheme.getUrls() - */ -export function getUrls( - markdownTheme: MarkdownTheme, - ProjectReflection: ProjectReflection, -) { - theme = markdownTheme; - project = ProjectReflection; - - options = theme.application.options; - packagesMeta = (theme.application.renderer as MarkdownRenderer).packagesMeta; - - fileExtension = options.getValue('fileExtension'); - ignoreScopes = options.getValue('excludeScopesInPaths'); - - entryFileName = getFileNameWithExtension( - options.getValue('entryFileName'), - fileExtension, - ); - - isPackages = - options.getValue('entryPointStrategy') === EntryPointStrategy.Packages; - - flattenOutputFiles = options.getValue('flattenOutputFiles'); - - buildEntryUrls(); - - if (isPackages) { - if (Object.keys(packagesMeta)?.length === 1) { - buildUrlsFromProject(project); - } else { - project.children?.forEach((projectChild) => { - buildUrlsFromPackage(projectChild); - }); - } - } else { - buildUrlsFromProject(project); - } - - return urls; -} - -function buildEntryUrls() { - const preserveReadme = - Boolean(project.readme) && !options.getValue('mergeReadme'); - - const isModulesOnly = project.children?.every( - (child) => child.kind === ReflectionKind.Module, - ); - const useEntryModule = - project?.groups && - Boolean( - project?.groups[0]?.children.find( - (child) => child.name === options.getValue('entryModule'), - ), - ) && - isModulesOnly; - const indexFilename = getIndexFileName(project, isPackages); - - project.url = preserveReadme - ? indexFilename - : useEntryModule - ? indexFilename - : entryFileName; - - if (preserveReadme) { - urls.push({ - url: useEntryModule - ? getFileNameWithExtension('readme_', fileExtension) - : entryFileName, - model: project, - template: theme.readmeTemplate, - }); - - if (!useEntryModule) { - urls.push({ - url: indexFilename, - model: project, - template: theme.projectTemplate, - }); - } - } else { - if (!useEntryModule) { - urls.push({ - url: entryFileName, - model: project, - template: theme.projectTemplate, - }); - } - } -} - -function buildUrlsFromProject( - project: ProjectReflection | DeclarationReflection, - parentUrl?: string, - outputFileStrategy?: OutputFileStrategy, - entryModule?: string, - entryFileName?: string, -) { - project.groups?.forEach((projectGroup) => { - projectGroup.children?.forEach((projectGroupChild) => { - if (projectGroupChild instanceof DocumentReflection) { - buildUrlsForDocument(projectGroupChild); - } - if (projectGroupChild instanceof DeclarationReflection) { - buildUrlsFromGroup(projectGroupChild, { - ...(parentUrl && { parentUrl }), - ...(outputFileStrategy && { outputFileStrategy }), - ...(entryModule && { entryModule }), - ...(entryFileName && { entryFileName }), - }); - } - }); - }); -} - -function buildUrlsFromPackage(projectChild: DeclarationReflection) { - const preservePackageReadme = - Boolean(projectChild.readme) && !options.getValue('mergeReadme'); - - const packagesIndex = getIndexFileName(projectChild); - - const packageOptions = packagesMeta[projectChild.name]?.options; - - const outputFileStrategy = packageOptions.isSet('outputFileStrategy') - ? packageOptions.getValue('outputFileStrategy') - : options.getValue('outputFileStrategy'); - - const entryModule = packageOptions.isSet('entryModule') - ? packageOptions.getValue('entryModule') - : options.getValue('entryModule'); - - const packageEntryFileName = packageOptions.isSet('entryFileName') - ? packageOptions.getValue('entryFileName') - : options.getValue('entryFileName'); - - let fullEntryFileName = getFileNameWithExtension( - path.join(projectChild.name, packageEntryFileName), - fileExtension, - ); - - let fullIndexFileName = getFileNameWithExtension( - path.join(projectChild.name, packagesIndex), - fileExtension, - ); - - if (ignoreScopes) { - fullEntryFileName = removeFirstScopedDirectory(fullEntryFileName); - fullIndexFileName = removeFirstScopedDirectory(fullIndexFileName); - } - - const indexFileName = preservePackageReadme - ? fullIndexFileName - : fullEntryFileName; - - const isModulesOnly = projectChild.children?.every( - (child) => child.kind === ReflectionKind.Module, - ); - - const useEntryModule = - projectChild?.groups && - Boolean( - projectChild?.groups[0]?.children.find( - (child) => child.name === entryModule, - ), - ) && - isModulesOnly; - - if (preservePackageReadme) { - urls.push({ - url: useEntryModule - ? `${path.dirname(indexFileName)}/${getFileNameWithExtension('readme_', fileExtension)}` - : path.join( - path.dirname(indexFileName), - getFileNameWithExtension(packageEntryFileName, fileExtension), - ), - model: projectChild, - template: theme.readmeTemplate, - }); - - if (!useEntryModule) { - urls.push({ - url: indexFileName, - model: projectChild, - template: theme.projectTemplate, - }); - } - } else { - if (!useEntryModule) { - urls.push({ - url: indexFileName, - model: projectChild, - template: theme.projectTemplate, - }); - } - } - - projectChild.url = indexFileName; - - projectChild.documents?.forEach((document) => { - buildUrlsForDocument(document); - }); - - const parentUrl = - indexFileName.split(path.sep)?.length > 1 - ? indexFileName - : `${projectChild.name}/${indexFileName}`; - - buildUrlsFromProject( - projectChild, - parentUrl, - outputFileStrategy, - entryModule, - fullEntryFileName, - ); -} - -function buildUrlsForDocument(reflection: DocumentReflection) { - const mapping: TemplateMapping = theme.getTemplateMapping(reflection.kind); - - if (mapping) { - const baseUrl = path.dirname(reflection.parent?.url || ''); - - const directory = flattenOutputFiles - ? ReflectionKind.singularString(reflection.kind) - : (mapping.directory as string); - const filename = [ - getFileNameWithExtension( - reflection.name.replace(/ /g, '-'), - fileExtension, - ), - ]; - - if ( - reflection?.parent?.kind && - ![ReflectionKind.Module, ReflectionKind.Project].includes( - reflection?.parent?.kind, - ) - ) { - filename.unshift( - toPascalCase(ReflectionKind.singularString(reflection.parent?.kind)), - ); - } - - const urlBase = path.join(baseUrl, directory, filename.join('.')); - const url = flattenOutputFiles ? urlBase.replace(/\//g, '.') : urlBase; - - urls.push({ - url, - model: reflection, - template: mapping.template, - }); - reflection.url = url; - reflection.hasOwnDocument = true; - } -} - -function buildUrlsFromGroup( - reflection: DeclarationReflection, - urlOptions: UrlOption, -) { - const mapping: TemplateMapping = theme.getTemplateMapping( - reflection.kind, - urlOptions.outputFileStrategy, - ); - - if (mapping) { - let url: string; - let urlPath = ''; - - if (flattenOutputFiles) { - url = getFlattenedUrl(reflection); - } else { - const directory = urlOptions.directory || mapping.directory; - urlPath = getUrlPath(reflection, { - ...urlOptions, - directory, - }); - - url = getUrl(reflection, urlPath, urlOptions); - - if (ignoreScopes) { - url = removeFirstScopedDirectory(url); - } - - const duplicateUrls = urls.filter( - (urlMapping) => - urlMapping.url.toLowerCase() === url.toLowerCase() && - urlMapping.url !== url, - ); - - if (duplicateUrls.length > 0) { - const urlParts = url.split('.'); - urlParts[urlParts.length - 2] += `-${duplicateUrls.length}`; - url = urlParts.join('.'); - } - } - - urls.push({ - url: url, - model: reflection, - template: mapping.template, - }); - - reflection.url = url; - reflection.hasOwnDocument = true; - - reflection.groups?.forEach((group) => { - group.children.forEach((groupChild) => { - const mapping = theme.getTemplateMapping( - groupChild.kind, - urlOptions.outputFileStrategy, - ); - buildUrlsFromGroup(groupChild as DeclarationReflection, { - parentUrl: urlPath, - directory: mapping?.directory || null, - outputFileStrategy: urlOptions.outputFileStrategy, - }); - }); - }); - } else if (reflection.parent) { - traverseChildren(reflection, reflection.parent); - } -} - -function getUrl( - reflection: DeclarationReflection, - urlPath: string, - urlOptions: UrlOption, -) { - const entryModule = urlOptions.entryModule || options.getValue('entryModule'); - - const entryName = urlOptions.entryFileName || entryFileName; - - if (reflection.name === entryModule) { - return entryName; - } - - if ( - options.getValue('outputFileStrategy') === OutputFileStrategy.Modules && - reflection.name === 'index' && - path.parse(entryName).name === 'index' - ) { - return urlPath.replace( - getFileNameWithExtension('index', fileExtension), - getFileNameWithExtension('module_index', fileExtension), - ); - } - return urlPath; -} - -function getFlattenedUrl(reflection: DeclarationReflection) { - const fullName = reflection.getFullName(); - - const fullNameParts = fullName.replace(/\//g, '.').split('.'); - if (reflection.kind !== ReflectionKind.Module) { - fullNameParts.splice( - fullNameParts.length - 1, - 0, - toPascalCase(ReflectionKind.singularString(reflection.kind)), - ); - } - const url = `${fullNameParts.join('.')}${fileExtension}` - .replace(/"/g, '') - .replace(/ /g, '-') - .replace(/^\./g, ''); - - reflection.url = url; - return url; -} - -function getAlias(name: string) { - if (isQuoted(name)) { - name = name.replace(/\//g, '_'); - } - return name - .replace(/"/g, '') - .replace(/^_+|_+$/g, '') - .replace(/[<>]/g, '-'); -} - -function getUrlPath(reflection: DeclarationReflection, urlOption: UrlOption) { - const alias = getAlias(reflection.name); - - const parentDir = urlOption.parentUrl - ? path.dirname(urlOption.parentUrl) - : null; - - const dir = () => { - if (reflection.kind === ReflectionKind.Namespace) { - return `${urlOption.directory}/${alias}`; - } - - if (reflection.kind === ReflectionKind.Module) { - return alias; - } - - return urlOption.directory - ? urlOption.directory - : `${slugify(ReflectionKind.singularString(reflection.kind))}.${alias}`; - }; - - const filename = () => { - if ( - [ReflectionKind.Module, ReflectionKind.Namespace].includes( - reflection.kind, - ) && - options.getValue('outputFileStrategy') === OutputFileStrategy.Modules && - !moduleHasSubfolders(reflection) - ) { - return null; - } - if ( - [ReflectionKind.Module, ReflectionKind.Namespace].includes( - reflection.kind, - ) - ) { - return path.parse(entryFileName).name; - } - return alias; - }; - - return getFileNameWithExtension( - [parentDir, dir(), filename()].filter((part) => Boolean(part)).join('/'), - fileExtension, - ); -} - -function traverseChildren( - reflection: DeclarationReflection, - container: Reflection, -) { - if (container.url) { - applyAnchorUrl(reflection, container.url); - } - if (reflection.parent) { - reflection.traverse((child) => { - if (child instanceof DocumentReflection) { - buildUrlsForDocument(child); - } - if (child instanceof DeclarationReflection) { - traverseChildren(child, container); - } - }); - } -} - -function applyAnchorUrl( - reflection: DeclarationReflection, - containerUrl: string, -) { - if (reflection.kind !== ReflectionKind.TypeLiteral) { - const anchorPrefix = options.getValue('anchorPrefix'); - const anchorId = getAnchorId(reflection); - - if (anchorId) { - if (!anchors[containerUrl]) { - anchors[containerUrl] = []; - } - - anchors[containerUrl].push(anchorId); - - const count = anchors[containerUrl]?.filter( - (id) => id === anchorId, - )?.length; - - const anchorParts = [anchorId]; - - if (count > 1) { - anchorParts.push(`-${count - 1}`); - } - - if (anchorPrefix) { - anchorParts.unshift(`${anchorPrefix}`); - } - - reflection.url = containerUrl + '#' + anchorParts.join(''); - reflection.anchor = anchorParts.join(''); - reflection.hasOwnDocument = false; - } - } -} - -function getAnchorId(reflection: DeclarationReflection) { - const preserveAnchorCasing = options.getValue('preserveAnchorCasing'); - - const anchorName = getAnchorName(reflection); - - if (anchorName) { - return preserveAnchorCasing ? anchorName : anchorName.toLowerCase(); - } - - return null; -} - -function getAnchorName(reflection: DeclarationReflection) { - const htmlTableAnchors = options.getValue('useHTMLAnchors'); - - if (!htmlTableAnchors) { - if ( - (reflection.kind === ReflectionKind.Property && - options.getValue('propertiesFormat').toLowerCase() === 'table') || - (reflection.kind === ReflectionKind.Property && - reflection.parent?.kind === ReflectionKind.Class && - options.getValue('classPropertiesFormat').toLowerCase() === 'table') || - (reflection.kind === ReflectionKind.Property && - reflection.parent?.kind === ReflectionKind.Interface && - options.getValue('interfacePropertiesFormat').toLowerCase() === - 'table') || - (reflection.kind === ReflectionKind.EnumMember && - options.getValue('enumMembersFormat').toLowerCase() === 'table') - ) { - return null; - } - } - if (reflection.kind === ReflectionKind.Constructor) { - return 'Constructors'; - } - const anchorParts = [reflection.name]; - if (reflection.typeParameters?.length) { - anchorParts.push( - reflection.typeParameters - .map((typeParameter) => typeParameter.name) - .join(''), - ); - } - return anchorParts.join(''); -} - -function moduleHasSubfolders(reflection: DeclarationReflection) { - return reflection.childrenIncludingDocuments?.some((child) => - [ReflectionKind.Namespace, ReflectionKind.Document].includes(child.kind), - ); -} - -function getIndexFileName( - reflection: ProjectReflection | DeclarationReflection, - isPackages = false, -) { - if (isPackages) { - return getFileNameWithExtension('packages', fileExtension); - } - const isModules = reflection.children?.every( - (child) => child.kind === ReflectionKind.Module, - ); - return isModules - ? getFileNameWithExtension('modules', fileExtension) - : getFileNameWithExtension('globals', fileExtension); -} diff --git a/packages/typedoc-plugin-markdown/src/theme/base/index.ts b/packages/typedoc-plugin-markdown/src/theme/base/index.ts index b45e6209..65d54bd2 100644 --- a/packages/typedoc-plugin-markdown/src/theme/base/index.ts +++ b/packages/typedoc-plugin-markdown/src/theme/base/index.ts @@ -1,2 +1,2 @@ -export * from './get-navigation'; -export * from './get-urls'; +export * from './navigation-builder'; +export * from './url-builder'; diff --git a/packages/typedoc-plugin-markdown/src/theme/base/navigation-builder.ts b/packages/typedoc-plugin-markdown/src/theme/base/navigation-builder.ts new file mode 100644 index 00000000..dba46788 --- /dev/null +++ b/packages/typedoc-plugin-markdown/src/theme/base/navigation-builder.ts @@ -0,0 +1,357 @@ +import { isQuoted } from '@plugin/libs/utils'; +import { OutputFileStrategy } from '@plugin/options/maps'; +import { MarkdownTheme } from '@plugin/theme'; +import { MarkdownRenderer, NavigationItem } from '@plugin/types'; +import * as path from 'path'; +import { + DeclarationReflection, + DocumentReflection, + EntryPointStrategy, + Options, + ProjectReflection, + ReflectionCategory, + ReflectionGroup, + ReflectionKind, +} from 'typedoc'; + +export class NavigationBuilder { + private options: Options; + private packagesMeta: any; + private navigationOptions: any; + private navigation: NavigationItem[] = []; + private isPackages: boolean; + + constructor( + public theme: MarkdownTheme, + public project: ProjectReflection, + ) { + this.options = theme.application.options; + this.navigationOptions = this.options.getValue('navigationModel'); + this.packagesMeta = ( + theme.application.renderer as MarkdownRenderer + ).packagesMeta; + this.navigation = []; + this.isPackages = + this.options.getValue('entryPointStrategy') === + EntryPointStrategy.Packages; + } + + getNavigation() { + if (this.isPackages) { + if (Object.keys(this.packagesMeta)?.length === 1) { + this.buildNavigationFromProject(this.project); + } else { + this.project.children?.forEach((projectChild) => { + this.buildNavigationFromPackage(projectChild); + }); + } + } else { + this.buildNavigationFromProject(this.project); + } + + return this.navigation; + } + + private buildNavigationFromPackage(projectChild: DeclarationReflection) { + const fileExtension = this.options.getValue('fileExtension'); + + const entryFileName = `${path.parse(this.options.getValue('entryFileName')).name}${fileExtension}`; + + const preservePackageReadme = + Boolean(projectChild.readme) && !this.options.getValue('mergeReadme'); + + const packageOptions = this.packagesMeta[projectChild.name]?.options; + + const outputFileStrategy = packageOptions?.isSet('outputFileStrategy') + ? packageOptions.getValue('outputFileStrategy') + : this.options.getValue('outputFileStrategy'); + + const entryModule = packageOptions?.isSet('entryModule') + ? packageOptions.getValue('entryModule') + : this.options.getValue('entryModule'); + + const projectChildUrl = preservePackageReadme + ? `${path.dirname(projectChild.url as string)}/${entryFileName}` + : projectChild.url; + + const isModulesGroup = + projectChild?.groups && + projectChild?.groups[0].children.every( + (child) => child.kind === ReflectionKind.Module, + ); + + const children: NavigationItem[] = []; + + if ( + preservePackageReadme && + !isModulesGroup && + outputFileStrategy === OutputFileStrategy.Modules + ) { + children.push({ + title: + this.theme.application.internationalization.proxy.theme_globals(), + path: projectChild.url, + kind: projectChild.kind, + }); + } + const childGroups = this.getReflectionGroups( + projectChild, + outputFileStrategy, + ); + + if (childGroups) { + children.push( + ...childGroups.filter((child) => child.title !== entryModule), + ); + } + + this.navigation.push({ + title: projectChild.name, + kind: projectChild.kind, + children, + ...(projectChildUrl && { path: projectChildUrl }), + }); + } + + private buildNavigationFromProject( + project: ProjectReflection | DeclarationReflection, + ) { + const entryModule = this.options.getValue('entryModule'); + + if ( + !this.navigationOptions.excludeCategories && + project.categories?.length + ) { + this.navigation.push( + ...project.categories.map((category) => { + return { + title: category.title, + children: this.getCategoryGroupChildren(category), + }; + }), + ); + } else { + if (project.groups?.length) { + const isOnlyModules = project.children?.every( + (child) => child.kind === ReflectionKind.Module, + ); + if (isOnlyModules) { + project.groups?.forEach((projectGroup) => { + if (projectGroup.owningReflection.kind === ReflectionKind.Module) { + const children = this.getGroupChildren(projectGroup); + if (children?.length) { + this.navigation.push( + ...children.filter((child) => child.title !== entryModule), + ); + } + } else { + this.navigation.push({ + title: projectGroup.title, + children: projectGroup.children.map((child) => { + return { + title: child.name, + kind: child.kind, + path: child.url, + }; + }), + }); + } + }); + } else { + project.groups?.forEach((projectGroup) => { + const children = this.getGroupChildren(projectGroup); + const indexModule = projectGroup.children.find( + (child) => child.name === entryModule, + ); + if (children?.length) { + this.navigation.push({ + title: projectGroup.title, + children: children.filter( + (child) => child.title !== entryModule, + ), + }); + } + if (indexModule) { + const children = + indexModule instanceof DeclarationReflection + ? this.getReflectionGroups(indexModule) + : []; + if (children) { + this.navigation.push(...children); + } + } + }); + } + } + } + } + + private getCategoryGroupChildren(group: ReflectionCategory) { + return group.children + ?.filter((child) => child.hasOwnDocument) + .map((child) => { + const children = + child instanceof DeclarationReflection + ? this.getReflectionGroups(child) + : []; + return { + title: child.name, + kind: child.kind, + url: child.url, + ...(children && { children }), + }; + }); + } + + private getGroupChildren( + group: ReflectionGroup, + outputFileStrategy?: OutputFileStrategy, + ) { + if ( + !this.navigationOptions.excludeCategories && + group?.categories?.length + ) { + return group.categories?.map((category) => { + return { + title: category.title, + children: this.getCategoryGroupChildren(category), + }; + }); + } + + return group.children + ?.filter((child) => child.hasOwnDocument) + .reduce((acc: NavigationItem[], child) => { + const mapping = this.theme.getTemplateMapping( + child.kind, + outputFileStrategy, + ); + if (Boolean(mapping)) { + const children = + child instanceof DeclarationReflection && + !this.navigationOptions.excludeCategories && + child.categories?.length + ? child.categories + ?.map((category) => { + const catChildren = this.getCategoryGroupChildren(category); + return catChildren.length + ? { + title: category.title, + children: catChildren, + } + : null; + }) + .filter((cat) => Boolean(cat)) + : this.getReflectionGroups(child, outputFileStrategy); + return this.processChildren(acc, child, children as NavigationItem[]); + } + }, []); + } + + private getReflectionGroups( + reflection: DeclarationReflection | DocumentReflection, + outputFileStrategy?: OutputFileStrategy, + ): NavigationItem[] | null { + if ( + reflection instanceof DeclarationReflection && + reflection.groups?.some((group) => group.allChildrenHaveOwnDocument()) + ) { + if (this.navigationOptions.excludeGroups) { + return reflection.childrenIncludingDocuments + ?.filter((child) => child.hasOwnDocument) + .reduce((acc, child) => { + const children = this.getReflectionGroups( + child, + outputFileStrategy, + ); + return this.processChildren(acc, child, children); + }, []) as NavigationItem[]; + } + + const groupsWithoutDocs = reflection.groups?.filter( + (group) => + group.title !== ReflectionKind.pluralString(ReflectionKind.Document), + ); + + const isModulesGroup = + groupsWithoutDocs?.length && + groupsWithoutDocs[0].children.every( + (child) => child.kind === ReflectionKind.Module, + ); + + if (isModulesGroup) { + return ( + this.getGroupChildren(groupsWithoutDocs[0], outputFileStrategy) || + null + ); + } + + return reflection.groups + ?.map((group) => { + const groupChildren = this.getGroupChildren( + group, + outputFileStrategy, + ); + if (groupChildren?.length) { + if (group.owningReflection.kind === ReflectionKind.Document) { + return groupChildren[0]; + } + return { + title: group.title, + children: groupChildren, + }; + } + return null; + }) + .filter((group) => Boolean(group)) as NavigationItem[]; + } + return null; + } + + private processChildren( + acc: NavigationItem[], + child: DeclarationReflection | DocumentReflection, + children: NavigationItem[] | null, + ) { + if (!isQuoted(child.name) && !this.navigationOptions.excludeFolders) { + const titleParts = child.name.split('/'); + if (!child.name.startsWith('@') && titleParts.length > 1) { + let currentLevel = acc; + let currentItem: NavigationItem; + for (let i = 0; i < titleParts.length - 1; i++) { + currentItem = currentLevel?.find( + (item: NavigationItem) => item.title === titleParts[i], + ) as NavigationItem; + if (!currentItem) { + currentItem = { + title: titleParts[i], + children: [], + }; + currentLevel.push(currentItem); + } + if (currentItem) { + currentLevel = currentItem.children || []; + } + } + + currentLevel.push({ + title: titleParts[titleParts.length - 1], + kind: child.kind, + path: child.url, + ...(children && { children }), + }); + + return acc; + } + } + + acc.push({ + title: child.name, + kind: child.kind, + path: child.url, + ...(children && { children }), + }); + + return acc; + } +} diff --git a/packages/typedoc-plugin-markdown/src/theme/base/url-builder.ts b/packages/typedoc-plugin-markdown/src/theme/base/url-builder.ts new file mode 100644 index 00000000..0e11d7ad --- /dev/null +++ b/packages/typedoc-plugin-markdown/src/theme/base/url-builder.ts @@ -0,0 +1,611 @@ +import { + getFileNameWithExtension, + isQuoted, + removeFirstScopedDirectory, + slugify, + toPascalCase, +} from '@plugin/libs/utils'; +import { OutputFileStrategy } from '@plugin/options/maps'; +import { MarkdownTheme } from '@plugin/theme'; +import { + MarkdownRenderer, + TemplateMapping, + UrlMapping, + UrlOption, +} from '@plugin/types'; +import * as path from 'path'; +import { + DeclarationReflection, + DocumentReflection, + EntryPointStrategy, + Options, + ProjectReflection, + Reflection, + ReflectionKind, +} from 'typedoc'; + +/** + * Map the models of the given project to the desired output files. + * Based on TypeDoc DefaultTheme.getUrls() + * + * @param project The project whose urls should be generated. + */ +export class UrlBuilder { + private options: Options; + private packagesMeta: any; + private fileExtension: string; + private ignoreScopes: boolean; + private entryFileName: string; + private isPackages: boolean; + private flattenOutputFiles: boolean; + private urls: UrlMapping[] = []; + private anchors: Record = {}; + + constructor( + public theme: MarkdownTheme, + public project: ProjectReflection, + ) { + this.options = theme.application.options; + + this.packagesMeta = ( + theme.application.renderer as MarkdownRenderer + ).packagesMeta; + + this.fileExtension = this.options.getValue('fileExtension'); + this.ignoreScopes = this.options.getValue('excludeScopesInPaths'); + + this.entryFileName = getFileNameWithExtension( + this.options.getValue('entryFileName'), + this.fileExtension, + ); + + this.isPackages = + this.options.getValue('entryPointStrategy') === + EntryPointStrategy.Packages; + + this.flattenOutputFiles = this.options.getValue('flattenOutputFiles'); + } + + getUrls() { + this.buildEntryUrls(); + + if (this.isPackages) { + if (Object.keys(this.packagesMeta)?.length === 1) { + this.buildUrlsFromProject(this.project); + } else { + this.project.children?.forEach((projectChild) => { + this.buildUrlsFromPackage(projectChild); + }); + } + } else { + this.buildUrlsFromProject(this.project); + } + + return this.urls; + } + + private buildEntryUrls() { + const preserveReadme = + Boolean(this.project.readme) && !this.options.getValue('mergeReadme'); + + const isModulesOnly = this.project.children?.every( + (child) => child.kind === ReflectionKind.Module, + ); + const useEntryModule = + this.project?.groups && + Boolean( + this.project?.groups[0]?.children.find( + (child) => child.name === this.options.getValue('entryModule'), + ), + ) && + isModulesOnly; + const indexFilename = this.getIndexFileName(this.project, this.isPackages); + + this.project.url = preserveReadme + ? indexFilename + : useEntryModule + ? indexFilename + : this.entryFileName; + + if (preserveReadme) { + this.urls.push({ + url: useEntryModule + ? getFileNameWithExtension('readme_', this.fileExtension) + : this.entryFileName, + model: this.project, + template: this.theme.readmeTemplate, + }); + + if (!useEntryModule) { + this.urls.push({ + url: indexFilename, + model: this.project, + template: this.theme.projectTemplate, + }); + } + } else { + if (!useEntryModule) { + this.urls.push({ + url: this.entryFileName, + model: this.project, + template: this.theme.projectTemplate, + }); + } + } + } + + private buildUrlsFromProject( + project: ProjectReflection | DeclarationReflection, + parentUrl?: string, + outputFileStrategy?: OutputFileStrategy, + entryModule?: string, + entryFileName?: string, + ) { + if (project.documents) { + project.documents.forEach((document) => { + this.buildUrlsForDocument(document); + }); + } + project.groups?.forEach((projectGroup) => { + projectGroup.children?.forEach((projectGroupChild) => { + if (projectGroupChild instanceof DocumentReflection) { + this.buildUrlsForDocument(projectGroupChild); + } + if (projectGroupChild instanceof DeclarationReflection) { + this.buildUrlsFromGroup(projectGroupChild, { + ...(parentUrl && { parentUrl }), + ...(outputFileStrategy && { outputFileStrategy }), + ...(entryModule && { entryModule }), + ...(entryFileName && { entryFileName }), + }); + } + }); + }); + } + + private buildUrlsFromPackage(projectChild: DeclarationReflection) { + const preservePackageReadme = + Boolean(projectChild.readme) && !this.options.getValue('mergeReadme'); + + const packagesIndex = this.getIndexFileName(projectChild); + + const packageOptions = this.packagesMeta[projectChild.name]?.options; + + const outputFileStrategy = packageOptions.isSet('outputFileStrategy') + ? packageOptions.getValue('outputFileStrategy') + : this.options.getValue('outputFileStrategy'); + + const entryModule = packageOptions.isSet('entryModule') + ? packageOptions.getValue('entryModule') + : this.options.getValue('entryModule'); + + const packageEntryFileName = packageOptions.isSet('entryFileName') + ? packageOptions.getValue('entryFileName') + : this.options.getValue('entryFileName'); + + let fullEntryFileName = getFileNameWithExtension( + path.join(projectChild.name, packageEntryFileName), + this.fileExtension, + ); + + let fullIndexFileName = getFileNameWithExtension( + path.join(projectChild.name, packagesIndex), + this.fileExtension, + ); + + if (this.ignoreScopes) { + fullEntryFileName = removeFirstScopedDirectory(fullEntryFileName); + fullIndexFileName = removeFirstScopedDirectory(fullIndexFileName); + } + + const indexFileName = preservePackageReadme + ? fullIndexFileName + : fullEntryFileName; + + const isModulesOnly = projectChild.children?.every( + (child) => child.kind === ReflectionKind.Module, + ); + + const useEntryModule = + projectChild?.groups && + Boolean( + projectChild?.groups[0]?.children.find( + (child) => child.name === entryModule, + ), + ) && + isModulesOnly; + + if (preservePackageReadme) { + this.urls.push({ + url: useEntryModule + ? `${path.dirname(indexFileName)}/${getFileNameWithExtension('readme_', this.fileExtension)}` + : path.join( + path.dirname(indexFileName), + getFileNameWithExtension( + packageEntryFileName, + this.fileExtension, + ), + ), + model: projectChild, + template: this.theme.readmeTemplate, + }); + + if (!useEntryModule) { + this.urls.push({ + url: indexFileName, + model: projectChild, + template: this.theme.projectTemplate, + }); + } + } else { + if (!useEntryModule) { + this.urls.push({ + url: indexFileName, + model: projectChild, + template: this.theme.projectTemplate, + }); + } + } + + projectChild.url = indexFileName; + + projectChild.documents?.forEach((document) => { + this.buildUrlsForDocument(document); + }); + + const parentUrl = + indexFileName.split(path.sep)?.length > 1 + ? indexFileName + : `${projectChild.name}/${indexFileName}`; + + this.buildUrlsFromProject( + projectChild, + parentUrl, + outputFileStrategy, + entryModule, + fullEntryFileName, + ); + } + + private buildUrlsForDocument(reflection: DocumentReflection) { + const mapping: TemplateMapping = this.theme.getTemplateMapping( + reflection.kind, + ); + + if (mapping) { + const baseUrl = path.dirname(reflection.parent?.url || ''); + + const directory = this.flattenOutputFiles + ? ReflectionKind.singularString(reflection.kind) + : (mapping.directory as string); + const filename = [ + getFileNameWithExtension( + reflection.name.replace(/ /g, '-'), + this.fileExtension, + ), + ]; + + if ( + reflection?.parent?.kind && + ![ReflectionKind.Module, ReflectionKind.Project].includes( + reflection?.parent?.kind, + ) + ) { + filename.unshift( + toPascalCase(ReflectionKind.singularString(reflection.parent?.kind)), + ); + } + + const urlBase = path.join(baseUrl, directory, filename.join('.')); + const url = this.flattenOutputFiles + ? urlBase.replace(/\//g, '.') + : urlBase; + + this.urls.push({ + url, + model: reflection, + template: mapping.template, + }); + reflection.url = url; + reflection.hasOwnDocument = true; + } + } + + private buildUrlsFromGroup( + reflection: DeclarationReflection, + urlOptions: UrlOption, + ) { + const mapping: TemplateMapping = this.theme.getTemplateMapping( + reflection.kind, + urlOptions.outputFileStrategy, + ); + + if (mapping) { + let url: string; + let urlPath = ''; + + if (this.flattenOutputFiles) { + url = this.getFlattenedUrl(reflection); + } else { + const directory = urlOptions.directory || mapping.directory; + urlPath = this.getUrlPath(reflection, { + ...urlOptions, + directory, + }); + + url = this.getUrl(reflection, urlPath, urlOptions); + + if (this.ignoreScopes) { + url = removeFirstScopedDirectory(url); + } + + const duplicateUrls = this.urls.filter( + (urlMapping) => + urlMapping.url.toLowerCase() === url.toLowerCase() && + urlMapping.url !== url, + ); + + if (duplicateUrls.length > 0) { + const urlParts = url.split('.'); + urlParts[urlParts.length - 2] += `-${duplicateUrls.length}`; + url = urlParts.join('.'); + } + } + + this.urls.push({ + url: url, + model: reflection, + template: mapping.template, + }); + + reflection.url = url; + reflection.hasOwnDocument = true; + + reflection.groups?.forEach((group) => { + group.children.forEach((groupChild) => { + const mapping = this.theme.getTemplateMapping( + groupChild.kind, + urlOptions.outputFileStrategy, + ); + this.buildUrlsFromGroup(groupChild as DeclarationReflection, { + parentUrl: urlPath, + directory: mapping?.directory || null, + outputFileStrategy: urlOptions.outputFileStrategy, + }); + }); + }); + } else if (reflection.parent) { + this.traverseChildren(reflection, reflection.parent); + } + } + + private getUrl( + reflection: DeclarationReflection, + urlPath: string, + urlOptions: UrlOption, + ) { + const entryModule = + urlOptions.entryModule || this.options.getValue('entryModule'); + + const entryName = urlOptions.entryFileName || this.entryFileName; + + if (reflection.name === entryModule) { + return entryName; + } + + if ( + this.options.getValue('outputFileStrategy') === + OutputFileStrategy.Modules && + reflection.name === 'index' && + path.parse(entryName).name === 'index' + ) { + return urlPath.replace( + getFileNameWithExtension('index', this.fileExtension), + getFileNameWithExtension('module_index', this.fileExtension), + ); + } + return urlPath; + } + + getFlattenedUrl(reflection: DeclarationReflection) { + const fullName = reflection.getFullName(); + + const fullNameParts = fullName.replace(/\//g, '.').split('.'); + if (reflection.kind !== ReflectionKind.Module) { + fullNameParts.splice( + fullNameParts.length - 1, + 0, + toPascalCase(ReflectionKind.singularString(reflection.kind)), + ); + } + const url = `${fullNameParts.join('.')}${this.fileExtension}` + .replace(/"/g, '') + .replace(/ /g, '-') + .replace(/^\./g, ''); + + reflection.url = url; + return url; + } + + private getAlias(name: string) { + if (isQuoted(name)) { + name = name.replace(/\//g, '_'); + } + return name + .replace(/"/g, '') + .replace(/^_+|_+$/g, '') + .replace(/[<>]/g, '-'); + } + + private getUrlPath(reflection: DeclarationReflection, urlOption: UrlOption) { + const alias = this.getAlias(reflection.name); + + const parentDir = urlOption.parentUrl + ? path.dirname(urlOption.parentUrl) + : null; + + const dir = () => { + if (reflection.kind === ReflectionKind.Namespace) { + return `${urlOption.directory}/${alias}`; + } + + if (reflection.kind === ReflectionKind.Module) { + return alias; + } + + return urlOption.directory + ? urlOption.directory + : `${slugify(ReflectionKind.singularString(reflection.kind))}.${alias}`; + }; + + const filename = () => { + if ( + [ReflectionKind.Module, ReflectionKind.Namespace].includes( + reflection.kind, + ) && + this.options.getValue('outputFileStrategy') === + OutputFileStrategy.Modules && + !this.moduleHasSubfolders(reflection) + ) { + return null; + } + if ( + [ReflectionKind.Module, ReflectionKind.Namespace].includes( + reflection.kind, + ) + ) { + return path.parse(this.entryFileName).name; + } + return alias; + }; + + return getFileNameWithExtension( + [parentDir, dir(), filename()].filter((part) => Boolean(part)).join('/'), + this.fileExtension, + ); + } + + private traverseChildren( + reflection: DeclarationReflection, + container: Reflection, + ) { + if (container.url) { + this.applyAnchorUrl(reflection, container.url); + } + if (reflection.parent) { + reflection.traverse((child) => { + if (child instanceof DocumentReflection) { + this.buildUrlsForDocument(child); + } + if (child instanceof DeclarationReflection) { + this.traverseChildren(child, container); + } + }); + } + } + + private applyAnchorUrl( + reflection: DeclarationReflection, + containerUrl: string, + ) { + if (reflection.kind !== ReflectionKind.TypeLiteral) { + const anchorPrefix = this.options.getValue('anchorPrefix'); + const anchorId = this.getAnchorId(reflection); + + if (anchorId) { + if (!this.anchors[containerUrl]) { + this.anchors[containerUrl] = []; + } + + this.anchors[containerUrl].push(anchorId); + + const count = this.anchors[containerUrl]?.filter( + (id) => id === anchorId, + )?.length; + + const anchorParts = [anchorId]; + + if (count > 1) { + anchorParts.push(`-${count - 1}`); + } + + if (anchorPrefix) { + anchorParts.unshift(`${anchorPrefix}`); + } + + reflection.url = containerUrl + '#' + anchorParts.join(''); + reflection.anchor = anchorParts.join(''); + reflection.hasOwnDocument = false; + } + } + } + + private getAnchorId(reflection: DeclarationReflection) { + const preserveAnchorCasing = this.options.getValue('preserveAnchorCasing'); + + const anchorName = this.getAnchorName(reflection); + + if (anchorName) { + return preserveAnchorCasing ? anchorName : anchorName.toLowerCase(); + } + + return null; + } + + private getAnchorName(reflection: DeclarationReflection) { + const htmlTableAnchors = this.options.getValue('useHTMLAnchors'); + + if (!htmlTableAnchors) { + if ( + (reflection.kind === ReflectionKind.Property && + this.options.getValue('propertiesFormat').toLowerCase() === + 'table') || + (reflection.kind === ReflectionKind.Property && + reflection.parent?.kind === ReflectionKind.Class && + this.options.getValue('classPropertiesFormat').toLowerCase() === + 'table') || + (reflection.kind === ReflectionKind.Property && + reflection.parent?.kind === ReflectionKind.Interface && + this.options.getValue('interfacePropertiesFormat').toLowerCase() === + 'table') || + (reflection.kind === ReflectionKind.EnumMember && + this.options.getValue('enumMembersFormat').toLowerCase() === 'table') + ) { + return null; + } + } + if (reflection.kind === ReflectionKind.Constructor) { + return 'Constructors'; + } + const anchorParts = [reflection.name]; + if (reflection.typeParameters?.length) { + anchorParts.push( + reflection.typeParameters + .map((typeParameter) => typeParameter.name) + .join(''), + ); + } + return anchorParts.join(''); + } + + private moduleHasSubfolders(reflection: DeclarationReflection) { + return reflection.childrenIncludingDocuments?.some((child) => + [ReflectionKind.Namespace, ReflectionKind.Document].includes(child.kind), + ); + } + + private getIndexFileName( + reflection: ProjectReflection | DeclarationReflection, + isPackages = false, + ) { + if (isPackages) { + return getFileNameWithExtension('packages', this.fileExtension); + } + const isModules = reflection.children?.every( + (child) => child.kind === ReflectionKind.Module, + ); + return isModules + ? getFileNameWithExtension('modules', this.fileExtension) + : getFileNameWithExtension('globals', this.fileExtension); + } +} diff --git a/packages/typedoc-plugin-markdown/src/theme/context/templates/project.ts b/packages/typedoc-plugin-markdown/src/theme/context/templates/project.ts index e6836bb4..efa7b5f4 100644 --- a/packages/typedoc-plugin-markdown/src/theme/context/templates/project.ts +++ b/packages/typedoc-plugin-markdown/src/theme/context/templates/project.ts @@ -19,9 +19,7 @@ export function project( const isPackages = this.page.project.url === this.page.url && - this.options.getValue('entryPointStrategy') === - EntryPointStrategy.Packages && - this.options.getValue('entryPoints')?.length; + this.options.getValue('entryPointStrategy') === EntryPointStrategy.Packages; md.push(this.hook('index.page.begin').join('\n')); @@ -64,12 +62,12 @@ export function project( headingLevel: 2, }), ); - } - - if (isPackages) { - md.push(this.partials.packagesIndex(page.model)); } else { - md.push(this.partials.body(page.model, { headingLevel: 2 })); + if (isPackages) { + md.push(this.partials.packagesIndex(page.model)); + } else { + md.push(this.partials.body(page.model, { headingLevel: 2 })); + } } md.push(this.partials.footer()); diff --git a/packages/typedoc-plugin-markdown/src/theme/index.ts b/packages/typedoc-plugin-markdown/src/theme/index.ts index 94d42685..fff3c21b 100644 --- a/packages/typedoc-plugin-markdown/src/theme/index.ts +++ b/packages/typedoc-plugin-markdown/src/theme/index.ts @@ -4,4 +4,4 @@ * @module */ export * from './markdown-theme'; -export * from './markdown-theme-context'; +export * from './markdown-themeContext'; diff --git a/packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts b/packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts index 2a16f98d..d62acccb 100644 --- a/packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts +++ b/packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts @@ -2,7 +2,7 @@ import { MarkdownPageEvent } from '@plugin/events'; import { formatMarkdown } from '@plugin/libs/utils'; import { OutputFileStrategy } from '@plugin/options/maps'; import { MarkdownThemeContext } from '@plugin/theme'; -import { getNavigation, getUrls } from '@plugin/theme/base'; +import { NavigationBuilder, UrlBuilder } from '@plugin/theme/base'; import { RenderTemplate } from '@plugin/types'; import { DeclarationReflection, @@ -16,23 +16,14 @@ import { /** * The main theme class for the plugin. + * * The class controls how TypeDoc models are mapped to files and templates and extends TypeDoc's base Theme class. * * You would typically only be interested in overriding the the theme's render context instance. * * The API follows the implementation of [TypeDoc's custom theming](https://github.com/TypeStrong/typedoc/blob/master/internal-docs/custom-themes.md) with some minor adjustments. * - * @example - * - * ```ts - * export function load(app) { - * app.renderer.defineTheme('customTheme', MyMarkdownTheme); - * } - * - * class MyMarkdownTheme extends MarkdownTheme { - * ... - * } - * ``` + * @group Theme Classes */ export class MarkdownTheme extends Theme { constructor(renderer: Renderer) { @@ -69,14 +60,14 @@ export class MarkdownTheme extends Theme { * Maps the models of the given project to the desired output files. */ getUrls(project: ProjectReflection) { - return getUrls(this, project); + return new UrlBuilder(this, project).getUrls(); } /** * Map the models of the given project to a navigation structure. */ getNavigation(project: ProjectReflection) { - return getNavigation(this, project); + return new NavigationBuilder(this, project).getNavigation(); } /** diff --git a/packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts b/packages/typedoc-plugin-markdown/src/theme/markdown-themeContext.ts similarity index 99% rename from packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts rename to packages/typedoc-plugin-markdown/src/theme/markdown-themeContext.ts index 2d1d5dd7..e16090ed 100644 --- a/packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts +++ b/packages/typedoc-plugin-markdown/src/theme/markdown-themeContext.ts @@ -15,6 +15,7 @@ import { Internationalization, Options, Reflection } from 'typedoc'; /** * The theme context class that is provided as context on the rendering of every page. + * * It is heavily influenced by the equivalent [DefaultThemeRenderContext](https://typedoc.org/api/classes/DefaultThemeRenderContext.html) from the default theme. * * This class can be used to customize the theme output by extending the class and overriding the templates, partials and helpers. @@ -34,6 +35,8 @@ import { Internationalization, Options, Reflection } from 'typedoc'; * @privateRemarks * * In order to create cleaner code, internally individual templates located in the `resources/templates` directory are bound to the this. + * + * @group Theme Classes */ export class MarkdownThemeContext { internationalization: Internationalization.Internationalization; diff --git a/packages/typedoc-plugin-markdown/src/types/internationalization.ts b/packages/typedoc-plugin-markdown/src/types/internationalization.ts index f855f1d0..e36d7302 100644 --- a/packages/typedoc-plugin-markdown/src/types/internationalization.ts +++ b/packages/typedoc-plugin-markdown/src/types/internationalization.ts @@ -14,6 +14,7 @@ export interface TranslatableStrings { theme_event: string; theme_extends: string; theme_extended_by: string; + theme_globals: string; theme_member: string; theme_member_plural: string; theme_modifier: string; diff --git a/packages/typedoc-plugin-markdown/src/types/markdown-application.ts b/packages/typedoc-plugin-markdown/src/types/markdown-application.ts index 51a27242..36168dd3 100644 --- a/packages/typedoc-plugin-markdown/src/types/markdown-application.ts +++ b/packages/typedoc-plugin-markdown/src/types/markdown-application.ts @@ -2,18 +2,7 @@ import { Application } from 'typedoc'; import { MarkdownRenderer } from './markdown-renderer'; /** - * This interface is essentially an extended typing of TypeDoc's {@linkcode typedoc!Application Application} instance. - * - * @example - * - * ```ts - * import { MarkdownApplication } from 'typedoc-plugin-markdown'; - * - * export function load(app: MarkdownApplication) { - * ... - * } - * ``` - * + * This interface is essentially an extended typing of TypeDoc's {@linkcode typedoc!Application Application} instance.`` */ export interface MarkdownApplication extends Application { /** diff --git a/packages/typedoc-plugin-markdown/src/types/markdown-renderer.ts b/packages/typedoc-plugin-markdown/src/types/markdown-renderer.ts index 55a1c077..f3d4fe15 100644 --- a/packages/typedoc-plugin-markdown/src/types/markdown-renderer.ts +++ b/packages/typedoc-plugin-markdown/src/types/markdown-renderer.ts @@ -5,29 +5,6 @@ import { MarkdownRendererHooks } from './markdown-renderer-hooks'; /** * An extended typing of TypeDoc's {@linkcode typedoc!Renderer Renderer} class that includes updated typings for hooks and async jobs. - * - * @example - * - * ```ts - * import { MarkdownApplication } from 'typedoc-plugin-markdown'; - * - * export function load(app: MarkdownApplication) { - * - * app.renderer.markdownHooks.on( - * 'page.begin', () => '> This is some markdown at the top of the page', - * ); - * - * app.renderer.preRenderAsyncJobs.push(async (output: MarkdownRendererEvent) => { - * await doSomethingAsync(output); - * }); - - * app.renderer.postRenderAsyncJobs.push(async (output: MarkdownRendererEvent)) => { - * await doSomethingAsync(output); - * }); - * - * } - * ``` - * */ export interface MarkdownRenderer extends Renderer { /** diff --git a/packages/typedoc-plugin-markdown/supporting-docs/getting-started.md b/packages/typedoc-plugin-markdown/supporting-docs/internal/getting-started.md similarity index 74% rename from packages/typedoc-plugin-markdown/supporting-docs/getting-started.md rename to packages/typedoc-plugin-markdown/supporting-docs/internal/getting-started.md index 72ffa711..fece44c6 100644 --- a/packages/typedoc-plugin-markdown/supporting-docs/getting-started.md +++ b/packages/typedoc-plugin-markdown/supporting-docs/internal/getting-started.md @@ -1,47 +1,27 @@ --- title: Getting Started -description: Instructions on how to start developing locally. +description: How to start developing locally. --- # Getting Started -## Machine Setup +This guide provides some high-level steps with some typical development tasks. -### Fork and clone the repository +## Setup -Start by forking the repository to your own GitHub account. Then, clone the repository to your local machine. Please replace `` with your actual GitHub username. +Please see [Machine Setup](../../README.md) for general setup instructions. -```bash -git clone git@github.com:/typedoc-plugin-markdown.git -``` - -### Install dependencies - -Navigate to the repository root and install the necessary dependencies: - -```bash -cd typedoc-plugin-markdown - -npm install -``` +If you are setup, you can start by navigating to the package directory. -### Build the package - -Next cd into the package itself and run npm run build. - -```bash +```shell cd packages/typedoc-plugin-markdown - -npm run build ``` -The build process triggers several setup tasks. If the project builds successfully you are ready to start developing. - ## Development Playground To get started you can create a simple task of running a playground and editing a template. -### Run playground docs +### Run Playground Docs Run the playground from the project root. @@ -49,7 +29,7 @@ Run the playground from the project root. npm run playground ``` -### View playground docs +### View Playground Docs The above commands will generate some the markdown docs in the `./playground/docs` folder. @@ -72,7 +52,7 @@ We will use option 2 as an example here: markserv ./playground/docs/README.md ``` -### Perform a simple task +### Perform a Simple Task Now we have a playground setup we can perform some typical development tasks. diff --git a/packages/typedoc-plugin-markdown/supporting-docs/internal/test-and-validation.md b/packages/typedoc-plugin-markdown/supporting-docs/internal/test-and-validation.md new file mode 100644 index 00000000..2b378aff --- /dev/null +++ b/packages/typedoc-plugin-markdown/supporting-docs/internal/test-and-validation.md @@ -0,0 +1,70 @@ +--- +title: Test and Validation +description: Guidance on running tests, creating fixtures and validating output. +--- + +# Test and Validation + +This document contains guidance on running tests and creating fixtures. + +## Tooling + +- We use [Jest](https://jestjs.io/) with [ts-Jest](https://kulshekhar.github.io/ts-jest/) to run our test suites. +- We use [markdownlint](https://github.com/DavidAnson/markdownlint) and [remark-mdx](https://mdxjs.com/packages/remark-mdx/) to validate markdown. + +## Get Started + +The following command runs all tests. + +```bash +npm run test +``` + +This command: + +- Generates a suite of fixtures on a `prebuild` task. +- Runs some validation scripts to check the output of the fixtures. +- Runs Jest and triggers the spec files. + +## Fixtures + +We reply heavily (but not exclusively) on snapshot testing. We do this because we need to ensure output is correct +after converting with TypeDoc. + +A series of snapshot tests are used to ensure the output of the plugin is consistent. + +### Building Fixtures + +- The `/fixtures/src` folder contains a set of TypeScript source files that are used as entrypoints. +- The `/fixtures/config.ts` is a configuration file that generates a set of fixture output files that are used by the Jest snapshot tests. It provides a mechanism to easily provide a combination of options. + +The fixtures are build in `pretest` script using a an internal package workspace. See `devtools/packages/fixtures`. + +## Test + +Tests are run on the Jest test suite. + +### Specs + +- There are a suite of tests located in `/test/specs`. These tests run a series of snapshot tests against some output fixtures. +- All pure utility lib methods also have specs run against them in `/src/libs/utils`. + +### Updating Snapshots + +If you make a change to any code the you can update the snapshot source and add a test in the relevant spec file. + +If you require to update the snapshots run the following command: + +```bash +npm run test:update +``` + +## Validation + +Validation is undertaken by the markdownlint and remark-mdx libraries. +When the fixtures are build the output markdown is validated. + +### Validation Scripts + +- `markdownlint` ensures that all output is commonMark complaint. See `/test/script/lint.md`. +- `remark-mdx` ensures that the output is also MDX compliant. See `/test/script/lint.mdx`. diff --git a/packages/typedoc-plugin-markdown/supporting-docs/internationalization.md b/packages/typedoc-plugin-markdown/supporting-docs/internationalization.md deleted file mode 100644 index 5387554d..00000000 --- a/packages/typedoc-plugin-markdown/supporting-docs/internationalization.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -title: Internationalization Guidance -description: How to edit or add a new locale to custom plugin translatable strings. ---- - -# Adding new options - -Options exposed to TypeDoc are added as a named export to the declarations `declarations.ts` options config file. - -```ts -/** - * Some more detailed comments about the option. - * - * @category UI - */ -export const myNewOption: Partial = { - help: 'A short description of the option.', - type: ParameterType.Boolean, - defaultValue: false, -}; -``` - -This will be exposed to TypeDoc as a new option when bootstrapping the plugin, with the name of the option the name of the exported variable. - -In addition, when the `prebuild` task is run: - -- The option type will be added to `TypeDocOptionsMap`. -- The documentation will be updated using the JSDoc comments. diff --git a/packages/typedoc-plugin-markdown/supporting-docs/customizing-output.md b/packages/typedoc-plugin-markdown/supporting-docs/public/customizing-output.md similarity index 57% rename from packages/typedoc-plugin-markdown/supporting-docs/customizing-output.md rename to packages/typedoc-plugin-markdown/supporting-docs/public/customizing-output.md index 60db1dc4..02c33bb4 100644 --- a/packages/typedoc-plugin-markdown/supporting-docs/customizing-output.md +++ b/packages/typedoc-plugin-markdown/supporting-docs/public/customizing-output.md @@ -6,16 +6,22 @@ description: How to extend and customize output. # Customizing Output It is possible to customize the output of the generated markdown files by creating local plugins. - All these concepts follow an adapted version of [TypeDoc's core customization implementation](https://github.com/TypeStrong/typedoc/blob/master/internal-docs/custom-themes.md). +See the [Local Plugins](/api-docs/Document.Local-Plugins) guide for implementation details. + ## Hooks -Hooks allows strings to be injected into the output in specific locations and are the most basic form form of customization. +Hooks allows strings to be injected into the output in specific locations and are the most basic form of customization. -```ts filename="custom-theme.ts" -// Add a hook to insert markdown at the top of the page. -export function load(app: MarkdownApplication) { +### Example + +```ts filename="custom-plugin.mjs" +// @ts-check +/** + * @param {import('typedoc-plugin-markdown').MarkdownApplication} app + */ +export function load(app) { app.renderer.markdownHooks.on('page.end', () => `**Generated using \`page.end\` hook**`); } ``` @@ -28,24 +34,78 @@ export function load(app: MarkdownApplication) { Events are more powerful than hooks and allow for more complex customizations and provide a context that can be used to modify the output. -```ts filename="custom-plugin.ts" -export function load(app: MarkdownApplication) { - app.renderer.on(MarkdownPageEvent.END, (page: MarkdownPageEvent) => { - page.contents = page.contents.replace('foo', 'bar'); - }); +### Renderer Events + +Renderer events are emitted at the beginning (before pages are rendered) and end (after pages are rendered) of the rendering process. +You would typically use this event to modify urls or navigation structure. + +#### Example + +```ts filename="custom-plugin.mjs" +// @ts-check +/** + * @param {import('typedoc-plugin-markdown').MarkdownApplication} app + */ +export function load(app) { + app.renderer.on( + MarkdownRendererEvent.BEGIN, + /** + * @param {import('typedoc-plugin-markdown').MarkdownRendererEvent} renderer + */ + (renderer) => { + renderer.urls = event.urls.map((urlMapping) => { + const newUrl = urlMapping.url.replace('foo', 'bar'); + urlMapping.url = newUrl; + urlMapping.model.url = newUrl; // also required + return urlMapping; + }); + }, + ); } ``` -### See +#### See + +- [MarkdownRendererEvent](/api-docs/Class.MarkdownRendererEvent). + +### Page Events -- [MarkdownRendererEvent](https://typedoc-plugin-markdown.org/api-docs/Class.MarkdownRendererEvent). -- [MarkdownPageEvent](https://typedoc-plugin-markdown.org/api-docs/Class.MarkdownPageEvent). +Page events emitted before and after the markdown of each page is rendered. +You would typically use this event to modify content of a page. + +#### Example + +```ts filename="custom-plugin.mjs" +// @ts-check +/** + * @param {import('typedoc-plugin-markdown').MarkdownApplication} app + */ +export function load(app) { + app.renderer.on( + MarkdownPageEvent.BEGIN, + /** + * @param {import('typedoc-plugin-markdown').MarkdownPageEvent} page + */ + (page) => { + page.contents = page.contents.replace('foo', 'bar'); + }, + ); +} +``` + +#### See + +- [MarkdownPageEvent](/api-docs/Class.MarkdownPageEvent). ## Async Jobs Async jobs are used to perform asynchronous tasks before or after rendering with a provided context. -```ts filename="custom-plugin.ts" +```ts filename="custom-plugin.mjs" +// @ts-check +/** + * @param {import('typedoc-plugin-markdown').MarkdownApplication} app + */ export function load(app: MarkdownApplication) { app.renderer.preRenderAsyncJobs.push(async (renderer) => { await doSomethingAsync(renderer); @@ -63,12 +123,12 @@ If there are some specific customization not achievable with hooks or events the This implementation follows an adapted version of [TypeDoc's custom theming implementation](https://github.com/TypeStrong/typedoc/blob/master/internal-docs/custom-themes.md). -In theory all available templates, partials and helpers can be overriden with custom implementations. +### Example This code defines a new theme called “customTheme”: -```ts filename="custom-plugin.ts" -export function load(app: MarkdownApplication) { +```ts +export function load(app) { app.renderer.defineTheme('customTheme', MyMarkdownTheme); } @@ -86,7 +146,7 @@ The theme can then be consumed by the `theme` option: The themes can be extended to provide custom partials, helpers and templates by proving a custom render context class. -```ts filename="custom-theme.ts" +```ts class MyMarkdownTheme extends MarkdownTheme { getRenderContext(page) { return new MyMarkdownThemeContext(this, page, this.application.options); @@ -123,9 +183,7 @@ Use my new helper - ${this.helpers.newHelper()} } ``` -Please see the [Custom Theme API](/api-docs#custom-theme) for more information. - ### See -- [MarkdownTheme](https://typedoc-plugin-markdown.org/api-docs/Class.MarkdownTheme). -- [MarkdownThemeContext](https://typedoc-plugin-markdown.org/api-docs/Class.MarkdownThemeContext). +- [MarkdownTheme](/api-docs/Class.MarkdownTheme). +- [MarkdownThemeContext](/api-docs/Class.MarkdownThemeContext). diff --git a/packages/typedoc-plugin-markdown/supporting-docs/local-plugins.md b/packages/typedoc-plugin-markdown/supporting-docs/public/local-plugins.md similarity index 89% rename from packages/typedoc-plugin-markdown/supporting-docs/local-plugins.md rename to packages/typedoc-plugin-markdown/supporting-docs/public/local-plugins.md index 69477553..6276f69e 100644 --- a/packages/typedoc-plugin-markdown/supporting-docs/local-plugins.md +++ b/packages/typedoc-plugin-markdown/supporting-docs/public/local-plugins.md @@ -22,7 +22,7 @@ export function load(app) { } ``` -The plugin can then be consumed by adding the path to the plugin in the typedoc.json file: +The plugin can then be consumed by adding the path to the plugin in your `typedoc.json` file: ```json filename="typedoc.json" { @@ -30,7 +30,7 @@ The plugin can then be consumed by adding the path to the plugin in the typedoc. } ``` -Note plugins can either be consumed as either CommonJs or ESM. +Note plugins can either be consumed as CommonJs or ESM. ## See diff --git a/packages/typedoc-plugin-markdown/supporting-docs/navigation.md b/packages/typedoc-plugin-markdown/supporting-docs/public/utilizing-navigation.md similarity index 95% rename from packages/typedoc-plugin-markdown/supporting-docs/navigation.md rename to packages/typedoc-plugin-markdown/supporting-docs/public/utilizing-navigation.md index a3c25e73..569c9176 100644 --- a/packages/typedoc-plugin-markdown/supporting-docs/navigation.md +++ b/packages/typedoc-plugin-markdown/supporting-docs/public/utilizing-navigation.md @@ -1,9 +1,9 @@ --- -title: Navigation +title: Utilizing Navigation description: How to create a custom navigation structure. --- -# Navigation +# Utilizing Navigation If required, a navigation model can be provided to the output. This is useful if you want to provide a custom sidebar/navigation implementation (if relevant to your environment). diff --git a/packages/typedoc-plugin-markdown/supporting-docs/testing.md b/packages/typedoc-plugin-markdown/supporting-docs/testing.md deleted file mode 100644 index cde9ad04..00000000 --- a/packages/typedoc-plugin-markdown/supporting-docs/testing.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -title: Testing -description: Guidance of running tests and creating fixtures. ---- - -# Testing - -> This page is incomplete. More docs to come shortly. - -## Running tests - -```bash -npm run test -``` - -If you require to update the snapshots run the following command: - -```bash -npm run test:update -``` - -## Test Fixtures - -A series of snapshot tests are used to ensure the output of the plugin is consistent. - -- Example code for fixtures are located at `/test/fixtures/src`. -- Fixtures output scenarios are setup using a config file (`/test/fixtures/config.ts`) that provides a mechanism to easily provide a combination of options. diff --git a/packages/typedoc-plugin-markdown/test/specs/__snapshots__/navigation.spec.ts.snap b/packages/typedoc-plugin-markdown/test/specs/__snapshots__/navigation.spec.ts.snap index a5023ef2..79397a77 100644 --- a/packages/typedoc-plugin-markdown/test/specs/__snapshots__/navigation.spec.ts.snap +++ b/packages/typedoc-plugin-markdown/test/specs/__snapshots__/navigation.spec.ts.snap @@ -623,7 +623,7 @@ exports[`Navigation should get Navigation Json for packages: (Output File Strate "kind": 2, "children": [ { - "title": "Modules", + "title": "Globals", "path": "@scope/package-1/globals.md", "kind": 2 } diff --git a/packages/typedoc-plugin-markdown/typedoc.json b/packages/typedoc-plugin-markdown/typedoc.json index f6caf000..48ac86a0 100644 --- a/packages/typedoc-plugin-markdown/typedoc.json +++ b/packages/typedoc-plugin-markdown/typedoc.json @@ -12,7 +12,7 @@ "exclude": ["./src/public-api.ts"], "categoryOrder": ["File", "Display", "Utility", "Methods", "Locales"], "projectDocuments": [ - "./supporting-docs/getting-started.md", - "./supporting-docs/testing.md" + "./supporting-docs/internal/getting-started.md", + "./supporting-docs/internal/test-and-validation.md" ] } diff --git a/packages/typedoc-plugin-markdown/typedoc.public.json b/packages/typedoc-plugin-markdown/typedoc.public.json new file mode 100644 index 00000000..480b33ed --- /dev/null +++ b/packages/typedoc-plugin-markdown/typedoc.public.json @@ -0,0 +1,47 @@ +{ + "entryPoints": ["./src/public-api.ts"], + "out": "../../docs/pages/api-docs", + "plugin": [ + "typedoc-plugin-markdown", + "../../devtools/typedoc-plugins/typedoc-nextra.mjs", + "../../devtools/typedoc-plugins/typedoc-ignore-typeparam.mjs", + "../../devtools/typedoc-plugins/typedoc-symbols.mjs" + ], + "outputFileStrategy": "members", + "fileExtension": ".mdx", + "publicPath": "/api-docs", + "indexFormat": "table", + "readme": "none", + "entryFileName": "index.md", + "hideBreadcrumbs": true, + "hidePageHeader": true, + "excludeGroups": false, + "expandObjects": false, + "parametersFormat": "table", + "expandParameters": false, + "groupOrder": ["Documents", "Events", "Theme Classes", "Interfaces"], + "tableColumnSettings": { + "hideOverrides": true, + "hideModifiers": true, + "hideDefaults": true, + "hideSources": true, + "leftAlignHeaders": true + }, + "useCodeBlocks": false, + "textContentMappings": { + "title.memberPage": "{name}" + }, + "flattenOutputFiles": true, + "sortEntryPoints": false, + "name": "API", + "sort": ["required-first", "source-order"], + "includeVersion": false, + "disableSources": true, + "excludeInternal": true, + "excludeExternals": true, + "excludePrivate": true, + "navigation": { + "includeCategories": true, + "includeGroups": false + } +} diff --git a/packages/typedoc-plugin-remark/OVERVIEW.md b/packages/typedoc-plugin-remark/OVERVIEW.md index afe41d18..ba0dde73 100644 --- a/packages/typedoc-plugin-remark/OVERVIEW.md +++ b/packages/typedoc-plugin-remark/OVERVIEW.md @@ -2,7 +2,7 @@ "typedoc-plugin-remark" is a utility package that pipes output though specified remark plugins. -## What does the package do? +## What Does the Package Do? - Exposes some additional options to TypeDoc. - Initializes a new remark processor and transform that syntax tree (mdast) using plugins. diff --git a/packages/typedoc-plugin-remark/src/options/helpers.ts b/packages/typedoc-plugin-remark/src/options/helpers.ts index bf94b182..15cd6e6f 100644 --- a/packages/typedoc-plugin-remark/src/options/helpers.ts +++ b/packages/typedoc-plugin-remark/src/options/helpers.ts @@ -18,6 +18,7 @@ export function addTableOfContents( const outputFileStrategy = app.options.getValue('outputFileStrategy'); const kindsWithToc = [ + ReflectionKind.Project, ReflectionKind.Module, ReflectionKind.Namespace, ReflectionKind.Class, diff --git a/packages/typedoc-vitepress-theme/OVERVIEW.md b/packages/typedoc-vitepress-theme/OVERVIEW.md index dc0dc0e3..b5c1c03e 100644 --- a/packages/typedoc-vitepress-theme/OVERVIEW.md +++ b/packages/typedoc-vitepress-theme/OVERVIEW.md @@ -2,7 +2,7 @@ "typedoc-vitepress-theme" is a "theme" in the sense that it targets output for VitePress. -## What does the package do? +## What Does the Package Do? - Exposes some additional options to TypeDoc. - Presets relevant typedoc-plugin-markdown options. diff --git a/packages/typedoc-vitepress-theme/src/index.ts b/packages/typedoc-vitepress-theme/src/index.ts index 09653776..be98617c 100644 --- a/packages/typedoc-vitepress-theme/src/index.ts +++ b/packages/typedoc-vitepress-theme/src/index.ts @@ -5,22 +5,17 @@ */ import * as fs from 'fs'; import * as path from 'path'; +import { DeclarationOption, Options, OptionsReader } from 'typedoc'; import { - Application, - DeclarationOption, - Options, - OptionsReader, -} from 'typedoc'; -import { + MarkdownApplication, MarkdownPageEvent, - MarkdownRendererEvent, } from 'typedoc-plugin-markdown'; import { DEFAULT_SIDEBAR_OPTIONS } from './options'; import * as options from './options/declarations'; import { presets } from './options/presets'; import { getSidebar } from './sidebars/sidebars'; -export function load(app: Application) { +export function load(app: MarkdownApplication) { Object.entries(options).forEach(([name, option]) => { app.options.addDeclaration({ name, @@ -55,34 +50,29 @@ export function load(app: Application) { ); }); - app.renderer.postRenderAsyncJobs.push( - async (output: MarkdownRendererEvent) => { - const sidebarOptions = { - ...DEFAULT_SIDEBAR_OPTIONS, - ...app.options.getValue('sidebar'), - }; - if (sidebarOptions.autoConfiguration && output.navigation) { - const outDir = app.options.getValue('out'); - const sidebarPath = path.resolve(outDir, 'typedoc-sidebar.json'); - const basePath = path.relative( - app.options.getValue('docsRoot'), - outDir, - ); + app.renderer.postRenderAsyncJobs.push(async (output) => { + const sidebarOptions = { + ...DEFAULT_SIDEBAR_OPTIONS, + ...app.options.getValue('sidebar'), + }; + if (sidebarOptions.autoConfiguration && output.navigation) { + const outDir = app.options.getValue('out'); + const sidebarPath = path.resolve(outDir, 'typedoc-sidebar.json'); + const basePath = path.relative(app.options.getValue('docsRoot'), outDir); - const sidebarJson = getSidebar( - output.navigation, - basePath, - sidebarOptions, - ); - fs.writeFileSync( - sidebarPath, - sidebarOptions.pretty - ? JSON.stringify(sidebarJson, null, 2) - : JSON.stringify(sidebarJson), - ); - } - }, - ); + const sidebarJson = getSidebar( + output.navigation, + basePath, + sidebarOptions, + ); + fs.writeFileSync( + sidebarPath, + sidebarOptions.pretty + ? JSON.stringify(sidebarJson, null, 2) + : JSON.stringify(sidebarJson), + ); + } + }); } function slugifyAnchor(anchor: string) { diff --git a/typedoc.json b/typedoc.json index 5ae7778f..69f4f7df 100644 --- a/typedoc.json +++ b/typedoc.json @@ -1,7 +1,9 @@ { "$schema": "https://typedoc-plugin-markdown.org/schema.json", - "name": "Developer Documentation", - "out": "./developer-docs", + + // typedoc options + "name": "Developer Guide", + "out": "./devguide", "entryPoints": [ "./packages/typedoc-plugin-markdown", "./packages/typedoc-plugin-frontmatter", @@ -11,22 +13,33 @@ "./packages/typedoc-vitepress-theme", "./packages/docusaurus-plugin-typedoc" ], + "plugin": [ "./packages/typedoc-plugin-markdown/dist", + "./packages/typedoc-plugin-remark/dist", "./devtools/typedoc-plugins/typedoc-default-values.js", - "./packages/typedoc-plugin-remark/dist" + "./devtools/typedoc-plugins/typedoc-symbols.mjs" ], "entryPointStrategy": "packages", + "excludePrivate": false, + "readme": "./packages/README.md", + "packageOptions": { + "includeVersion": true, + "excludePrivate": false, + "readme": "./OVERVIEW.md", + "sortEntryPoints": false, + "sort": "source-order", + "excludeExternals": true + }, + + // typedoc-plugin-markdown options + "mergeReadme": true, "outputFileStrategy": "members", "membersWithOwnFile": ["Class", "Interface", "TypeAlias", "Enum"], - "readme": "none", - "mergeReadme": true, - "excludePrivate": false, - "projectDocuments": ["./OVERVIEW.md"], "hidePageHeader": true, "hideGroupHeadings": true, "textContentMappings": { - "breadcrumbs.home": "Packages Index" + "breadcrumbs.home": "Home" }, "expandObjects": false, "useCodeBlocks": false, @@ -45,62 +58,5 @@ "skip": "Default Value|Defined in|Example|Overrides|Parameters|Returns|See|Type declaration" } ] - ], - "externalSymbolLinkMappings": { - "typedoc": { - "ArrayType": "https://typedoc.org/api/types/Models.ArrayType.html", - "Application": "https://typedoc.org/api/classes/Application.html", - "Comment": "https://typedoc.org/api/types/Models.Comment.html", - "CommentDisplayPart": "https://typedoc.org/api/types/Models.CommentDisplayPart.html", - "ConditionalType": "https://typedoc.org/api/types/Models.ConditionalType.html", - "ContainerReflection": "https://typedoc.org/api/classes/Models.ContainerReflection.html", - "DeclarationHierarchy": "https://typedoc.org/api/classes/Models.DeclarationHierarchy.html", - "DeclarationOption": "https://typedoc.org/api/types/Configuration.DeclarationOption.html", - "DeclarationReflection": "https://typedoc.org/api/classes/Models.DeclarationReflection.html", - "DefaultThemeRenderContext": "https://typedoc.org/api/classes/DefaultThemeRenderContext.html", - "Event": "https://typedoc.org/api/classes/Event.html", - "EventHooks": "https://typedoc.org/api/classes/EventHooks.html", - "IndexedAccessType": "https://typedoc.org/api/types/Models.IndexedAccessType.html", - "InferredType": "https://typedoc.org/api/types/Models.InferredType.html", - "IntersectionType": "https://typedoc.org/api/types/Models.IntersectionType.html", - "IntrinsicType": "https://typedoc.org/api/types/Models.IntrinsicType.html", - "LiteralType": "https://typedoc.org/api/types/Models.LiteralType.html", - "NamedTupleMember": "https://typedoc.org/api/types/Models.NamedTupleMember.html", - "ManuallyValidatedOption": "https://typedoc.org/api/types/Configuration.ManuallyValidatedOption.html", - "Options": "https://typedoc.org/api/classes/Configuration.Options.html", - "PageEvent": "https://typedoc.org/api/classes/PageEvent.html", - "ParameterReflection": "https://typedoc.org/api/classes/Models.ParameterReflection.html", - "ProjectReflection": "https://typedoc.org/api/classes/Models.ProjectReflection.html", - "ReferenceReflection": "https://typedoc.org/api/classes/Models.ReferenceReflection.html", - "ReferenceType": "https://typedoc.org/api/classes/Models.ReferenceType.html", - "Renderer": "https://typedoc.org/api/classes/Renderer.html", - "RendererEvent": "https://typedoc.org/api/classes/RendererEvent.html", - "RenderTemplate": "https://typedoc.org/api/types/RenderTemplate.html", - "Reflection": "https://typedoc.org/api/classes/Models.Reflection.html", - "ReflectionCategory": "https://typedoc.org/api/types/Models.ReflectionCategory.html", - "ReflectionFlags": "https://typedoc.org/api/classes/Models.ReflectionFlags.html", - "ReflectionGroup": "https://typedoc.org/api/classes/Models.ReflectionGroup.html", - "ReflectionKind": "https://typedoc.org/api/enums/Models.ReflectionKind-1.html", - "ReflectionType": "https://typedoc.org/api/classes/Models.ReflectionType.html", - "SignatureReflection": "https://typedoc.org/api/classes/Models.SignatureReflection.html", - "SomeType": "https://typedoc.org/api/classes/Models.SomeType.html", - "TypeParameterReflection": "https://typedoc.org/api/classes/Models.TypeParameterReflection.html", - "Theme": "https://typedoc.org/api/classes/Theme.html", - "TypeDocOptions": "https://typedoc.org/api/interfaces/TypeDocOptions.html", - "TypeOperatorType": "https://typedoc.org/api/interfaces/TypeOperatorType.html", - "TupleType": "https://typedoc.org/api/classes/Models.TupleType.html", - "QueryType": "https://typedoc.org/api/types/Models.QueryType.html", - "UnknownType": "https://typedoc.org/api/types/Models.UnknownType.html", - "UnionType": "https://typedoc.org/api/types/Models.UnionType.html", - "UrlMapping": "https://typedoc.org/api/classes/UrlMapping.html" - } - }, - "packageOptions": { - "includeVersion": true, - "excludePrivate": false, - "readme": "./OVERVIEW.md", - "sortEntryPoints": false, - "sort": "source-order", - "excludeExternals": true - } + ] }