826ba778ff
Bumps [@mdx-js/react](https://github.com/mdx-js/mdx/tree/HEAD/packages/react) from 1.6.22 to 2.1.5. <details> <summary>Release notes</summary> <p><em>Sourced from <a href="https://github.com/mdx-js/mdx/releases"><code>@mdx-js/react</code>'s releases</a>.</em></p> <blockquote> <h2>2.1.5</h2> <ul> <li>90fa4935 Fix bug with (injected) custom elements and layouts</li> </ul> <p><strong>Full Changelog</strong>: <a href="https://github.com/mdx-js/mdx/compare/2.1.4...2.1.5">https://github.com/mdx-js/mdx/compare/2.1.4...2.1.5</a></p> <h2>2.1.4</h2> <h4>Patches</h4> <ul> <li>9d2aa80b Add file, positional info to crashes in webpack loader by <a href="https://github.com/Twipped"><code>@Twipped</code></a> in <a href="https://github-redirect.dependabot.com/mdx-js/mdx/pull/2124">mdx-js/mdx#2124</a></li> <li>478c78b7 Fix support for Node loaders</li> </ul> <h4>Docs</h4> <ul> <li>56d70660 Add Astro to site generator docs by <a href="https://github.com/bholmesdev"><code>@bholmesdev</code></a> in <a href="https://github-redirect.dependabot.com/mdx-js/mdx/pull/2118">mdx-js/mdx#2118</a></li> <li>996771ae Add missing <code>import</code> to site example by <a href="https://github.com/elpddev"><code>@elpddev</code></a> in <a href="https://github-redirect.dependabot.com/mdx-js/mdx/pull/2115">mdx-js/mdx#2115</a></li> </ul> <p><strong>Full Changelog</strong>: <a href="https://github.com/mdx-js/mdx/compare/2.1.3...2.1.4">https://github.com/mdx-js/mdx/compare/2.1.3...2.1.4</a></p> <h2>2.1.3</h2> <h3>Core</h3> <ul> <li>9904838a Fix rewriting of components for custom elements by <a href="https://github.com/bholmesdev"><code>@bholmesdev</code></a> in <a href="https://github-redirect.dependabot.com/mdx-js/mdx/pull/2101">mdx-js/mdx#2101</a></li> </ul> <h3>Docs</h3> <ul> <li>69a15b76 Add link to official <code>mdx-js/vscode-mdx</code> by <a href="https://github.com/jasikpark"><code>@jasikpark</code></a> in <a href="https://github-redirect.dependabot.com/mdx-js/mdx/pull/2098">mdx-js/mdx#2098</a></li> </ul> <h3>Internal stuff that slightly improve stuff</h3> <ul> <li>529b96aa Replace <code>astring</code> with <code>estree-util-to-js</code></li> <li>7d8dc11c Add <code>id</code> field to esbuild messages</li> <li>7f37b95b Update <code>@types/estree-jsx</code></li> </ul> <p><strong>Full Changelog</strong>: <a href="https://github.com/mdx-js/mdx/compare/2.1.2...2.1.3">https://github.com/mdx-js/mdx/compare/2.1.2...2.1.3</a></p> <h2>2.1.2</h2> <h3>Core</h3> <ul> <li>7bcd7059 Fix some performance by improving vdom diffing by <a href="https://github.com/0phoff"><code>@0phoff</code></a> in <a href="https://github-redirect.dependabot.com/mdx-js/mdx/pull/2062">mdx-js/mdx#2062</a></li> <li>f77c33f5 Fix support for <code>baseUrl</code> rewriting <code>import.meta.url</code> by <a href="https://github.com/wooorm"><code>@wooorm</code></a> in <a href="https://github-redirect.dependabot.com/mdx-js/mdx/pull/2021">mdx-js/mdx#2021</a></li> </ul> <h3>Docs</h3> <!-- raw HTML omitted --> </blockquote> <p>... (truncated)</p> </details> <details> <summary>Commits</summary> <ul> <li><a href="6303aa2fd8"><code>6303aa2</code></a> 2.1.5</li> <li><a href="29e93e539f"><code>29e93e5</code></a> 2.1.4</li> <li><a href="6690566c65"><code>6690566</code></a> 2.1.3</li> <li><a href="fce1df0811"><code>fce1df0</code></a> 2.1.2</li> <li><a href="92c1a65d97"><code>92c1a65</code></a> Update dev-dependencies</li> <li><a href="b09a5e4995"><code>b09a5e4</code></a> 2.1.1</li> <li><a href="b8a76c95de"><code>b8a76c9</code></a> 2.1.0</li> <li><a href="46fae4fcd0"><code>46fae4f</code></a> Update dev-dependencies</li> <li><a href="490da9f41e"><code>490da9f</code></a> 2.0.0</li> <li><a href="adc64ecb8e"><code>adc64ec</code></a> Update things for v2 (<a href="https://github.com/mdx-js/mdx/tree/HEAD/packages/react/issues/1926">#1926</a>)</li> <li>Additional commits viewable in <a href="https://github.com/mdx-js/mdx/commits/2.1.5/packages/react">compare view</a></li> </ul> </details> <details> <summary>Maintainer changes</summary> <p>This version was pushed to npm by <a href="https://www.npmjs.com/~wooorm">wooorm</a>, a new releaser for <code>@mdx-js/react</code> since your current version.</p> </details> <br /> [](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 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.
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).