Bump go.abhg.dev/goldmark/mermaid from 0.4.0 to 0.5.0

[dependabot]

Bumps go.abhg.dev/goldmark/mermaid from 0.4.0 to 0.5.0.

Release notes

Sourced from go.abhg.dev/goldmark/mermaid's releases.

v0.5.0 - 2023-11-03

This release brings support for rendering diagrams server-side without the need for the MermaidJS CLI.

You can use this functionality by installing a mermaidcdp.Compiler into your mermaid.Extender or mermaid.ServerRenderer. For example:

import "go.abhg.dev/goldmark/mermaid/mermaidcdp"
compiler, err := mermaidcdp.New(&mermaidcdp.Config{
JSSource: mermaidJSSource, // contents of mermaid.min.js
})
if err != nil {
return err
}
defer compiler.Close()
md := goldmark.New(
goldmark.WithExtensions(
// ...
&mermaid.Extender{
Compiler: compiler,
},
),
// ...
)

Use of mermaidcdp is highly recommended for server-side rendering if you have lots of diagrams or documents to render. This should be substantially faster than invoking the mmdc CLI.

Breaking changes

• ServerRenderer: Delete MMDC and Theme fields. If you need these, you can provide them with the CLICompiler instead.
• CLI and MMDC were flipped. The old MMDC interface is now named CLI, and it now accepts a context. You can use the new MMDC function to build an instance of it.
• ClientRenderer, Extender: Rename MermaidJS to MermaidURL.
• Rename DefaultMMDC to DefaultCLI.
• Extender: Replace MMDC field with the CLI field.

Added

• ServerRenderer now supports pluggable Compilers.
• Add CLICompiler to render diagrams by invoking MermaidJS CLI. Plugs into ServerRenderer.
• Add mermaidcdp subpackage to render diagrams with a long-running Chromium-based process. Plugs into ServerRenderer.

Changelog

Sourced from go.abhg.dev/goldmark/mermaid's changelog.

v0.5.0 - 2023-11-03

This release brings support for rendering diagrams server-side without the need for the MermaidJS CLI.

You can use this functionality by installing a mermaidcdp.Compiler into your mermaid.Extender or mermaid.ServerRenderer. For example:

import "go.abhg.dev/goldmark/mermaid/mermaidcdp"
compiler, err := mermaidcdp.New(&mermaidcdp.Config{
JSSource: mermaidJSSource, // contents of mermaid.min.js
})
if err != nil {
return err
}
defer compiler.Close()
md := goldmark.New(
goldmark.WithExtensions(
// ...
&mermaid.Extender{
Compiler: compiler,
},
),
// ...
)

Use of mermaidcdp is highly recommended for server-side rendering if you have lots of diagrams or documents to render. This should be substantially faster than invoking the mmdc CLI.

Breaking changes

• ServerRenderer: Delete MMDC and Theme fields. If you need these, you can provide them with the CLICompiler instead.
• CLI and MMDC were flipped. The old MMDC interface is now named CLI, and it now accepts a context. You can use the new MMDC function to build an instance of it.
• ClientRenderer, Extender: Rename MermaidJS to MermaidURL.
• Rename DefaultMMDC to DefaultCLI.
• Extender: Replace MMDC field with the CLI field.

Added

• ServerRenderer now supports pluggable Compilers.
• Add CLICompiler to render diagrams by invoking MermaidJS CLI. Plugs into ServerRenderer.
• Add mermaidcdp subpackage to render diagrams with a long-running Chromium-based process. Plugs into ServerRenderer.

Commits

• 061ebbe Release v0.5.0 (#59)
• 7bedfa2 Add CDP-based server-side rendering (#58)
• 9383d1d README: Use stitchmd (#57)
• 178efc0 test(integration): Fix not being run, use latest Mermaid (#56)
• 8f072fc build(deps): bump github.com/yuin/goldmark from 1.5.6 to 1.6.0 in /demo (#55)
• ccdedec build(deps): bump actions/setup-node from 3 to 4 (#54)
• 13d7b46 lint: Drop paralleltest
• 4999223 build(deps): bump golang.org/x/tools from 0.13.0 to 0.14.0 in /tools (#53)
• 02e3e97 fix(lint/typo): linter-settings => linters-settings (#52)
• 1549213 build(deps): bump golang.org/x/tools from 0.12.0 to 0.13.0 in /tools (#51)
• Additional commits viewable in compare view

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 commands and options

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)