chore(global): update docs

typedoc2md · May 3, 2024 · 8a3faab · 8a3faab
1 parent a1250dc
commit 8a3faab
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 7 deletions.
diff --git a/docs/pages/docs/migration-guide.mdx b/docs/pages/docs/migration-guide.mdx
@@ -19,7 +19,6 @@ import { Callout } from 'nextra/components';
 - Improved and cleaner UX configurable with options.
 - Exported option types and JSON schema.
 - Exposed navigation structure.
-- Handle events output.
 - Ability to customize static text.
 - Comprehensive documentation and examples repository.
 
@@ -31,6 +30,7 @@ import { Callout } from 'nextra/components';
 
 ## 💥 Breaking Changes
 
+- The output file structure has changed so you may need to update any cross references into your docs from external sources.
 - Setting `theme` to `"markdown"` is not required and should be removed.
 - The option `indexTitle` has been removed. Please use the `"title.indexPage"` key with [`textContentMappings`](/docs/options#textcontentmappings).
 - The option `allReflectionsHaveOwnDocument` has been removed (this behaviour is now the default). Please see See [`outputFileStrategy`](/docs/options#outputfilestrategy).

diff --git a/docs/pages/docs/typedoc-usage.mdx b/docs/pages/docs/typedoc-usage.mdx
@@ -4,8 +4,6 @@ import { Callout, FileTree } from 'nextra/components';
 
 This plugin is like any other TypeDoc plugin and is fully compatible with the TypeDoc ecosystem, supporting other plugins (not specifically targetting HTML output) and the majority of TypeDoc's options.
 
-Please refer to TypeDoc's [Configuration Options](https://typedoc.org/options/configuration/) for detailed information on how to configure options.
-
 ## Supported TypeDoc Options
 
 ### Pre-Render Options

diff --git a/docs/theme.config.jsx b/docs/theme.config.jsx
@@ -10,17 +10,17 @@ import { PackageVersion } from './components/package-version';
 export default {
   logo: (
     <div style={{ display: 'flex', alignItems: 'center' }}>
-      <div style={{ width: '36px' }}>
+      <div style={{ width: '26px' }}>
         <FontAwesomeIcon icon={faMarkdown} size="sm" />
       </div>
       <div
         style={{
-          marginLeft: '8px',
-          fontSize: '12px',
+          marginLeft: '6px',
+          fontSize: '13px',
           fontWeight: 'bold',
         }}
       >
-        TYPEDOC-PLUGIN-MARKDOWN
+        typedoc-plugin-markdown
       </div>
     </div>
   ),