Releases: aloisklink/remark-mermaid-dataurl
v2.1.1
Fixed
- Fix missing
"types"
field inpackage.json
. Types should now be correctly exported. (3fd6c17)
Full Changelog: v2.1.0...v2.1.1
v2.1.0
Added
-
Add TypeScript types to
remark-mermaid-dataurl
-
Use Mermaid titles/descriptions for the output markdown image's title/alt-text, e.g. like:
![Mermaid diagram description](data:image/svg+xml;charset=UTF-8,%3Csvg%20id%3D%22mermaid-1654... "Mermaid diagram title")
See https://mermaid.js.org/config/accessibility.html for how to add titles and descriptions to your Mermaid diagrams.
Dependencies
- Add
@types/mdast
andvfile
as dependencies. We only use these for their types. - Updated
@mermaid-js/mermaid-cli
from^10.0.0
to^10.0.2
to use the types added by that release.
Full Changelog: v2.0.7...v2.1.0
v2.0.7
Fixed
- Fix minimum support Node versions to
^14.13 || >=16.0
. This was always the case, due to a transitive dependency viamermaid-cli
onchalk
. See mermaid-js/mermaid-cli@57781f7
.
Dependencies
-
Updated
@mermaid-js/mermaid-cli
from^9.1.6
to^10.0.0
in #130, see mermaid-js/[email protected] release notes and [email protected] release notes.It looks like the main breaking changes are to do with Mermaid's API, but there are no breaking changes to
mermaid-cli
, or this package.
Full Changelog: v2.0.6...v2.0.7
v2.0.6
Fixed
-
Fix undefined SVG
svgjs
namespace error
Sometimes, the generated SVGs are invalid due to an unknownsvgjs
prefix error (this happens withmermaid-mindmaps
), see svgdotjs/svg.js#1285.This work-around manually defines the XML
svgjs
namespace by addingxmlns:svgjs
to the<svg ...>
element until the upstream issue/bug is fixed.
Dependencies
- Updated puppeteer from
^18.0.4
to^19.0.0
Full Changelog: v2.0.5...v2.0.6
v2.0.5
Fixed
- Set mermaid config option
useMaxWidth
tofalse
by default.
In Mermaid v9.1.7, some graph types default to using all the available horizontal space. On many markdown renderers, this creates very large diagrams, so by defaultremark-mermaid-dataurl
limits them to use a smaller amount of space (e.g. pre-v9.1.7 behaviour). - Fix passing
configFile
as a JS object.
Full Changelog: v2.0.4...v2.0.5
v2.0.4
Performance
- Share a single puppeteer browser instance for all mermaid images.
9bccb09
Dependencies
- Updated puppeteer from
^16.0.0
to^18.0.4
Full Changelog: v2.0.3...v2.0.4
v2.0.3
Fixed
- Fixed some
mermaidCli
options being ignored in v2.0.2
Dependencies
- Updated
unist-util-visit
from^2.0.3
to^4.0.0
Full Changelog: v2.0.2...v2.0.3
v2.0.2
Fixed
- Fixed support for mermaid-cli
^9.1.6
Dependencies
- Updated
mermaid-cli
version to^9.1.6
- This increases the minimum version of
mermaid
to^9.1.6
, see
https://github.com/mermaid-js/mermaid/releases/tag/9.1.6
- This increases the minimum version of
- Removed unneeded dependency on
memfs
- Added dependency on puppeteer
^16.0.0
- puppeteer was previously a transitive dependency from
mermaid-cli
- puppeteer was previously a transitive dependency from
Full Changelog: v2.0.1...v2.0.2
v2.0.1
Fixed
- Fixed error handling for mermaid-cli
^9.1.4
.
Dependencies
- Updated
mermaid-cli
version to^9.1.4
- This increases the minimum version of
mermaid
to^9.1.3
, see https://github.com/mermaid-js/mermaid/releases/tag/9.1.3
- This increases the minimum version of
Full Changelog: v2.0.0...v2.0.1
v2.0.0
Breaking Changes
- NodeJS 14.1 is the minimum supported version
- The minimum version of
mermaid-cli
has been bumped to^9.1.2
.
This has caused the following BREAKING CHANGES:mermaid
is now version^9.0.0
- Full CHANGELOG
- BREAKING CHANGE:
gitGraph
's have been reinvented- The main branch is now called
main
, notmaster
. - Plus numerous other `gitgraph changes, please see mermaid release notes.
- The main branch is now called
puppeteer
is now version^14.1.0
- BREAKING CHANGE: NodeJS 14 is the minimum supported version now.
Dependencies
- Updated
mermaid-cli
version to^9.1.2