4346f902e0
Bumps [mermaid](https://github.com/mermaid-js/mermaid) from 10.3.0 to 10.3.1. <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.3.1</h2> <h2>What's Changed</h2> <h2>Bugfixes</h2> <ul> <li>fix style in contributors section of intro by <a href="https://github.com/keer4n"><code>@keer4n</code></a> in <a href="https://redirect.github.com/mermaid-js/mermaid/pull/4670">mermaid-js/mermaid#4670</a></li> <li>fix: <a href="https://redirect.github.com/mermaid-js/mermaid/issues/4676">#4676</a> redirect fix by <a href="https://github.com/sidharthv96"><code>@sidharthv96</code></a> in <a href="https://redirect.github.com/mermaid-js/mermaid/pull/4693">mermaid-js/mermaid#4693</a></li> <li><a href="https://redirect.github.com/mermaid-js/mermaid/issues/2139">#2139</a> Applying user defined classes properly when calculating shape width by <a href="https://github.com/knsv"><code>@knsv</code></a> in <a href="https://redirect.github.com/mermaid-js/mermaid/pull/4722">mermaid-js/mermaid#4722</a></li> <li>Bug/4645 graph node containing keyword by <a href="https://github.com/ibrahimWassouf"><code>@ibrahimWassouf</code></a> in <a href="https://redirect.github.com/mermaid-js/mermaid/pull/4657">mermaid-js/mermaid#4657</a></li> <li>fix: Remove triple parsing of diagrams by <a href="https://github.com/sidharthv96"><code>@sidharthv96</code></a> in <a href="https://redirect.github.com/mermaid-js/mermaid/pull/4697">mermaid-js/mermaid#4697</a></li> <li>resolve info <code>HTML</code> and <code>Document</code> assignment by <a href="https://github.com/Yokozuna59"><code>@Yokozuna59</code></a> in <a href="https://redirect.github.com/mermaid-js/mermaid/pull/4514">mermaid-js/mermaid#4514</a></li> <li>fix!(deps): fix zenuml style leakage. by <a href="https://github.com/danshuitaihejie"><code>@danshuitaihejie</code></a> in <a href="https://redirect.github.com/mermaid-js/mermaid/pull/4705">mermaid-js/mermaid#4705</a></li> <li>Use our prettier config on the <code>packages/mermaid/src/config.type.ts</code> file by <a href="https://github.com/aloisklink"><code>@aloisklink</code></a> in <a href="https://redirect.github.com/mermaid-js/mermaid/pull/4715">mermaid-js/mermaid#4715</a></li> <li>create <code>ParserDefinition</code> type by <a href="https://github.com/Yokozuna59"><code>@Yokozuna59</code></a> in <a href="https://redirect.github.com/mermaid-js/mermaid/pull/4719">mermaid-js/mermaid#4719</a></li> <li>standardized <code>error</code> diagram by <a href="https://github.com/Yokozuna59"><code>@Yokozuna59</code></a> in <a href="https://redirect.github.com/mermaid-js/mermaid/pull/4718">mermaid-js/mermaid#4718</a></li> </ul> <h2>Documentation</h2> <ul> <li>Docs: Directives not needed in new diagrams as yaml formatter does this for all new diagrams by <a href="https://github.com/Incognito"><code>@Incognito</code></a> in <a href="https://redirect.github.com/mermaid-js/mermaid/pull/4688">mermaid-js/mermaid#4688</a></li> <li>Docs: add latest blog post by <a href="https://github.com/huynhicode"><code>@huynhicode</code></a> in <a href="https://redirect.github.com/mermaid-js/mermaid/pull/4668">mermaid-js/mermaid#4668</a></li> <li>Lychee config by <a href="https://github.com/mmorel-35"><code>@mmorel-35</code></a> in <a href="https://redirect.github.com/mermaid-js/mermaid/pull/4699">mermaid-js/mermaid#4699</a></li> <li>Syntax Update CONTRIBUTING.md by <a href="https://github.com/soomrozaid"><code>@soomrozaid</code></a> in <a href="https://redirect.github.com/mermaid-js/mermaid/pull/4713">mermaid-js/mermaid#4713</a></li> </ul> <h2>Chores</h2> <ul> <li>chore(deps): update all minor dependencies (minor) by <a href="https://github.com/renovate"><code>@renovate</code></a> in <a href="https://redirect.github.com/mermaid-js/mermaid/pull/4682">mermaid-js/mermaid#4682</a></li> <li>build(deps-dev): bump json5 from 2.2.1 to 2.2.3 by <a href="https://github.com/dependabot"><code>@dependabot</code></a> in <a href="https://redirect.github.com/mermaid-js/mermaid/pull/4685">mermaid-js/mermaid#4685</a></li> <li>build(deps): bump <code>@braintree/sanitize-url</code> from 6.0.0 to 6.0.1 by <a href="https://github.com/dependabot"><code>@dependabot</code></a> in <a href="https://redirect.github.com/mermaid-js/mermaid/pull/4686">mermaid-js/mermaid#4686</a></li> <li>build(deps-dev): bump vite from 4.3.3 to 4.3.9 by <a href="https://github.com/dependabot"><code>@dependabot</code></a> in <a href="https://redirect.github.com/mermaid-js/mermaid/pull/4687">mermaid-js/mermaid#4687</a></li> <li>chore(deps): update all patch dependencies (patch) by <a href="https://github.com/renovate"><code>@renovate</code></a> in <a href="https://redirect.github.com/mermaid-js/mermaid/pull/4681">mermaid-js/mermaid#4681</a></li> <li>chore: ts-ignore comment was misleading, JISON doesn't support types by <a href="https://github.com/Incognito"><code>@Incognito</code></a> in <a href="https://redirect.github.com/mermaid-js/mermaid/pull/4689">mermaid-js/mermaid#4689</a></li> <li>chore(deps): unpin the dompurify dependency by <a href="https://github.com/djadmin"><code>@djadmin</code></a> in <a href="https://redirect.github.com/mermaid-js/mermaid/pull/4677">mermaid-js/mermaid#4677</a></li> <li>build(deps-dev): bump pnpm from 8.3.1 to 8.6.8 by <a href="https://github.com/dependabot"><code>@dependabot</code></a> in <a href="https://redirect.github.com/mermaid-js/mermaid/pull/4692">mermaid-js/mermaid#4692</a></li> </ul> <h2>New Contributors</h2> <ul> <li><a href="https://github.com/keer4n"><code>@keer4n</code></a> made their first contribution in <a href="https://redirect.github.com/mermaid-js/mermaid/pull/4670">mermaid-js/mermaid#4670</a></li> <li><a href="https://github.com/djadmin"><code>@djadmin</code></a> made their first contribution in <a href="https://redirect.github.com/mermaid-js/mermaid/pull/4677">mermaid-js/mermaid#4677</a></li> <li><a href="https://github.com/danshuitaihejie"><code>@danshuitaihejie</code></a> made their first contribution in <a href="https://redirect.github.com/mermaid-js/mermaid/pull/4705">mermaid-js/mermaid#4705</a></li> <li><a href="https://github.com/soomrozaid"><code>@soomrozaid</code></a> made their first contribution in <a href="https://redirect.github.com/mermaid-js/mermaid/pull/4713">mermaid-js/mermaid#4713</a></li> </ul> <p><strong>Full Changelog</strong>: <a href="https://github.com/mermaid-js/mermaid/compare/v10.3.0...v10.3.1">https://github.com/mermaid-js/mermaid/compare/v10.3.0...v10.3.1</a></p> </blockquote> </details> <details> <summary>Commits</summary> <ul> <li><a href="a0b80f5490"><code>a0b80f5</code></a> Version update and adjusted error diagram</li> <li><a href="493023118f"><code>4930231</code></a> Fix for broker error diagram related <a href="https://redirect.github.com/mermaid-js/mermaid/issues/4178">#4178</a></li> <li><a href="c5e7e6040c"><code>c5e7e60</code></a> Adding new flowchart tests related to issue <a href="https://redirect.github.com/mermaid-js/mermaid/issues/2139">#2139</a></li> <li><a href="c938c7a438"><code>c938c7a</code></a> Fix for interim issue with classes in state diagrams</li> <li><a href="c7bcf72c69"><code>c7bcf72</code></a> Merge branch 'develop' into release/10.4.0</li> <li><a href="da602add5d"><code>da602ad</code></a> Merge pull request <a href="https://redirect.github.com/mermaid-js/mermaid/issues/4697">#4697</a> from mermaid-js/sidv/fixTripleParsing</li> <li><a href="9049a99c8d"><code>9049a99</code></a> Merge pull request <a href="https://redirect.github.com/mermaid-js/mermaid/issues/4722">#4722</a> from mermaid-js/2139-handling-styling-properly-when-...</li> <li><a href="60957519c8"><code>6095751</code></a> Merge branch 'develop' into release/10.4.0</li> <li><a href="9b9ad1da7d"><code>9b9ad1d</code></a> Merge pull request <a href="https://redirect.github.com/mermaid-js/mermaid/issues/4718">#4718</a> from Yokozuna59/chore/standardized-error-definitions</li> <li><a href="0d380bb2c7"><code>0d380bb</code></a> Merge branch 'develop' into chore/standardized-error-definitions</li> <li>Additional commits viewable in <a href="https://github.com/mermaid-js/mermaid/compare/v10.3.0...v10.3.1">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 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>
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).