From 8758ef74c77a709dc04dc1ffcefb409c3076834d Mon Sep 17 00:00:00 2001 From: tgreyuk Date: Tue, 7 May 2024 21:51:06 +0100 Subject: [PATCH] chore(all): updated docs --- docs/pages/docs/options.mdx | 6 ++++++ docs/pages/docs/typedoc-usage.mdx | 2 +- docs/pages/plugins/docusaurus.mdx | 2 +- docs/theme.config.jsx | 2 +- .../typedoc-plugin-markdown/src/options/declarations.ts | 4 ++++ 5 files changed, 13 insertions(+), 3 deletions(-) diff --git a/docs/pages/docs/options.mdx b/docs/pages/docs/options.mdx index c612e2b07..e6c41fbd5 100644 --- a/docs/pages/docs/options.mdx +++ b/docs/pages/docs/options.mdx @@ -485,6 +485,12 @@ For a packages index page (when `--entryPointStrategy` equals `packages`), the p > Accepts a key/value object. + + **Please note TypeDoc 0.26 will be introducing a native i18n implementation. + This option will likely be deprecated in favour of utilizing the native + implementation when it 0.26 is released.** + + This option enables changing static text rendered to the documentation. Useful if an alternative English phrase is preferred or to translate English text to another language. This option does not attempt to address translating text within code comments. diff --git a/docs/pages/docs/typedoc-usage.mdx b/docs/pages/docs/typedoc-usage.mdx index 8c66bd951..2b561422b 100644 --- a/docs/pages/docs/typedoc-usage.mdx +++ b/docs/pages/docs/typedoc-usage.mdx @@ -67,7 +67,7 @@ You can utilize the provided JSON schema at https://typedoc-plugin-markdown.org/ ### JavaScript Files -For JavaScript files, the `PluginOptions` interface that can be imported to a `typedoc.config.js` file with a `@type` annotation. +For JavaScript files, the `PluginOptions` interface can be imported to a `typedoc.config.js` file with a `@type` annotation. You can use intersection types to combine the TypeDoc options with the plugin options. diff --git a/docs/pages/plugins/docusaurus.mdx b/docs/pages/plugins/docusaurus.mdx index fe9cc8737..9936a66bb 100644 --- a/docs/pages/plugins/docusaurus.mdx +++ b/docs/pages/plugins/docusaurus.mdx @@ -1,5 +1,5 @@ import { Cards } from 'nextra/components'; -import pjson from '../../../packages/typedoc-plugin-frontmatter/package.json'; +import pjson from '../../../packages/docusaurus-plugin-typedoc/package.json'; import { FontAwesomeIcon } from '@fortawesome/react-fontawesome'; import { faGithub } from '@fortawesome/free-brands-svg-icons'; import { faBolt } from '@fortawesome/free-solid-svg-icons'; diff --git a/docs/theme.config.jsx b/docs/theme.config.jsx index 3c00e8605..e31352286 100644 --- a/docs/theme.config.jsx +++ b/docs/theme.config.jsx @@ -16,7 +16,7 @@ export default {
diff --git a/packages/typedoc-plugin-markdown/src/options/declarations.ts b/packages/typedoc-plugin-markdown/src/options/declarations.ts index 673d1454b..cc6ac16a7 100644 --- a/packages/typedoc-plugin-markdown/src/options/declarations.ts +++ b/packages/typedoc-plugin-markdown/src/options/declarations.ts @@ -385,6 +385,10 @@ export const indexFormat: Partial = { }; /** + * + * **Please note TypeDoc 0.26 will be introducing a native i18n implementation. This option will likely be deprecated in favour of utilizing the native implementation when 0.26 is released.** + * + * * This option enables changing static text rendered to the documentation. * Useful if an alternative English phrase is preferred or to translate English text to another language. * This option does not attempt to address translating text within code comments.