578a720c67
Bumps [mermaid](https://github.com/mermaid-js/mermaid) from 10.2.4 to 10.3.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>10.3.0</h2> <h2>What's Changed</h2> <h3>Features</h3> <ul> <li>Sankey diagrams by <a href="https://github.com/nirname"><code>@nirname</code></a> in <a href="https://redirect.github.com/mermaid-js/mermaid/pull/4502">mermaid-js/mermaid#4502</a></li> <li>Feature/1838 actor creation destruction by <a href="https://github.com/Valentine14th"><code>@Valentine14th</code></a> in <a href="https://redirect.github.com/mermaid-js/mermaid/pull/4466">mermaid-js/mermaid#4466</a></li> <li>Vertical branches in Git Diagram by <a href="https://github.com/mastersibin"><code>@mastersibin</code></a> in <a href="https://redirect.github.com/mermaid-js/mermaid/pull/4639">mermaid-js/mermaid#4639</a></li> <li>Use JSON Schema to define and document <code>MermaidConfig</code> by <a href="https://github.com/aloisklink"><code>@aloisklink</code></a> in <a href="https://redirect.github.com/mermaid-js/mermaid/pull/4112">mermaid-js/mermaid#4112</a></li> <li>Remove the test checking whether the JSON Schema default config matched the old default config by <a href="https://github.com/aloisklink"><code>@aloisklink</code></a> in <a href="https://redirect.github.com/mermaid-js/mermaid/pull/4610">mermaid-js/mermaid#4610</a></li> <li>Fixes support of the macro <code>ContainerQueue_Ext</code> for C4 diagrams definition. by <a href="https://github.com/kislerdm"><code>@kislerdm</code></a> in <a href="https://redirect.github.com/mermaid-js/mermaid/pull/4577">mermaid-js/mermaid#4577</a></li> </ul> <h3>Bugfixes</h3> <ul> <li>Make quadrant chart options TypeScript types optional by <a href="https://github.com/aloisklink"><code>@aloisklink</code></a> in <a href="https://redirect.github.com/mermaid-js/mermaid/pull/4602">mermaid-js/mermaid#4602</a></li> <li>Remove double parsing by <a href="https://github.com/nirname"><code>@nirname</code></a> in <a href="https://redirect.github.com/mermaid-js/mermaid/pull/4587">mermaid-js/mermaid#4587</a></li> <li>Fix flowchart tooltip typing bug by <a href="https://github.com/lishid"><code>@lishid</code></a> in <a href="https://redirect.github.com/mermaid-js/mermaid/pull/4562">mermaid-js/mermaid#4562</a></li> <li>Bug/4590 allow notes identical to keywords by <a href="https://github.com/ibrahimWassouf"><code>@ibrahimWassouf</code></a> in <a href="https://redirect.github.com/mermaid-js/mermaid/pull/4597">mermaid-js/mermaid#4597</a></li> <li>feat: allow specifying on which weekday a tickInterval should start by <a href="https://github.com/leinelissen"><code>@leinelissen</code></a> in <a href="https://redirect.github.com/mermaid-js/mermaid/pull/4634">mermaid-js/mermaid#4634</a></li> <li>Split formatted markdown strings with unicode support. by <a href="https://github.com/sidharthv96"><code>@sidharthv96</code></a> in <a href="https://redirect.github.com/mermaid-js/mermaid/pull/4470">mermaid-js/mermaid#4470</a></li> <li>fix: Mind maps handles <code>-</code> signs in node ids/text by <a href="https://github.com/knsv"><code>@knsv</code></a></li> </ul> <h3>Chores</h3> <ul> <li>Remove all TypeScript enums and forbid them in ESLint by <a href="https://github.com/aloisklink"><code>@aloisklink</code></a> in <a href="https://redirect.github.com/mermaid-js/mermaid/pull/4580">mermaid-js/mermaid#4580</a></li> <li>refactor accessibility by <a href="https://github.com/Yokozuna59"><code>@Yokozuna59</code></a> in <a href="https://redirect.github.com/mermaid-js/mermaid/pull/4551">mermaid-js/mermaid#4551</a></li> <li>chore: Reduce codecov pushes by <a href="https://github.com/sidharthv96"><code>@sidharthv96</code></a> in <a href="https://redirect.github.com/mermaid-js/mermaid/pull/4604">mermaid-js/mermaid#4604</a></li> <li>Run PR-labeler-config-validator only if config changes by <a href="https://github.com/sidharthv96"><code>@sidharthv96</code></a> in <a href="https://redirect.github.com/mermaid-js/mermaid/pull/4607">mermaid-js/mermaid#4607</a></li> <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/4624">mermaid-js/mermaid#4624</a></li> <li>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/4566">mermaid-js/mermaid#4566</a></li> <li>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/4581">mermaid-js/mermaid#4581</a></li> <li>Rename workflow jobs by <a href="https://github.com/sidharthv96"><code>@sidharthv96</code></a> in <a href="https://redirect.github.com/mermaid-js/mermaid/pull/4574">mermaid-js/mermaid#4574</a></li> <li>Removed unused code in state diagrams by <a href="https://github.com/nirname"><code>@nirname</code></a> in <a href="https://redirect.github.com/mermaid-js/mermaid/pull/4631">mermaid-js/mermaid#4631</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/4623">mermaid-js/mermaid#4623</a></li> <li>chore: remove unused <code>devDependency</code> on coveralls by <a href="https://github.com/aloisklink"><code>@aloisklink</code></a> in <a href="https://redirect.github.com/mermaid-js/mermaid/pull/4641">mermaid-js/mermaid#4641</a></li> <li>Allow entity diagram attribute names to start with asterisk by <a href="https://github.com/ibrahimWassouf"><code>@ibrahimWassouf</code></a> in <a href="https://redirect.github.com/mermaid-js/mermaid/pull/4588">mermaid-js/mermaid#4588</a></li> <li>Bug/4592 fix new line padding class diagram by <a href="https://github.com/ibrahimWassouf"><code>@ibrahimWassouf</code></a> in <a href="https://redirect.github.com/mermaid-js/mermaid/pull/4633">mermaid-js/mermaid#4633</a></li> <li>Fix graph not loading when the img loads too fast or fail to load by <a href="https://github.com/pierrickouw"><code>@pierrickouw</code></a> in <a href="https://redirect.github.com/mermaid-js/mermaid/pull/4496">mermaid-js/mermaid#4496</a></li> <li>convert <code>cypress/helpers/util.js</code> to ts by <a href="https://github.com/Yokozuna59"><code>@Yokozuna59</code></a> in <a href="https://redirect.github.com/mermaid-js/mermaid/pull/4552">mermaid-js/mermaid#4552</a></li> <li>build(deps-dev): bump word-wrap from 1.2.3 to 1.2.4 by <a href="https://github.com/dependabot"><code>@dependabot</code></a> in <a href="https://redirect.github.com/mermaid-js/mermaid/pull/4652">mermaid-js/mermaid#4652</a></li> <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/4663">mermaid-js/mermaid#4663</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/4662">mermaid-js/mermaid#4662</a></li> </ul> <h3>Documentation</h3> <ul> <li>Sankey: Remove duplicated examples by <a href="https://github.com/nirname"><code>@nirname</code></a> in <a href="https://redirect.github.com/mermaid-js/mermaid/pull/4595">mermaid-js/mermaid#4595</a></li> <li>Release docs by <a href="https://github.com/sidharthv96"><code>@sidharthv96</code></a> in <a href="https://redirect.github.com/mermaid-js/mermaid/pull/4493">mermaid-js/mermaid#4493</a></li> <li>Update latest news section by <a href="https://github.com/huynhicode"><code>@huynhicode</code></a> in <a href="https://redirect.github.com/mermaid-js/mermaid/pull/4495">mermaid-js/mermaid#4495</a></li> <li>Fix Typo by <a href="https://github.com/ryru"><code>@ryru</code></a> in <a href="https://redirect.github.com/mermaid-js/mermaid/pull/4567">mermaid-js/mermaid#4567</a></li> </ul> <!-- raw HTML omitted --> </blockquote> <p>... (truncated)</p> </details> <details> <summary>Commits</summary> <ul> <li><a href="165e0b6c68"><code>165e0b6</code></a> Merge pull request <a href="https://redirect.github.com/mermaid-js/mermaid/issues/4669">#4669</a> from mermaid-js/release/10.3.0</li> <li><a href="9c92f779ae"><code>9c92f77</code></a> Updates after testing and new version for mermaid-zenuml</li> <li><a href="aa54127784"><code>aa54127</code></a> Set proper release version</li> <li><a href="21b90cbcd2"><code>21b90cb</code></a> Add release version</li> <li><a href="e1ca108b00"><code>e1ca108</code></a> Update version</li> <li><a href="29d078c822"><code>29d078c</code></a> Merge branch 'master' into release/10.3.0</li> <li><a href="40d30b7045"><code>40d30b7</code></a> Merge remote-tracking branch 'origin/release/10.3.2' into develop</li> <li><a href="dbee34aba7"><code>dbee34a</code></a> fix: edgeLabel width</li> <li><a href="68909a43f7"><code>68909a4</code></a> Update lockfile</li> <li><a href="d178626bac"><code>d178626</code></a> Merge branch 'develop' into release/10.4.0</li> <li>Additional commits viewable in <a href="https://github.com/mermaid-js/mermaid/compare/v10.2.4...v10.3.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).