diff --git a/docs/pages/docs/typedoc-usage.mdx b/docs/pages/docs/typedoc-usage.mdx index 841bcc842..f28be1c47 100644 --- a/docs/pages/docs/typedoc-usage.mdx +++ b/docs/pages/docs/typedoc-usage.mdx @@ -25,13 +25,12 @@ 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`](https://typedoc.org/options/output/#out) ✅ -- [`--navigation`](https://typedoc.org/options/output/#navigation) ✅ ([See Utilizing Navigation](/api-docs/Document.Utilizing-Navigation)) -- [`--cleanOutputDir`](https://typedoc.org/options/output/#cleanoutputdir) ✅ -- [`--lang`](https://typedoc.org/options/output/#lang) ✅ -- [`--locale`](https://typedoc.org/options/output/#locale) ✅ -- [`--basePath`](https://typedoc.org/options/output/#basepath) ✅ -- [`--githubPages`](https://typedoc.org/options/output/#githubpages) ✅ (defaults to `false`) +- [`--out`](https://typedoc.org/documents/Options.Output.html#out) ✅ +- [`--navigation`](https://typedoc.org/documents/Options.Output.html#navigation) ✅ ([See Utilizing Navigation](/api-docs/Document.Utilizing-Navigation)) +- [`--cleanOutputDir`](https://typedoc.org/documents/Options.Output.html#cleanoutputdir) ✅ +- [`--lang`](https://typedoc.org/documents/Options.Output.html#lang) ✅ +- [`--locales`](https://typedoc.org/documents/Options.Output.html#locales) ✅ +- [`--githubPages`](https://typedoc.org/documents/Options.Output.html#githubpages) ✅ (defaults to `false`) All other output options will have no effect on the markdown output. diff --git a/packages/typedoc-plugin-markdown/src/options/declarations.ts b/packages/typedoc-plugin-markdown/src/options/declarations.ts index abe9e9cd4..78ede78ce 100644 --- a/packages/typedoc-plugin-markdown/src/options/declarations.ts +++ b/packages/typedoc-plugin-markdown/src/options/declarations.ts @@ -335,7 +335,7 @@ export const useCodeBlocks: Partial = { }; /** - * By default objects inside declarations are collapsed to preserve space and improve readability. + * By default when objects have associated documentation, object declarations are collapsed to preserve space and improve readability. * * This option should be set when a full object representation is preferred. *