Skip to content

Commit

Permalink
chore: publish v2.1.0 of remark-mermaid-dataurl
Browse files Browse the repository at this point in the history
Added
=====

- Add TypeScript types to `remark-mermaid-dataurl`
- Use Mermaid titles/descriptions for the output markdown image's
  title/alt-text, e.g. like:

  ```markdown
  ![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` and `vfile` 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.

Signed-off-by: Alois Klink <[email protected]>
  • Loading branch information
aloisklink committed May 10, 2023
1 parent 57bec7e commit 40eed00
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 3 deletions.
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

## [Unreleased]

## [2.1.0] - 2023-05-10

### Added

- Add TypeScript types to `remark-mermaid-dataurl`
Expand Down
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "remark-mermaid-dataurl",
"version": "2.0.7",
"version": "2.1.0",
"description": "A remark plugin for Markdown that replaces mermaid graphs with dataurls",
"main": "index.js",
"scripts": {
Expand Down

0 comments on commit 40eed00

Please sign in to comment.