chore(docs): updated navigation docs

devguide/README.md

@@ -12,10 +12,10 @@ This is a simple monorepo managed by [npm workspaces](https://docs.npmjs.com/cli
 
 Please view individual packages for further insights:
 
-* [ typedoc-plugin-markdown](typedoc-plugin-markdown/README.md) is the core package and is the package that is used to generate the markdown documentation.
-* [ typedoc-plugin-frontmatter](typedoc-plugin-frontmatter/README.md) and [ typedoc-plugin-remark](typedoc-plugin-remark/README.md) provide metadata or adjust the output.
-* [ typedoc-github-wiki-theme](typedoc-github-wiki-theme/README.md), [ typedoc-gitlab-wiki-theme](typedoc-gitlab-wiki-theme/README.md),
-  [ typedoc-vitepress-theme](typedoc-vitepress-theme/README.md) and [ docusaurus-plugin-typedoc](docusaurus-plugin-typedoc/README.md) target specific implementations.
+* [typedoc-plugin-markdown](typedoc-plugin-markdown/README.md) is the core package and is the package that is used to generate the markdown documentation.
+* [typedoc-plugin-frontmatter](typedoc-plugin-frontmatter/README.md) and [typedoc-plugin-remark](typedoc-plugin-remark/README.md) provide metadata or adjust the output.
+* [typedoc-github-wiki-theme](typedoc-github-wiki-theme/README.md), [typedoc-gitlab-wiki-theme](typedoc-gitlab-wiki-theme/README.md),
+  [typedoc-vitepress-theme](typedoc-vitepress-theme/README.md) and [docusaurus-plugin-typedoc](docusaurus-plugin-typedoc/README.md) target specific implementations.
 
 ## Machine Setup
 

devguide/docusaurus-plugin-typedoc/index/interfaces/PluginOptions.md

@@ -10,69 +10,38 @@ Describes the options declared by the plugin.
 * [Properties](#properties)
   * [id](#id)
   * [sidebar](#sidebar)
-    * [Inherited from](#inherited-from)
   * [anchorPrefix](#anchorprefix)
-    * [Inherited from](#inherited-from-1)
   * [blockTagsPreserveOrder](#blocktagspreserveorder)
-    * [Inherited from](#inherited-from-2)
   * [classPropertiesFormat](#classpropertiesformat)
-    * [Inherited from](#inherited-from-3)
   * [entryFileName](#entryfilename)
-    * [Inherited from](#inherited-from-4)
   * [entryModule](#entrymodule)
-    * [Inherited from](#inherited-from-5)
   * [enumMembersFormat](#enummembersformat)
-    * [Inherited from](#inherited-from-6)
   * [~~excludeGroups~~](#excludegroups)
-    * [Deprecated](#deprecated)
-    * [Inherited from](#inherited-from-7)
   * [excludeScopesInPaths](#excludescopesinpaths)
-    * [Inherited from](#inherited-from-8)
   * [expandObjects](#expandobjects)
-    * [Inherited from](#inherited-from-9)
   * [expandParameters](#expandparameters)
-    * [Inherited from](#inherited-from-10)
   * [fileExtension](#fileextension)
-    * [Inherited from](#inherited-from-11)
   * [flattenOutputFiles](#flattenoutputfiles)
-    * [Inherited from](#inherited-from-12)
   * [hideBreadcrumbs](#hidebreadcrumbs)
-    * [Inherited from](#inherited-from-13)
   * [hideGroupHeadings](#hidegroupheadings)
-    * [Inherited from](#inherited-from-14)
   * [hidePageHeader](#hidepageheader)
-    * [Inherited from](#inherited-from-15)
   * [hidePageTitle](#hidepagetitle)
-    * [Inherited from](#inherited-from-16)
   * [indexFormat](#indexformat)
-    * [Inherited from](#inherited-from-17)
   * [interfacePropertiesFormat](#interfacepropertiesformat)
-    * [Inherited from](#inherited-from-18)
   * [membersWithOwnFile](#memberswithownfile)
-    * [Inherited from](#inherited-from-19)
   * [mergeReadme](#mergereadme)
-    * [Inherited from](#inherited-from-20)
   * [modulesFileName](#modulesfilename)
-    * [Inherited from](#inherited-from-21)
-  * [navigationModel](#navigationmodel)
-    * [excludeGroups](#excludegroups-1)
-    * [excludeCategories](#excludecategories)
-    * [excludeFolders](#excludefolders)
-    * [Inherited from](#inherited-from-22)
+  * [~~navigationModel~~](#navigationmodel)
+    * [~~excludeGroups~~](#excludegroups-1)
+    * [~~excludeCategories~~](#excludecategories)
+    * [~~excludeFolders~~](#excludefolders)
   * [outputFileStrategy](#outputfilestrategy)
-    * [Inherited from](#inherited-from-23)
   * [parametersFormat](#parametersformat)
-    * [Inherited from](#inherited-from-24)
   * [preserveAnchorCasing](#preserveanchorcasing)
-    * [Inherited from](#inherited-from-25)
   * [propertiesFormat](#propertiesformat)
-    * [Inherited from](#inherited-from-26)
   * [propertyMembersFormat](#propertymembersformat)
-    * [Inherited from](#inherited-from-27)
   * [publicPath](#publicpath)
-    * [Inherited from](#inherited-from-28)
   * [sanitizeComments](#sanitizecomments)
-    * [Inherited from](#inherited-from-29)
   * [tableColumnSettings](#tablecolumnsettings)
     * [hideDefaults](#hidedefaults)
     * [hideInherited](#hideinherited)
@@ -81,23 +50,17 @@ Describes the options declared by the plugin.
     * [hideSources](#hidesources)
     * [hideValues](#hidevalues)
     * [leftAlignHeaders](#leftalignheaders)
-    * [Inherited from](#inherited-from-30)
   * [textContentMappings](#textcontentmappings)
     * [header.title](#headertitle)
     * [header.docs](#headerdocs)
     * [breadcrumbs.home](#breadcrumbshome)
     * [title.indexPage](#titleindexpage)
     * [title.memberPage](#titlememberpage)
     * [footer.text](#footertext)
-    * [Inherited from](#inherited-from-31)
   * [typeDeclarationFormat](#typedeclarationformat)
-    * [Inherited from](#inherited-from-32)
   * [useCodeBlocks](#usecodeblocks)
-    * [Inherited from](#inherited-from-33)
   * [useHTMLAnchors](#usehtmlanchors)
-    * [Inherited from](#inherited-from-34)
   * [useHTMLEncodedBrackets](#usehtmlencodedbrackets)
-    * [Inherited from](#inherited-from-35)
 
 ## Extends
 
@@ -469,24 +432,26 @@ typedoc-plugin-markdown/dist/types/options.d.ts:88
 
 ***
 
-### navigationModel
+### ~~navigationModel~~
 
 > **navigationModel**: `object`
 
-Configures how the navigation model will be generated.
-
-#### excludeGroups
+#### ~~excludeGroups~~
 
 > **excludeGroups**: `boolean`
 
-#### excludeCategories
+#### ~~excludeCategories~~
 
 > **excludeCategories**: `boolean`
 
-#### excludeFolders
+#### ~~excludeFolders~~
 
 > **excludeFolders**: `boolean`
 
+#### Deprecated
+
+This option has been deprecated in favour of TypeDoc `navigation` option.
+
 #### Inherited from
 
 [`PluginOptions`](../../../typedoc-plugin-markdown/types/interfaces/PluginOptions.md).[`navigationModel`](../../../typedoc-plugin-markdown/types/interfaces/PluginOptions.md#navigationmodel)

devguide/typedoc-plugin-markdown/options/namespaces/declarations/README.md

@@ -45,7 +45,6 @@ The JSDoc comments will also be used in the public facing documentation.
   * [useHTMLEncodedBrackets](#usehtmlencodedbrackets)
   * [useHTMLAnchors](#usehtmlanchors)
   * [preserveAnchorCasing](#preserveanchorcasing)
-  * [navigationModel](#navigationmodel)
 
 ## File
 
@@ -1025,42 +1024,3 @@ This option can be used for engines that require the preservation of anchor link
 #### Defined in
 
 [packages/typedoc-plugin-markdown/src/options/declarations.ts:646](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/options/declarations.ts#L646)
-
-***
-
-### navigationModel
-
-> `const` **navigationModel**: `Partial`\<[`DeclarationOption`](https://typedoc.org/api/types/Configuration.DeclarationOption.html)>
-
-By default navigation is not written to file but can be consumed programmatically.
-This is useful if you want to provide a custom sidebar/navigation implementation (if relevant to your environment).
-
-The navigation model can be accessed by utilizing the `postRenderAsyncJobs` on the renderer.
-
-The navigation is returned as `JSON` and can be mapped to a custom structure and written to a file.
-
-The available properties are:
-
-* `navigationModel.excludeGroups`: do not organise navigation by groups.
-* `navigationModel.excludeCategories`: do not organise navigation by categories.
-* `navigationModel.excludeFolders`: excludes unnecessary nesting with complex hierarchies.
-
-See [Utilizing Navigation](https://typedoc-plugin-markdown.org/api-docs/Document.Utilizing-Navigation) API docs.
-
-#### Default Value
-
-```ts
-{
-    help: 'Configures how the navigation model will be generated.',
-    type: ParameterType.Flags,
-    defaults: {
-        excludeGroups: false,
-        excludeCategories: false,
-        excludeFolders: false,
-    },
-}
-```
-
-#### Defined in
-
-[packages/typedoc-plugin-markdown/src/options/declarations.ts:671](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/options/declarations.ts#L671)

devguide/typedoc-plugin-markdown/types/interfaces/PluginOptions.md

@@ -15,7 +15,6 @@ Describes the options declared by the plugin.
   * [entryModule](#entrymodule)
   * [enumMembersFormat](#enummembersformat)
   * [~~excludeGroups~~](#excludegroups)
-    * [Deprecated](#deprecated)
   * [excludeScopesInPaths](#excludescopesinpaths)
   * [expandObjects](#expandobjects)
   * [expandParameters](#expandparameters)
@@ -30,10 +29,10 @@ Describes the options declared by the plugin.
   * [membersWithOwnFile](#memberswithownfile)
   * [mergeReadme](#mergereadme)
   * [modulesFileName](#modulesfilename)
-  * [navigationModel](#navigationmodel)
-    * [excludeGroups](#excludegroups-1)
-    * [excludeCategories](#excludecategories)
-    * [excludeFolders](#excludefolders)
+  * [~~navigationModel~~](#navigationmodel)
+    * [~~excludeGroups~~](#excludegroups-1)
+    * [~~excludeCategories~~](#excludecategories)
+    * [~~excludeFolders~~](#excludefolders)
   * [outputFileStrategy](#outputfilestrategy)
   * [parametersFormat](#parametersformat)
   * [preserveAnchorCasing](#preserveanchorcasing)
@@ -319,24 +318,26 @@ The file name of the separate modules / index page.
 
 ***
 
-### navigationModel
+### ~~navigationModel~~
 
 > **navigationModel**: `object`
 
-Configures how the navigation model will be generated.
-
-#### excludeGroups
+#### ~~excludeGroups~~
 
 > **excludeGroups**: `boolean`
 
-#### excludeCategories
+#### ~~excludeCategories~~
 
 > **excludeCategories**: `boolean`
 
-#### excludeFolders
+#### ~~excludeFolders~~
 
 > **excludeFolders**: `boolean`
 
+#### Deprecated
+
+This option has been deprecated in favour of TypeDoc `navigation` option.
+
 #### Defined in
 
 [packages/typedoc-plugin-markdown/src/types/options.ts:123](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/options.ts#L123)

docs/next-env.d.ts

@@ -2,4 +2,4 @@
 /// <reference types="next/image-types/global" />
 
 // NOTE: This file should not be edited
-// see https://nextjs.org/docs/basic-features/typescript for more information.
+// see https://nextjs.org/docs/pages/building-your-application/configuring/typescript for more information.