chore(docs): updated docs

Author: tgreyuk

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

@@ -92,6 +92,8 @@ Describes the options declared by the plugin.
     * [Inherited from](#inherited-from-31)
   * [useHTMLAnchors](#usehtmlanchors)
     * [Inherited from](#inherited-from-32)
+  * [useHTMLEncodedBrackets](#usehtmlencodedbrackets)
+    * [Inherited from](#inherited-from-33)
 
 ## Extends
 
@@ -700,3 +702,19 @@ Add HTML named anchors to headings and table rows.
 #### Defined in
 
 typedoc-plugin-markdown/dist/types/options.d.ts:151
+
+***
+
+### useHTMLEncodedBrackets
+
+> **useHTMLEncodedBrackets**: `boolean`
+
+Use HTML encoded entities for angle brackets.
+
+#### Inherited from
+
+[`PluginOptions`](../../../typedoc-plugin-markdown/types/interfaces/PluginOptions.md).[`useHTMLEncodedBrackets`](../../../typedoc-plugin-markdown/types/interfaces/PluginOptions.md#usehtmlencodedbrackets)
+
+#### Defined in
+
+typedoc-plugin-markdown/dist/types/options.d.ts:155

devguide/typedoc-plugin-markdown/libs/namespaces/utils/README.md

@@ -7,6 +7,7 @@ General utility pure functions.
 ## Contents
 
 * [camelToTitleCase()](#cameltotitlecase)
+* [encodeAngleBrackets()](#encodeanglebrackets)
 * [escapeChars()](#escapechars)
 * [formatMarkdown()](#formatmarkdown)
 * [formatTableCell()](#formattablecell)
@@ -40,6 +41,26 @@ General utility pure functions.
 
 ***
 
+## encodeAngleBrackets()
+
+> **encodeAngleBrackets**(`str`): `string`
+
+### Parameters
+
+| Parameter | Type     |
+| --------- | -------- |
+| `str`     | `string` |
+
+### Returns
+
+`string`
+
+### Defined in
+
+[packages/typedoc-plugin-markdown/src/libs/utils/encode-angle-brackets.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/libs/utils/encode-angle-brackets.ts#L1)
+
+***
+
 ## escapeChars()
 
 > **escapeChars**(`str`): `string`

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

@@ -40,6 +40,7 @@ The JSDoc comments will also be used in the public facing documentation.
   * [sanitizeComments](#sanitizecomments)
   * [anchorPrefix](#anchorprefix)
   * [useHTMLAnchors](#usehtmlanchors)
+  * [useHTMLEncodedBrackets](#usehtmlencodedbrackets)
   * [preserveAnchorCasing](#preserveanchorcasing)
   * [textContentMappings](#textcontentmappings)
   * [navigationModel](#navigationmodel)
@@ -201,7 +202,7 @@ Flattened output:
 
 > `const` **fileExtension**: `Partial`\<[`DeclarationOption`](https://typedoc.org/api/types/Configuration.DeclarationOption.html)>
 
-Typically markdown files are recognised by the `.md` or `.markdown` file extensions.`.mdx` maybe required for compatibility with certain markdown parsers.
+Typically Markdown files are recognised by the `.md` or `.markdown` file extensions.`.mdx` maybe required for compatibility with certain Markdown parsers.
 
 #### Example
 
@@ -562,7 +563,7 @@ When table style is selected the following will be the behaviour:
 This option specifies the output format for parameters and type parameters of functions and class methods:
 
 * **"list"**: parameters are output as bullet points in a linear list, suitable for more detailed comments.
-* **"table"**: parameters are output within a markdown table, condensed into a single paragraph.
+* **"table"**: parameters are output within a Markdown table, condensed into a single paragraph.
 * **"htmlTable"**: parameters are output in an HTML table, enabling block elements to render in table cells.
 
 #### Default Value
@@ -589,7 +590,7 @@ This option specifies the output format for parameters and type parameters of fu
 This option specifies the output format for interface properties:
 
 * **"list"**: properties are output in linear blocks with headings, suitable for more detailed comments.
-* **"table"**: properties are output within a markdown table, condensed into a single paragraph.
+* **"table"**: properties are output within a Markdown table, condensed into a single paragraph.
 * **"htmlTable"**: properties are output in an HTML table, enabling block elements to render in tabular format.
 
 #### Default Value
@@ -616,7 +617,7 @@ This option specifies the output format for interface properties:
 This option specifies the output format for class properties:
 
 * **"list"**: properties are output in linear blocks with headings, suitable for more detailed comments.
-* **"table"**: properties are output within a markdown table, condensed into a single paragraph.
+* **"table"**: properties are output within a Markdown table, condensed into a single paragraph.
 * **"htmlTable"**: properties are output in an HTML table, enabling block elements to render in tabular format.
 
 #### Default Value
@@ -643,7 +644,7 @@ This option specifies the output format for class properties:
 This option specifies the output format for enumeration members:
 
 * **"list"**: members are output in linear blocks with headings, suitable for more detailed comments.
-* **"table"**: members are output within a markdown table, condensed into a single paragraph.
+* **"table"**: members are output within a Markdown table, condensed into a single paragraph.
 * **"htmlTable"**: members are output in an HTML table, enabling block elements to render in tabular format.
 
 #### Default Value
@@ -670,7 +671,7 @@ This option specifies the output format for enumeration members:
 This option specifies the output format for type declaration of variables and type aliases.
 
 * **"list"**: declarations are output in linear blocks with headings, suitable for more detailed comments.
-* **"table"**: declarations are output within a markdown table, condensed into a single paragraph.
+* **"table"**: declarations are output within a Markdown table, condensed into a single paragraph.
 * **"htmlTable"**: declarations are output in an HTML table, enabling block elements to render in tabular format.
 
 #### Default Value
@@ -699,7 +700,7 @@ This option will handle the formatting of object literals assigned as properties
 Note this options will only take effect when `propertiesFormat` is set to `list`.
 
 * **"list"**: members are output in linear blocks with headings, suitable for more detailed comments.
-* **"table"**: members are output within a markdown table, condensed into a single paragraph.
+* **"table"**: members are output within a Markdown table, condensed into a single paragraph.
 * **"htmlTable"**: members are output in an HTML table, enabling block elements to render in tabular format.
 
 #### Default Value
@@ -849,7 +850,7 @@ This option should be used when parsers require a custom anchor prefix.
 
 This option should be used if there are issues with anchoring to symbols within a page.
 
-* For markdown parsers that do not automatically assign header ids.
+* For Markdown parsers that do not automatically assign header ids.
 * When cross referencing symbols that are referenced in a table row.
 
 #### Default Value
@@ -868,6 +869,29 @@ This option should be used if there are issues with anchoring to symbols within
 
 ***
 
+### useHTMLEncodedBrackets
+
+> `const` **useHTMLEncodedBrackets**: `Partial`\<[`DeclarationOption`](https://typedoc.org/api/types/Configuration.DeclarationOption.html)>
+
+By default, opening and closing angle brackets (`<` and `>`) are escaped using backslashes, and most modern Markdown processors handle them consistently.
+However, using HTML entities (`&lt;` and `&gt;`) might be preferable to avoid any inconsistencies across different Markdown processors.
+
+#### Default Value
+
+```ts
+{
+    help: 'Use HTML encoded entities for angle brackets.',
+    type: ParameterType.Boolean,
+    defaultValue: false,
+}
+```
+
+#### Defined in
+
+[packages/typedoc-plugin-markdown/src/options/declarations.ts:559](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/options/declarations.ts#L559)
+
+***
+
 ### preserveAnchorCasing
 
 > `const` **preserveAnchorCasing**: `Partial`\<[`DeclarationOption`](https://typedoc.org/api/types/Configuration.DeclarationOption.html)>
@@ -888,7 +912,7 @@ This option can be used for engines that require the preservation of anchor link
 
 #### Defined in
 
-[packages/typedoc-plugin-markdown/src/options/declarations.ts:560](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/options/declarations.ts#L560)
+[packages/typedoc-plugin-markdown/src/options/declarations.ts:572](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/options/declarations.ts#L572)
 
 ***
 
@@ -929,7 +953,7 @@ If you are looking for general localization support please see [localization]().
 
 #### Defined in
 
-[packages/typedoc-plugin-markdown/src/options/declarations.ts:580](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/options/declarations.ts#L580)
+[packages/typedoc-plugin-markdown/src/options/declarations.ts:592](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/options/declarations.ts#L592)
 
 ***
 
@@ -979,4 +1003,4 @@ export function load(app: MarkdownApplication) {
 
 #### Defined in
 
-[packages/typedoc-plugin-markdown/src/options/declarations.ts:630](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/options/declarations.ts#L630)
+[packages/typedoc-plugin-markdown/src/options/declarations.ts:642](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/options/declarations.ts#L642)

devguide/typedoc-plugin-markdown/theme/classes/MarkdownThemeContext.md

@@ -91,6 +91,7 @@ This class can be used to customize the theme output by extending the class and
     * [unionType()](#uniontype)
     * [unknownType()](#unknowntype)
   * [helpers](#helpers)
+    * [getAngleBracket()](#getanglebracket)
     * [getCommentParts()](#getcommentparts)
     * [getDeclarationType()](#getdeclarationtype)
     * [getDescriptionForReflection()](#getdescriptionforreflection)
@@ -1277,6 +1278,20 @@ Please note that partials:
 * Can reference other helpers but should not reference partials.
 * Can return strings or other models.
 
+#### getAngleBracket()
+
+> **getAngleBracket**: (`bracket`) => `string`
+
+##### Parameters
+
+| Parameter | Type           |
+| --------- | -------------- |
+| `bracket` | `"<"` \| `">"` |
+
+##### Returns
+
+`string`
+
 #### getCommentParts()
 
 > **getCommentParts**: (`model`) => `string`
@@ -1351,14 +1366,13 @@ Please note that partials:
 
 #### getGroupIndexTable()
 
-> **getGroupIndexTable**: (`children`, `kind`?) => `string`
+> **getGroupIndexTable**: (`children`) => `string`
 
 ##### Parameters
 
 | Parameter  | Type                                                                                                                       |
 | ---------- | -------------------------------------------------------------------------------------------------------------------------- |
 | `children` | `DocumentReflection`\[] \| [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html)\[] |
-| `kind`?    | [`ReflectionKind`](https://typedoc.org/api/enums/Models.ReflectionKind-1.html)                                             |
 
 ##### Returns
 

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

@@ -57,6 +57,7 @@ Describes the options declared by the plugin.
   * [typeDeclarationFormat](#typedeclarationformat)
   * [useCodeBlocks](#usecodeblocks)
   * [useHTMLAnchors](#usehtmlanchors)
+  * [useHTMLEncodedBrackets](#usehtmlencodedbrackets)
 
 ## Extended by
 
@@ -509,3 +510,15 @@ Add HTML named anchors to headings and table rows.
 #### Defined in
 
 [packages/typedoc-plugin-markdown/src/types/options.ts:192](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/options.ts#L192)
+
+***
+
+### useHTMLEncodedBrackets
+
+> **useHTMLEncodedBrackets**: `boolean`
+
+Use HTML encoded entities for angle brackets.
+
+#### Defined in
+
+[packages/typedoc-plugin-markdown/src/types/options.ts:197](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/types/options.ts#L197)

docs/global.css

@@ -9,6 +9,13 @@
 .nextra-toc a[href^='#overrides'],
 .nextra-toc a[href^='#see'],
 .nextra-toc a[href^='#example'],
+.nextra-toc a[href^='#new-features'],
+.nextra-toc a[href^='#bug-fixes'],
+.nextra-toc a[href^='#patch-changes'],
+.nextra-toc a[href^='#non-breaking-changes'],
+.nextra-toc a[href^='#architectural-changes'],
+.nextra-toc a[href^='#structural-changes'],
+.nextra-toc a[href^='#breaking-changes'],
 .nextra-toc a[href^='#deprecated'] {
   display: none;
 }