chore: Updated docs

typedoc2md · Apr 13, 2024 · 2bc4136 · 2bc4136
1 parent 5da059b
commit 2bc4136
Show file tree

Hide file tree

Showing 12 changed files with 36 additions and 68 deletions.
diff --git a/devtools/packages/helpers/constants.ts b/devtools/packages/helpers/constants.ts
@@ -29,14 +29,14 @@ export const DOCS_CONFIG: Record<string, DocsConfig> = {
     optionsPath: 'plugins/github-wiki',
     docsPath: '/plugins/github-wiki',
     declarations: true,
-    presets: true,
+    presets: false,
   },
   ['typedoc-gitlab-wiki-theme']: {
     declarationsPath: `${process.cwd()}/src/options/declarations.ts`,
     optionsPath: 'plugins/gitlab-wiki',
     docsPath: '/plugins/gitlab-wiki',
     declarations: true,
-    presets: true,
+    presets: false,
   },
   ['typedoc-vitepress-theme']: {
     declarationsPath: `${process.cwd()}/src/options/declarations.ts`,

diff --git a/devtools/packages/prebuild-options/tasks/generate-docs.ts b/devtools/packages/prebuild-options/tasks/generate-docs.ts
@@ -163,7 +163,7 @@ function getEmoji(categoryName: string) {
   if (categoryName === 'Output') {
     return '📁';
   }
-  if (categoryName === 'Utils') {
+  if (categoryName === 'Utilities') {
     return '⚙️';
   }
   return '💡';

diff --git a/docs/pages/docs/changelog.mdx b/docs/pages/docs/changelog.mdx
@@ -4,11 +4,7 @@ import { Callout } from 'nextra/components';
 
 ## 4.0.0-next.xx
 
-<Callout>
-  {' '}
-  v4 is a major release that includes a number of bug fixes, new features and UI
-  improvements.
-</Callout>
+<Callout> v4 is a major release that includes a number of bug fixes, new features and UI improvements.</Callout>
 
 ### 🏗 Architectural Changes
 
@@ -56,13 +52,4 @@ Migrating from v3 to v4 should be fairly straightforward. These pointers will he
 - The option `hideInPageTOC` has been removed. In-page TOC are no longer included by default. You can include in-page TOCs by using [typedoc-plugin-remark](/plugins/remark) and the [remark-toc](plugins/remark/suggested-plugins#remark-toc) plugin.
 - The option `objectLiteralTypeDeclarationStyle` has been removed. Please use [`typeDeclarationFormat`](/docs/options#typedeclarationformat).
 
-### 🙏 Thanks
 
-A special thanks to several members of the commununity who provided essential feeback, suggested improvements or direct contributions, including (in no particular order):
-
-- [@axel7083](https://github.com/axel7083)
-- @balazsorban44
-- @CoderIllusionist
-- @KillyMXI
-- @lorenzolewis
-- @Zamiell
diff --git a/docs/pages/docs/options.mdx b/docs/pages/docs/options.mdx
@@ -674,7 +674,7 @@ ___
 
 ### publicPath
 
-<Callout emoji="⚙️">Specify the base path for all urls.</Callout>
+<Callout emoji="💡">Specify the base path for all urls.</Callout>
 
 > Accepts a string value. Defaults to `"undefined"`.
 
@@ -692,7 +692,7 @@ ___
 
 ### anchorPrefix
 
-<Callout emoji="⚙️">Custom anchor prefix</Callout>
+<Callout emoji="💡">Custom anchor prefix</Callout>
 
 > Accepts a string value. Defaults to `"undefined"`.
 
@@ -710,7 +710,7 @@ ___
 
 ### useHTMLAnchors
 
-<Callout emoji="⚙️">Add HTML named anchors to headings and table rows.</Callout>
+<Callout emoji="💡">Add HTML named anchors to headings and table rows.</Callout>
 
 > Accepts a boolean value. Defaults to `false`.
 
@@ -731,7 +731,7 @@ ___
 
 ### preserveAnchorCasing
 
-<Callout emoji="⚙️">Preserve anchor casing when generating link to symbols.</Callout>
+<Callout emoji="💡">Preserve anchor casing when generating link to symbols.</Callout>
 
 > Accepts a boolean value. Defaults to `false`.
 

diff --git a/docs/pages/plugins/frontmatter/options.mdx b/docs/pages/plugins/frontmatter/options.mdx
@@ -2,11 +2,11 @@ import { Callout, FileTree } from 'nextra/components';
 
 # Options
 
-These are the additional options that can be added to the TypeDoc configuration.
+Listed on this page are the additional options that can be added to the TypeDoc configuration.
 
 ## frontmatterGlobals
 
-<Callout>Specify static variables to be added to all frontmatter blocks.</Callout>
+<Callout emoji="💡">Specify static variables to be added to all frontmatter blocks.</Callout>
 
 > Accepts a key/value object.
 
@@ -33,7 +33,7 @@ ___
 
 ## readmeFrontmatter
 
-<Callout>Specify static variables to be added to the readme page only.</Callout>
+<Callout emoji="💡">Specify static variables to be added to the readme page only.</Callout>
 
 > Accepts a key/value object.
 
@@ -51,7 +51,7 @@ ___
 
 ## indexFrontmatter
 
-<Callout>Specify static variables to be added to the index page only.</Callout>
+<Callout emoji="💡">Specify static variables to be added to the index page only.</Callout>
 
 > Accepts a key/value object.
 
@@ -69,7 +69,7 @@ ___
 
 ## frontmatterCommentTags
 
-<Callout>Specify which comment block tags should be added to frontmatter.</Callout>
+<Callout emoji="💡">Specify which comment block tags should be added to frontmatter.</Callout>
 
 > Accepts an Array.
 
@@ -107,7 +107,7 @@ ___
 
 ## preserveFrontmatterCommentTags
 
-<Callout>Preserve tags defined in frontmatter block tags in output.</Callout>
+<Callout emoji="💡">Preserve tags defined in frontmatter block tags in output.</Callout>
 
 > Accepts a boolean value. Defaults to `false`.
 
@@ -123,7 +123,7 @@ ___
 
 ## frontmatterNamingConvention
 
-<Callout>The naming convention that variables should be output as. </Callout>
+<Callout emoji="💡">The naming convention that variables should be output as. </Callout>
 
 > Accepts either `"camelCase"` or `"snakeCase"`. Defaults to `"camelCase"`.
 

diff --git a/docs/pages/plugins/github-wiki/options.mdx b/docs/pages/plugins/github-wiki/options.mdx
@@ -2,11 +2,11 @@ import { Callout, FileTree } from 'nextra/components';
 
 # Options
 
-These are the additional options that can be added to the TypeDoc configuration.
+Listed on this page are the additional options that can be added to the TypeDoc configuration.
 
 ## sidebar
 
-<Callout>Configures the autogenerated `_sidebar.md file`.</Callout>
+<Callout emoji="💡">Configures the autogenerated `_sidebar.md file`.</Callout>
 
 > Accepts a key/value object.
 

diff --git a/docs/pages/plugins/gitlab-wiki/options.mdx b/docs/pages/plugins/gitlab-wiki/options.mdx
@@ -2,11 +2,11 @@ import { Callout, FileTree } from 'nextra/components';
 
 # Options
 
-These are the additional options that can be added to the TypeDoc configuration.
+Listed on this page are the additional options that can be added to the TypeDoc configuration.
 
 ## sidebar
 
-<Callout>Configures the autogenerated `_Sidebar.md file`.</Callout>
+<Callout emoji="💡">Configures the autogenerated `_Sidebar.md file`.</Callout>
 
 > Accepts a key/value object.
 

diff --git a/docs/pages/plugins/remark/options.mdx b/docs/pages/plugins/remark/options.mdx
@@ -6,7 +6,7 @@ Listed on this page are the additional options that can be added to the TypeDoc
 
 ## remarkPlugins
 
-<Callout>An array of remark plugin names.</Callout>
+<Callout emoji="💡">An array of remark plugin names.</Callout>
 
 > Accepts an Array.
 

diff --git a/docs/pages/plugins/vitepress/options.mdx b/docs/pages/plugins/vitepress/options.mdx
@@ -2,11 +2,11 @@ import { Callout, FileTree } from 'nextra/components';
 
 # Options
 
-These are the additional options that can be added to the TypeDoc configuration.
+Listed on this page are the additional options that can be added to the TypeDoc configuration.
 
 ## docsRoot
 
-<Callout>The path to the VitePress project root.</Callout>
+<Callout emoji="💡">The path to the VitePress project root.</Callout>
 
 > Defaults to `"./"`.
 
@@ -39,7 +39,7 @@ ___
 
 ## sidebar
 
-<Callout>Configures the autogenerated VitePress sidebar.</Callout>
+<Callout emoji="💡">Configures the autogenerated VitePress sidebar.</Callout>
 
 > Accepts a key/value object.
 

diff --git a/package-lock.json b/package-lock.json
diff --git a/packages/typedoc-plugin-frontmatter/src/options/option-types.ts b/packages/typedoc-plugin-frontmatter/src/options/option-types.ts
@@ -4,12 +4,12 @@ import { ManuallyValidatedOption } from 'typedoc';
 
 declare module 'typedoc' {
   export interface TypeDocOptionMap {
+    frontmatterCommentTags: any[];
     frontmatterGlobals: ManuallyValidatedOption<FrontmatterGlobals>;
-    readmeFrontmatter: ManuallyValidatedOption<ReadmeFrontmatter>;
+    frontmatterNamingConvention: 'camelCase' | 'snakeCase';
     indexFrontmatter: ManuallyValidatedOption<IndexFrontmatter>;
-    frontmatterCommentTags: any[];
     preserveFrontmatterCommentTags: boolean;
-    frontmatterNamingConvention: 'camelCase' | 'snakeCase';
+    readmeFrontmatter: ManuallyValidatedOption<ReadmeFrontmatter>;
   }
 }
 
@@ -19,35 +19,35 @@ declare module 'typedoc' {
  * @category Options
  */
 export interface PluginOptions {
+  /**
+   * Specify which comment block tags should be added to frontmatter.
+   */
+  frontmatterCommentTags: any[];
+
   /**
    * Specify static variables to be added to all frontmatter blocks.
    */
   frontmatterGlobals: FrontmatterGlobals;
 
   /**
-   * Specify static variables to be added to the readme page only.
+   * The naming convention that variables should be output as.
    */
-  readmeFrontmatter: ReadmeFrontmatter;
+  frontmatterNamingConvention: 'camelCase' | 'snakeCase';
 
   /**
    * Specify static variables to be added to the index page only.
    */
   indexFrontmatter: IndexFrontmatter;
 
-  /**
-   * Specify which comment block tags should be added to frontmatter.
-   */
-  frontmatterCommentTags: any[];
-
   /**
    * Preserve tags defined in frontmatter block tags in output.
    */
   preserveFrontmatterCommentTags: boolean;
 
   /**
-   * The naming convention that variables should be output as.
+   * Specify static variables to be added to the readme page only.
    */
-  frontmatterNamingConvention: 'camelCase' | 'snakeCase';
+  readmeFrontmatter: ReadmeFrontmatter;
 }
 
 /**

diff --git a/packages/typedoc-plugin-markdown/CHANGELOG_V4.md b/packages/typedoc-plugin-markdown/CHANGELOG_V4.md
@@ -23,6 +23,7 @@ The release features numerous bug fixes including:
 - Duplication in callback/callable/function properties. ([#581](https://github.com/tgreyuk/typedoc-plugin-markdown/issues/581)).
 - @experimental / @internal annotations ([#556](https://github.com/tgreyuk/typedoc-plugin-markdown/issues/556))
 - Fix events output and strikethough deprecqted items ([#534](https://github.com/tgreyuk/typedoc-plugin-markdown/issues/534))
+- Class static functions are no longer marked ([#533](https://github.com/tgreyuk/typedoc-plugin-markdown/issues/533))
 - @example block not rendered with Headline ([#501](https://github.com/tgreyuk/typedoc-plugin-markdown/issues/501))
 - Correctly resolve packge readme urls from member pages ([#483](https://github.com/tgreyuk/typedoc-plugin-markdown/issues/483))
 - Mark final default parameters as optional ([#396](https://github.com/tgreyuk/typedoc-plugin-markdown/issues/396))