b4b8088a97
Bumps [mermaid](https://github.com/mermaid-js/mermaid) from 10.7.0 to 10.8.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> <h1>v10.8.0</h1> <h2>Features</h2> <!-- raw HTML omitted --> <ul> <li> <p>Adding new diagram type - Block Diagram by <a href="https://github.com/knsv"><code>@knsv</code></a> in <a href="https://redirect.github.com/mermaid-js/mermaid/pull/5221">mermaid-js/mermaid#5221</a></p> </li> <li> <p>Feature/5114 add parallel commit config by <a href="https://github.com/mathbraga"><code>@mathbraga</code></a> in <a href="https://redirect.github.com/mermaid-js/mermaid/pull/5161">mermaid-js/mermaid#5161</a></p> </li> <li> <p>Changes to Gantt Parsers to allow hashes and semicolons to titles, sections, and task data. by <a href="https://github.com/FutzMonitor"><code>@FutzMonitor</code></a> in <a href="https://redirect.github.com/mermaid-js/mermaid/pull/5095">mermaid-js/mermaid#5095</a></p> </li> <li> <p>Feature/4653 add actor-top class to sequence diagram by <a href="https://github.com/Ronid1"><code>@Ronid1</code></a> in <a href="https://redirect.github.com/mermaid-js/mermaid/pull/5241">mermaid-js/mermaid#5241</a></p> </li> </ul> <h2>Documentation</h2> <ul> <li>Updated gantt chart docs to show all config options by <a href="https://github.com/murdoa"><code>@murdoa</code></a> in <a href="https://redirect.github.com/mermaid-js/mermaid/pull/5192">mermaid-js/mermaid#5192</a></li> <li>Contribution documentation improvements by <a href="https://github.com/nirname"><code>@nirname</code></a> in <a href="https://redirect.github.com/mermaid-js/mermaid/pull/5132">mermaid-js/mermaid#5132</a></li> <li>Update flowchart.md - how to use font-awesome <a href="https://redirect.github.com/mermaid-js/mermaid/issues/5195">#5195</a> by <a href="https://github.com/arukiidou"><code>@arukiidou</code></a> in <a href="https://redirect.github.com/mermaid-js/mermaid/pull/5196">mermaid-js/mermaid#5196</a></li> <li>Add more detailed docs for Gantt tasks by <a href="https://github.com/sorenisanerd"><code>@sorenisanerd</code></a> in <a href="https://redirect.github.com/mermaid-js/mermaid/pull/5194">mermaid-js/mermaid#5194</a></li> <li>Docs/4974 reorder integration links by <a href="https://github.com/Ronid1"><code>@Ronid1</code></a> in <a href="https://redirect.github.com/mermaid-js/mermaid/pull/5066">mermaid-js/mermaid#5066</a></li> <li>docs: fix swimm link by <a href="https://github.com/Yokozuna59"><code>@Yokozuna59</code></a> in <a href="https://redirect.github.com/mermaid-js/mermaid/pull/5219">mermaid-js/mermaid#5219</a></li> <li>Update Slack community links to Discord by <a href="https://github.com/Olegt0rr"><code>@Olegt0rr</code></a> in <a href="https://redirect.github.com/mermaid-js/mermaid/pull/5225">mermaid-js/mermaid#5225</a></li> <li>Docs: Mermaid chart updates by <a href="https://github.com/huynhicode"><code>@huynhicode</code></a> in <a href="https://redirect.github.com/mermaid-js/mermaid/pull/5232">mermaid-js/mermaid#5232</a></li> <li>Fix typos in timeline syntax samples by <a href="https://github.com/sblom"><code>@sblom</code></a> in <a href="https://redirect.github.com/mermaid-js/mermaid/pull/5139">mermaid-js/mermaid#5139</a></li> </ul> <h2>Bug fixes</h2> <ul> <li>Bug/5059 fix external connection after updating edges by <a href="https://github.com/mathbraga"><code>@mathbraga</code></a> in <a href="https://redirect.github.com/mermaid-js/mermaid/pull/5127">mermaid-js/mermaid#5127</a></li> <li>[Fix] Sequence diagram actor menu popup by <a href="https://github.com/vitorsss"><code>@vitorsss</code></a> in <a href="https://redirect.github.com/mermaid-js/mermaid/pull/5160">mermaid-js/mermaid#5160</a></li> <li>fix: Dompurify Hooks by <a href="https://github.com/sidharthv96"><code>@sidharthv96</code></a> in <a href="https://redirect.github.com/mermaid-js/mermaid/pull/5236">mermaid-js/mermaid#5236</a></li> <li>Accurate pie chart labeling for text alignment by <a href="https://github.com/JenningsWilliam"><code>@JenningsWilliam</code></a> in <a href="https://redirect.github.com/mermaid-js/mermaid/pull/5141">mermaid-js/mermaid#5141</a></li> <li>fix: Redirect of old URLs by <a href="https://github.com/sidharthv96"><code>@sidharthv96</code></a> in <a href="https://redirect.github.com/mermaid-js/mermaid/pull/5250">mermaid-js/mermaid#5250</a></li> <li>Fixed Typo in ErrorRenderer.ts by <a href="https://github.com/FutzMonitor"><code>@FutzMonitor</code></a> in <a href="https://redirect.github.com/mermaid-js/mermaid/pull/5256">mermaid-js/mermaid#5256</a></li> </ul> <h2>Chores</h2> <ul> <li>Revert "Revert 5041 feature/4935 subgraph title margin config option" by <a href="https://github.com/mathbraga"><code>@mathbraga</code></a> in <a href="https://redirect.github.com/mermaid-js/mermaid/pull/5205">mermaid-js/mermaid#5205</a></li> <li>build(deps-dev): bump follow-redirects from 1.15.2 to 1.15.5 by <a href="https://github.com/dependabot"><code>@dependabot</code></a> in <a href="https://redirect.github.com/mermaid-js/mermaid/pull/5200">mermaid-js/mermaid#5200</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/5150">mermaid-js/mermaid#5150</a></li> <li>E2E Image comparison by <a href="https://github.com/sidharthv96"><code>@sidharthv96</code></a> in <a href="https://redirect.github.com/mermaid-js/mermaid/pull/5208">mermaid-js/mermaid#5208</a></li> <li>E2E test by <a href="https://github.com/sidharthv96"><code>@sidharthv96</code></a> in <a href="https://redirect.github.com/mermaid-js/mermaid/pull/5210">mermaid-js/mermaid#5210</a></li> <li>Optimise caching of test results by <a href="https://github.com/sidharthv96"><code>@sidharthv96</code></a> in <a href="https://redirect.github.com/mermaid-js/mermaid/pull/5213">mermaid-js/mermaid#5213</a></li> <li>Update update-browserlist.yml to fix deprecation and action fails by <a href="https://github.com/Abrifq"><code>@Abrifq</code></a> in <a href="https://redirect.github.com/mermaid-js/mermaid/pull/5151">mermaid-js/mermaid#5151</a></li> <li>UpdateCypress by <a href="https://github.com/sidharthv96"><code>@sidharthv96</code></a> in <a href="https://redirect.github.com/mermaid-js/mermaid/pull/5228">mermaid-js/mermaid#5228</a></li> <li>Use node v20 by <a href="https://github.com/sidharthv96"><code>@sidharthv96</code></a> in <a href="https://redirect.github.com/mermaid-js/mermaid/pull/5248">mermaid-js/mermaid#5248</a></li> <li>Convert Mindmap to TS by <a href="https://github.com/sidharthv96"><code>@sidharthv96</code></a> in <a href="https://redirect.github.com/mermaid-js/mermaid/pull/5247">mermaid-js/mermaid#5247</a></li> <li>chore: Add interface naming Convention by <a href="https://github.com/sidharthv96"><code>@sidharthv96</code></a> in <a href="https://redirect.github.com/mermaid-js/mermaid/pull/5254">mermaid-js/mermaid#5254</a></li> </ul> <h2>New Contributors</h2> <ul> <li><a href="https://github.com/murdoa"><code>@murdoa</code></a> made their first contribution in <a href="https://redirect.github.com/mermaid-js/mermaid/pull/5192">mermaid-js/mermaid#5192</a></li> <li><a href="https://github.com/arukiidou"><code>@arukiidou</code></a> made their first contribution in <a href="https://redirect.github.com/mermaid-js/mermaid/pull/5196">mermaid-js/mermaid#5196</a></li> <li><a href="https://github.com/sorenisanerd"><code>@sorenisanerd</code></a> made their first contribution in <a href="https://redirect.github.com/mermaid-js/mermaid/pull/5194">mermaid-js/mermaid#5194</a></li> </ul> <!-- raw HTML omitted --> </blockquote> <p>... (truncated)</p> </details> <details> <summary>Commits</summary> <ul> <li><a href="51e7444b94"><code>51e7444</code></a> <a href="https://redirect.github.com/mermaid-js/mermaid/issues/3358">#3358</a> Layoutfix for growing parent when children spans new rows due to update...</li> <li><a href="2fa9219353"><code>2fa9219</code></a> Update docs</li> <li><a href="f5555245f9"><code>f555524</code></a> Mermaid version 10.8.0</li> <li><a href="5c9857c4eb"><code>5c9857c</code></a> Merge pull request <a href="https://redirect.github.com/mermaid-js/mermaid/issues/5247">#5247</a> from mermaid-js/sidv/mindmapToTs</li> <li><a href="494ba45c5e"><code>494ba45</code></a> Fixed Typo in ErrorRenderer.ts (<a href="https://redirect.github.com/mermaid-js/mermaid/issues/5256">#5256</a>)</li> <li><a href="b38def6866"><code>b38def6</code></a> Merge pull request <a href="https://redirect.github.com/mermaid-js/mermaid/issues/5221">#5221</a> from mermaid-js/3358-blocks-diagram</li> <li><a href="a7afc11079"><code>a7afc11</code></a> <a href="https://redirect.github.com/mermaid-js/mermaid/issues/3358">#3358</a> Removing redundant file</li> <li><a href="d3c5b02008"><code>d3c5b02</code></a> Merge branch '3358-blocks-diagram' of github.com:mermaid-js/mermaid into 3358...</li> <li><a href="16149abcc0"><code>16149ab</code></a> <a href="https://redirect.github.com/mermaid-js/mermaid/issues/3358">#3358</a> Fix after review</li> <li><a href="13d0b61757"><code>13d0b61</code></a> Merge branch 'develop' into 3358-blocks-diagram</li> <li>Additional commits viewable in <a href="https://github.com/mermaid-js/mermaid/compare/v10.7.0...v10.8.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 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).