WP Mermaid

Description

Generation of diagrams and flowcharts from text in a similar manner as markdown by using mermaid.js

WP Mermaid is smart enough that loads mermaid.js only when your posts contain Mermaid syntax, by detecting the use of shortcode and block. So it will not be loaded on your website everywhere.

= See also

If you are looking for a Markdown editor supporting Mermaid, you can also check out my WordPress plugin called the WP Githuber MD, which provides a variety of features not just Mermaid, it is worth to try.

Translations

Chinese (zh_TW) by Terry L..
Japanese (ja_JP) by Colocal.

Copyright

WP Mermaid, Copyright 2020 TerryL.in
WP Mermaid is distributed under the terms of the GNU GPL

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.

Screenshots

  • Choose a Mermaid syntax block.
  • Fill in your Mermaid syntax in the editor.

Blocks

This plugin provides 2 blocks.

  • WP Mermaid
  • WP Mermaid

Installation

  1. Upload the plugin files to the /wp-content/plugins/wp-mermaid directory, or install the plugin through the WordPress plugins screen directly.
  2. Activate the plugin through the ‘Plugins’ screen in WordPress.
  3. Go to the WP Mermaid menu in Settings and set your options.

Shortcode

In classic editor, you can use shortcode to render your Mermaid syntax. If you are using WordPress version below 5.0, this is the only way you can use.

Gutenberg Block

  1. Choose a Mermaid syntax block.
  2. Fill in your Mermaid syntax in the editor.

FAQ

None.

Reviews

29 ธันวาคม 2023
No muss, no fuss. Just include a "WP Mermaid" block into your post, paste your Mermaid syntax, and see a live preview of the diagram right below!
24 มีนาคม 2023 3 replies
Not only is it a most useful plugin (going to use it on a project tracking site right now!) and kept up-to-date (just tested it fine on WP 6.2-RC4) but it is also a fantastic example block for us custom block newbies! Thanks for this!
22 กุมภาพันธ์ 2022
It works exactly as I like it: - It adds a new block type in gutenberg. - It shows the svg result except while editing the block where it shows both the source and the svg and updates the svg output after every keystroke. Nice work.
Read all 3 reviews

Contributors & Developers

“WP Mermaid” is open source software. The following people have contributed to this plugin.

Contributors

“WP Mermaid” has been translated into 3 locales. Thank you to the translators for their contributions.

Translate “WP Mermaid” into your language.

Interested in development?

Browse the code, check out the SVN repository, or subscribe to the development log by RSS.

Changelog

1.0.0

  • First release.

= 1.0.1

  • Upgrade Mermaid JavaScript library from 8.5.0 to 8.9.0

= 1.0.2

  • Test with PHP 8.2.5 and WordPress 6.2.2
  • Upgrade Mermaid JavaScript library from 8.9.0 to 9.4.3
  • Add Japanese translation.