Skip to content

Commit 959993f

Browse files
deps: bump typedoc-plugin-markdown from 3.17.1 to 4.0.2 (#80)
Bumps [typedoc-plugin-markdown](https://github.com/typedoc2md/typedoc-plugin-markdown/tree/HEAD/packages/typedoc-plugin-markdown) from 3.17.1 to 4.0.2. <details> <summary>Release notes</summary> <p><em>Sourced from <a href="https://github.com/typedoc2md/typedoc-plugin-markdown/releases">typedoc-plugin-markdown's releases</a>.</em></p> <blockquote> <h2>typedoc-plugin-markdown@4.0.2</h2> <h3>Patch Changes</h3> <ul> <li>Fix symbol url anchors when &quot;flattenOutputFiles&quot; is &quot;true&quot; (<a href="https://redirect.github.com/typedoc2md/typedoc-plugin-markdown/issues/616">#616</a>)</li> <li>Normalize line breaks and tags within table columns (<a href="https://redirect.github.com/typedoc2md/typedoc-plugin-markdown/issues/615">#615</a>)</li> <li>Remove superfluous spaces and symbol on external links (<a href="https://redirect.github.com/typedoc2md/typedoc-plugin-markdown/issues/614">#614</a>)</li> <li>Escape all angle brackets with &quot;santizeComments&quot; (<a href="https://redirect.github.com/typedoc2md/typedoc-plugin-markdown/issues/612">#612</a>)</li> <li>Correctly handle quoted symbol names (<a href="https://redirect.github.com/typedoc2md/typedoc-plugin-markdown/issues/611">#611</a>)</li> <li>Correctly handle excludeScopesInPaths in windows (<a href="https://redirect.github.com/typedoc2md/typedoc-plugin-markdown/issues/610">#610</a>)</li> </ul> <h2>typedoc-plugin-markdown@4.0.1</h2> <h3>Patch Changes</h3> <ul> <li>Remove superfluous newlines from table column descriptions (<a href="https://redirect.github.com/typedoc2md/typedoc-plugin-markdown/issues/591">#591</a>).</li> <li>Handle multiple <code>@example</code> tags on same reflection.</li> <li>Fix missing extended by definitions.</li> <li>Escape Symbols with signatures correctly.</li> </ul> <h2>typedoc-plugin-markdown@4.0.0</h2> <h1>Changelog</h1> <h2>4.0.0 (2024-05-03)</h2> <blockquote> <p>v4 is a major release that includes a number of bug fixes, new features and UI improvements.</p> </blockquote> <h3>Architectural Changes</h3> <ul> <li>Handlebars as a dependency has been removed.</li> <li>Updated customization model with the ability to set hooks, events and custom theming.</li> <li>Exposed navigation structure.</li> </ul> <h3>Features</h3> <ul> <li>Updated output file structure.</li> <li>Improved and cleaner UI.</li> <li>A set of updated and additional new options with comprehensive documentation.</li> <li>Exported option types and JSON schema.</li> </ul> <h3>Structural Changes</h3> <ul> <li>Each module member is now output to its own file by default. See option <code>--outputFileStrategy</code>. To achieve the same output as v3 (whereby only Classes, Enums and Interfaces have their own file), set the option <code>membersWithOwnFile</code> option.</li> <li>Parameters are output as a list by default. To achieve the same output as v3 (where parameters are output as a table), use option <code>--parametersFormat=table</code>.</li> </ul> <h3>Breaking Changes</h3> <ul> <li>Because the file structure has changed you may need to update any cross references to files in your documentation.</li> <li>Setting <code>theme</code> to <code>&quot;markdown&quot;</code> is no longer required and should be removed.</li> <li>The option <code>indexTitle</code> has been removed. Please use the <code>&quot;title.indexPage&quot;</code> key with option <code>--textContentMappings</code>.</li> <li>The option <code>allReflectionsHaveOwnDocument</code> has been removed (this behaviour is now the default). Please see option <code>outputFileStrategy</code>.</li> <li>The option <code>entryDocument</code> has been renamed to <code>entryFileName</code> to better reflect its purpose.</li> </ul> <!-- raw HTML omitted --> </blockquote> <p>... (truncated)</p> </details> <details> <summary>Changelog</summary> <p><em>Sourced from <a href="https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/CHANGELOG.md">typedoc-plugin-markdown's changelog</a>.</em></p> <blockquote> <h2>4.0.2</h2> <h3>Patch Changes</h3> <ul> <li>Fix symbol url anchors when &quot;flattenOutputFiles&quot; is &quot;true&quot; (<a href="https://redirect.github.com/typedoc2md/typedoc-plugin-markdown/issues/616">#616</a>)</li> <li>Normalize line breaks and tags within table columns (<a href="https://redirect.github.com/typedoc2md/typedoc-plugin-markdown/issues/615">#615</a>)</li> <li>Remove superfluous spaces and symbol on external links (<a href="https://redirect.github.com/typedoc2md/typedoc-plugin-markdown/issues/614">#614</a>)</li> <li>Escape all angle brackets with &quot;santizeComments&quot; (<a href="https://redirect.github.com/typedoc2md/typedoc-plugin-markdown/issues/612">#612</a>)</li> <li>Correctly handle quoted symbol names (<a href="https://redirect.github.com/typedoc2md/typedoc-plugin-markdown/issues/611">#611</a>)</li> <li>Correctly handle excludeScopesInPaths in windows (<a href="https://redirect.github.com/typedoc2md/typedoc-plugin-markdown/issues/610">#610</a>)</li> </ul> <h2>4.0.1 (2024-05-07)</h2> <h3>Patch Changes</h3> <ul> <li>Remove superfluous newlines from table column descriptions (<a href="https://redirect.github.com/typedoc2md/typedoc-plugin-markdown/issues/591">#591</a>).</li> <li>Handle multiple <code>@example</code> tags on same reflection.</li> <li>Fix missing extended by definitions.</li> <li>Escape Symbols with signatures correctly.</li> </ul> <h2>4.0.0 (2024-05-03)</h2> <blockquote> <p>v4 is a major release that includes a number of bug fixes, new features and UI improvements.</p> </blockquote> <h3>Architectural Changes</h3> <ul> <li>Handlebars as a dependency has been removed.</li> <li>Updated customization model with the ability to set hooks, events and custom theming.</li> <li>Exposed navigation structure.</li> </ul> <h3>Features</h3> <ul> <li>Updated output file structure.</li> <li>Improved and cleaner UI.</li> <li>A set of updated and additional new options with comprehensive documentation.</li> <li>Exported option types and JSON schema.</li> </ul> <h3>Structural Changes</h3> <ul> <li>Each module member is now output to its own file by default. See option <code>--outputFileStrategy</code>. To achieve the same output as v3 (whereby only Classes, Enums and Interfaces have their own file), set the option <code>membersWithOwnFile</code> option.</li> <li>Parameters are output as a list by default. To achieve the same output as v3 (where parameters are output as a table), use option <code>--parametersFormat=table</code>.</li> </ul> <h3>Breaking Changes</h3> <ul> <li>Because the file structure has changed you may need to update any cross references to files in your documentation.</li> <li>Setting <code>theme</code> to <code>&quot;markdown&quot;</code> is no longer required and should be removed.</li> <li>The option <code>indexTitle</code> has been removed. Please use the <code>&quot;title.indexPage&quot;</code> key with option <code>--textContentMappings</code>.</li> <li>The option <code>allReflectionsHaveOwnDocument</code> has been removed (this behaviour is now the default). Please see option <code>outputFileStrategy</code>](/docs/options#outputfilestrategy).</li> <li>The option <code>entryDocument</code> has been renamed to <code>entryFileName</code> to better reflect its purpose.</li> <li>The option <code>namedAnchors</code> has been renamed to <code>useHTMLAnchors</code> to better reflect its purpose.</li> </ul> <!-- raw HTML omitted --> </blockquote> <p>... (truncated)</p> </details> <details> <summary>Commits</summary> <ul> <li><a href="https://github.com/typedoc2md/typedoc-plugin-markdown/commit/35799bf09312c1d60e493ba912f1cdd35985bdb5"><code>35799bf</code></a> Version Packages</li> <li><a href="https://github.com/typedoc2md/typedoc-plugin-markdown/commit/cc967ca37409a66950804d1f1d4c34bfd51c32a4"><code>cc967ca</code></a> fix(core): fix symbol url anchors when &quot;flattenOutputFiles&quot; is &quot;true&quot; (<a href="https://github.com/typedoc2md/typedoc-plugin-markdown/tree/HEAD/packages/typedoc-plugin-markdown/issues/616">#616</a>)</li> <li><a href="https://github.com/typedoc2md/typedoc-plugin-markdown/commit/62062af581269c60aea078ca4cb9b76f1a06195b"><code>62062af</code></a> fix(core): normalize line breaks and tags within table columns (<a href="https://github.com/typedoc2md/typedoc-plugin-markdown/tree/HEAD/packages/typedoc-plugin-markdown/issues/615">#615</a>)</li> <li><a href="https://github.com/typedoc2md/typedoc-plugin-markdown/commit/8962a9f98abc74d512ccc1e1fe8b5c36af95c661"><code>8962a9f</code></a> fix(core): remove superfluous spaces and symbol on external links (<a href="https://github.com/typedoc2md/typedoc-plugin-markdown/tree/HEAD/packages/typedoc-plugin-markdown/issues/614">#614</a>)</li> <li><a href="https://github.com/typedoc2md/typedoc-plugin-markdown/commit/f4f068bc1b134bc575c67be2adeed93449a1aae8"><code>f4f068b</code></a> chore(core): test template literal string default values</li> <li><a href="https://github.com/typedoc2md/typedoc-plugin-markdown/commit/a9f83e447c9781d9dbe1a706935b8661310ed349"><code>a9f83e4</code></a> chore(core): added utils specs</li> <li><a href="https://github.com/typedoc2md/typedoc-plugin-markdown/commit/91978aad90342d2479bfbbfc50f80269edae984d"><code>91978aa</code></a> fix(core): escape all angle brackets with &quot;santizeComments&quot; (<a href="https://github.com/typedoc2md/typedoc-plugin-markdown/tree/HEAD/packages/typedoc-plugin-markdown/issues/612">#612</a>)</li> <li><a href="https://github.com/typedoc2md/typedoc-plugin-markdown/commit/5b412fb46888f2cbbacf561ad98956ad8c44c21b"><code>5b412fb</code></a> fix(core): handle quoted symbol names (<a href="https://github.com/typedoc2md/typedoc-plugin-markdown/tree/HEAD/packages/typedoc-plugin-markdown/issues/611">#611</a>)</li> <li><a href="https://github.com/typedoc2md/typedoc-plugin-markdown/commit/7d8a703fd8ec6b226ddf535d187b214079042e78"><code>7d8a703</code></a> fix(core): correctly handle excludeScopesInPaths in windows (<a href="https://github.com/typedoc2md/typedoc-plugin-markdown/tree/HEAD/packages/typedoc-plugin-markdown/issues/610">#610</a>)</li> <li><a href="https://github.com/typedoc2md/typedoc-plugin-markdown/commit/8758ef74c77a709dc04dc1ffcefb409c3076834d"><code>8758ef7</code></a> chore(all): updated docs</li> <li>Additional commits viewable in <a href="https://github.com/typedoc2md/typedoc-plugin-markdown/commits/typedoc-plugin-markdown@4.0.2/packages/typedoc-plugin-markdown">compare view</a></li> </ul> </details> <br /> [![Dependabot compatibility score](https://dependabot-badges.githubapp.com/badges/compatibility_score?dependency-name=typedoc-plugin-markdown&package-manager=npm_and_yarn&previous-version=3.17.1&new-version=4.0.2)](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores) Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting `@dependabot rebase`. [//]: # (dependabot-automerge-start) [//]: # (dependabot-automerge-end) --- <details> <summary>Dependabot commands and options</summary> <br /> You can trigger Dependabot actions by commenting on this PR: - `@dependabot rebase` will rebase this PR - `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it - `@dependabot merge` will merge this PR after your CI passes on it - `@dependabot squash and merge` will squash and merge this PR after your CI passes on it - `@dependabot cancel merge` will cancel a previously requested merge and block automerging - `@dependabot reopen` will reopen this PR if it is closed - `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually - `@dependabot show <dependency name> ignore conditions` will show all of the ignore conditions of the specified dependency - `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself) </details> Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
1 parent 9209e14 commit 959993f

File tree

2 files changed

+6
-64
lines changed

2 files changed

+6
-64
lines changed

package-lock.json

Lines changed: 5 additions & 63 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@
4747
"jsonata": "^2.0.5",
4848
"prettier": "3.2.5",
4949
"typedoc": "^0.25.13",
50-
"typedoc-plugin-markdown": "^3.17.1",
50+
"typedoc-plugin-markdown": "^4.0.2",
5151
"typedoc-plugin-missing-exports": "^2.2.0",
5252
"typescript": "^5"
5353
}

0 commit comments

Comments
 (0)