chore(all): updated docs

typedoc2md · May 7, 2024 · 8758ef7 · 8758ef7
1 parent 1e5b897
commit 8758ef7
Show file tree

Hide file tree

Showing 5 changed files with 13 additions and 3 deletions.
diff --git 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.
 
+<Callout type="warning">
+  **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.**
+</Callout>
+
 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
@@ -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
@@ -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
@@ -16,7 +16,7 @@ export default {
       <div
         style={{
           marginLeft: '6px',
-          fontSize: '13px',
+          fontSize: '14px',
           fontWeight: 'bold',
         }}
       >

diff --git 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<DeclarationOption> = {
 };
 
 /**
+ * <Callout type="warning">
+ * **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.**
+ * </Callout>
+ *
  * 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.