From 974a60d92b781b98870a107f728f50df2d462efe Mon Sep 17 00:00:00 2001 From: tgreyuk Date: Sun, 22 Sep 2024 23:37:02 +0100 Subject: [PATCH] chore(docs): updated docs --- docs/pages/docs/typedoc-usage.mdx | 17 +++++++++-------- packages/typedoc-plugin-markdown/CHANGELOG.md | 2 +- 2 files changed, 10 insertions(+), 9 deletions(-) diff --git a/docs/pages/docs/typedoc-usage.mdx b/docs/pages/docs/typedoc-usage.mdx index b61263867..6fbce159e 100644 --- a/docs/pages/docs/typedoc-usage.mdx +++ b/docs/pages/docs/typedoc-usage.mdx @@ -25,14 +25,15 @@ TypeDoc's [Output](https://typedoc.org/options/output/) options are used by the Below is a list of which TypeDoc Output options are supported: -- `--out` Yes ✅ -- `--navigation` Yes ✅ ([See Utilizing Navigation](/api-docs/Document.Utilizing-Navigation)) -- `--theme` Yes ✅ (theme should be MarkdownTheme instance) -- `--cleanOutputDir` Yes ✅ -- `--lang` Yes ✅ -- `--locale` Yes ✅ -- `--basePath` Yes ✅ -- `--githubPages` Yes ✅ (defaults to `false`) +- [`--out`](https://typedoc.org/options/output/#out) Yes ✅ +- [`--navigation`](https://typedoc.org/options/output/#navigation) Yes ✅ ([See Utilizing Navigation](/api-docs/Document.Utilizing-Navigation)) +- [`--theme`](https://typedoc.org/options/output/#theme) Yes ✅ (theme should be MarkdownTheme instance) +- [`--cleanOutputDir`](https://typedoc.org/options/output/#cleanoutputdir) Yes ✅ +- [`--lang`](https://typedoc.org/options/output/#lang) Yes ✅ +- [`--locale`](https://typedoc.org/options/output/#locale) Yes ✅ +- [`--basePath`](https://typedoc.org/options/output/#basepath) Yes ✅ +- [`--githubPages`](https://typedoc.org/options/output/#githubpages) Yes ✅ (defaults to `false`) +- `--hostedBaseUrl` & `--useHostedBaseUrlForAbsoluteLinks` No ❌ (use ) - `--hideParameterTypesInTitle` No ❌ (use ) - `--titleLink` No ❌ - `--navigationLinks` No ❌ diff --git a/packages/typedoc-plugin-markdown/CHANGELOG.md b/packages/typedoc-plugin-markdown/CHANGELOG.md index 9886ce12e..3e3aaea39 100644 --- a/packages/typedoc-plugin-markdown/CHANGELOG.md +++ b/packages/typedoc-plugin-markdown/CHANGELOG.md @@ -1,6 +1,6 @@ # Changelog -## 4.2.8 +## 4.2.8 (2024-09-22) ### Patch Changes