01943e6f12
Bumps [mermaid](https://github.com/mermaid-js/mermaid) from 9.4.0 to 10.0.0. <details> <summary>Release notes</summary> <p><em>Sourced from <a href="https://github.com/mermaid-js/mermaid/releases">mermaid's releases</a>.</em></p> <blockquote> <h2>v10.0.0</h2> <h2>What's Changed</h2> <h3>Please refer the <a href="https://github.com/mermaid-js/mermaid/blob/master/CHANGELOG.md#1000">v10 changes section in CHANGELOG.md</a> to see detailed migration steps.</h3> <h3>Breaking changes in v10</h3> <ul> <li>Switch to ESM only for v10? by <a href="https://github.com/sidharthv96"><code>@sidharthv96</code></a> <a href="https://github-redirect.dependabot.com/mermaid-js/mermaid/issues/3590">#3590</a></li> <li>Break type of mermaid.render in v10 by <a href="https://github.com/sidharthv96"><code>@sidharthv96</code></a> <a href="https://github-redirect.dependabot.com/mermaid-js/mermaid/issues/3577">#3577</a></li> <li>Improve init function and how selector and nodes are passed by <a href="https://github.com/sidharthv96"><code>@sidharthv96</code></a> <a href="https://github-redirect.dependabot.com/mermaid-js/mermaid/issues/3394">#3394</a></li> <li>mermaid.init is not using the config that's passed by <a href="https://github.com/sidharthv96"><code>@sidharthv96</code></a> <a href="https://github-redirect.dependabot.com/mermaid-js/mermaid/issues/3406">#3406</a></li> <li>Configurable HTML class for initialisation by <a href="https://github.com/sidharthv96"><code>@sidharthv96</code></a> <a href="https://github-redirect.dependabot.com/mermaid-js/mermaid/issues/3055">#3055</a></li> </ul> <h3>Features</h3> <ul> <li>fix(api): tree shaking package.json import by <a href="https://github.com/AielloChan"><code>@AielloChan</code></a> in <a href="https://github-redirect.dependabot.com/mermaid-js/mermaid/pull/4101">mermaid-js/mermaid#4101</a></li> <li>splitDiagrams by <a href="https://github.com/sidharthv96"><code>@sidharthv96</code></a> in <a href="https://github-redirect.dependabot.com/mermaid-js/mermaid/pull/4110">mermaid-js/mermaid#4110</a></li> <li>Adding the ability to use invisible edges by <a href="https://github.com/knsv"><code>@knsv</code></a> in <a href="https://github-redirect.dependabot.com/mermaid-js/mermaid/pull/4113">mermaid-js/mermaid#4113</a></li> </ul> <h3>Docs</h3> <ul> <li>Add logo to readme by <a href="https://github.com/sidharthv96"><code>@sidharthv96</code></a> in <a href="https://github-redirect.dependabot.com/mermaid-js/mermaid/pull/4076">mermaid-js/mermaid#4076</a></li> <li>docs: minor fix on markdown by <a href="https://github.com/Jeff-Tian"><code>@Jeff-Tian</code></a> in <a href="https://github-redirect.dependabot.com/mermaid-js/mermaid/pull/4015">mermaid-js/mermaid#4015</a></li> <li>Fix typos by <a href="https://github.com/fkohrt"><code>@fkohrt</code></a> in <a href="https://github-redirect.dependabot.com/mermaid-js/mermaid/pull/4118">mermaid-js/mermaid#4118</a></li> </ul> <h3>Chores</h3> <ul> <li>chore(deps): update all non-major dependencies (minor) by <a href="https://github.com/renovate"><code>@renovate</code></a> in <a href="https://github-redirect.dependabot.com/mermaid-js/mermaid/pull/4044">mermaid-js/mermaid#4044</a></li> <li>chore(deps): update dependency <code>@types/uuid</code> to v9 by <a href="https://github.com/renovate"><code>@renovate</code></a> in <a href="https://github-redirect.dependabot.com/mermaid-js/mermaid/pull/4067">mermaid-js/mermaid#4067</a></li> <li>build(lint:fix): cache eslint in pnpm run lint:fix by <a href="https://github.com/aloisklink"><code>@aloisklink</code></a> in <a href="https://github-redirect.dependabot.com/mermaid-js/mermaid/pull/4073">mermaid-js/mermaid#4073</a></li> <li>chore(deps): update dependency rimraf to v4 by <a href="https://github.com/renovate"><code>@renovate</code></a> in <a href="https://github-redirect.dependabot.com/mermaid-js/mermaid/pull/4070">mermaid-js/mermaid#4070</a></li> <li>chore(deps): update dependency jsdom to v21 by <a href="https://github.com/renovate"><code>@renovate</code></a> in <a href="https://github-redirect.dependabot.com/mermaid-js/mermaid/pull/4069">mermaid-js/mermaid#4069</a></li> <li>chore(deps): update timonvs/pr-labeler-action action to v4 by <a href="https://github.com/renovate"><code>@renovate</code></a> in <a href="https://github-redirect.dependabot.com/mermaid-js/mermaid/pull/4072">mermaid-js/mermaid#4072</a></li> <li>chore(deps): update actions/configure-pages action to v3 by <a href="https://github.com/renovate"><code>@renovate</code></a> in <a href="https://github-redirect.dependabot.com/mermaid-js/mermaid/pull/4065">mermaid-js/mermaid#4065</a></li> <li>chore(deps): update actions/dependency-review-action action to v3 by <a href="https://github.com/renovate"><code>@renovate</code></a> in <a href="https://github-redirect.dependabot.com/mermaid-js/mermaid/pull/4066">mermaid-js/mermaid#4066</a></li> <li>chore(deps): update dependency vite to v4 by <a href="https://github.com/renovate"><code>@renovate</code></a> in <a href="https://github-redirect.dependabot.com/mermaid-js/mermaid/pull/4071">mermaid-js/mermaid#4071</a></li> <li>chore(deps): update dependency cypress to v12 by <a href="https://github.com/renovate"><code>@renovate</code></a> in <a href="https://github-redirect.dependabot.com/mermaid-js/mermaid/pull/4068">mermaid-js/mermaid#4068</a></li> </ul> <h2>New Contributors</h2> <ul> <li><a href="https://github.com/Jeff-Tian"><code>@Jeff-Tian</code></a> made their first contribution in <a href="https://github-redirect.dependabot.com/mermaid-js/mermaid/pull/4015">mermaid-js/mermaid#4015</a></li> <li><a href="https://github.com/AielloChan"><code>@AielloChan</code></a> made their first contribution in <a href="https://github-redirect.dependabot.com/mermaid-js/mermaid/pull/4101">mermaid-js/mermaid#4101</a></li> <li><a href="https://github.com/fkohrt"><code>@fkohrt</code></a> made their first contribution in <a href="https://github-redirect.dependabot.com/mermaid-js/mermaid/pull/4118">mermaid-js/mermaid#4118</a></li> </ul> <p><strong>Full Changelog</strong>: <a href="https://github.com/mermaid-js/mermaid/compare/v9.4.0...v10.0.0">https://github.com/mermaid-js/mermaid/compare/v9.4.0...v10.0.0</a></p> </blockquote> </details> <details> <summary>Changelog</summary> <p><em>Sourced from <a href="https://github.com/mermaid-js/mermaid/blob/develop/CHANGELOG.md">mermaid's changelog</a>.</em></p> <blockquote> <h2><a href="https://github.com/mermaid-js/mermaid/releases/tag/v10.0.0">10.0.0</a></h2> <h3>mermaid.render is async and doesn't accept callbacks</h3> <pre lang="js"><code>// < v10 mermaid.render('id', 'graph TD;\nA-->B', (svg, bindFunctions) => { element.innerHTML = svg; if (bindFunctions) { bindFunctions(element); } }); <p>// Shorter syntax if (bindFunctions) { bindFunctions(element); } // can be replaced with the <code>?.</code> shorthand bindFunctions?.(element);</p> <p>// >= v10 with async/await const { svg, bindFunctions } = await mermaid.render('id', 'graph TD;\nA-->B'); element.innerHTML = svg; bindFunctions?.(element);</p> <p>// >= v10 with promise.then mermaid.render('id', 'graph TD;A-->B').then(({ svg, bindFunctions }) => { element.innerHTML = svg; bindFunctions?.(element); }); </code></pre></p> <h3>mermaid.parse is async and ParseError is removed</h3> <pre lang="js"><code>// < v10 mermaid.parse(text, parseError); <p>//>= v10 await mermaid.parse(text).catch(parseError); // or try { await mermaid.parse(text); } catch (err) { parseError(err); } </code></pre></p> <h3>Init deprecated and InitThrowsErrors removed</h3> <!-- raw HTML omitted --> </blockquote> <p>... (truncated)</p> </details> <details> <summary>Commits</summary> <ul> <li><a href="555d4f2cdc"><code>555d4f2</code></a> Fix spellings</li> <li><a href="75633ba125"><code>75633ba</code></a> Merge pull request <a href="https://github-redirect.dependabot.com/mermaid-js/mermaid/issues/4118">#4118</a> from fkohrt/patch-1</li> <li><a href="ec5fa31a11"><code>ec5fa31</code></a> Wrap option working in test case</li> <li><a href="bfb8a75fca"><code>bfb8a75</code></a> Fix typos</li> <li><a href="14c15b221a"><code>14c15b2</code></a> Minor cleanup</li> <li><a href="8743e9e30e"><code>8743e9e</code></a> Removed the deprecated use of mindmap in Demo</li> <li><a href="22b18a4320"><code>22b18a4</code></a> Merge pull request <a href="https://github-redirect.dependabot.com/mermaid-js/mermaid/issues/4113">#4113</a> from mermaid-js/3192_invisible_edges</li> <li><a href="786023ffa6"><code>786023f</code></a> Merge pull request <a href="https://github-redirect.dependabot.com/mermaid-js/mermaid/issues/4110">#4110</a> from mermaid-js/sidv/splitDiagrams</li> <li><a href="68cdc759a7"><code>68cdc75</code></a> Minor cleanup</li> <li><a href="eb04d80df0"><code>eb04d80</code></a> Update docs</li> <li>Additional commits viewable in <a href="https://github.com/mermaid-js/mermaid/compare/v9.4.0...v10.0.0">compare view</a></li> </ul> </details> <br /> [](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores) You can trigger a rebase of this PR 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 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>
Corso documentation
Corso documentation uses Docusaurus 2, a modern static website generator. Mermaid provides support for native diagrams in Markdown.
Requirements
Developing documentation for Corso requires the following tools on your machine:
make- Docker
Installation
make buildimage
Live documentation development
make dev
This command starts a local development server within the Docker container and will expose docs at http://localhost:3000.
Generating Corso CLI docs
make genclidocs
Corso's CLI documents are auto generated. This command explicitly triggers generating these docs. This step will happen automatically for the other commands where this is relevant.
Building static documentation
make build
This command generates static content into the build directory for integration with any static contents hosting service.
Serving static documentation
make serve
This command will serve the static content generated with make build at http://localhost:3000.
Style and linting
# Lint all docs
make check
# Lint specific files and/or folders
make check VALE_TARGET="README.md docs/concepts"
This command will lint all Markdown files and check them for style issues using the Docker container
Documentation platform development
make shell
Use this command to interactively (and temporarily!) change the contents or configuration of the live documentation container image (for example, when experimenting with new plugins).