Rich Tabor

<h3>Comments that only render in the block editor</h3>
<p>I honestly enjoy drafting articles either locally in Ulysses, or on <a href="https://richtabor.com" rel="nofollow ugc">my blog</a> using the <a href="https://useiceberg.com/?utm_source=wp-org&utm_medium=markdown-comment-block&utm_campaign=readme-description" rel="nofollow ugc">Iceberg Editor</a>. While I do love Iceberg, once I publish an article I typically bring back the default Gutenberg experience — thus removing any comments I previously added.</p>
<p>Having the ability to add, and keep, any relevant editing comments within my posts, without rendering them on the front-end, means that I am freed up to mentally jot any idea down without thinking about it. It is simply natural and convenient.</p>
<p><a href="https://richtabor.com/markdown-comments/?utm_source=wp-org&utm_medium=markdown-comment-block&utm_campaign=readme-learnmore" rel="nofollow ugc">Learn more about Markdown Comment →</a></p>
<h3>What’s interesting about Markdown Comment:</h3>
<h4>1. Editor only</h4>
<p>The block only renders within the editor. For developers reading this, that means there’s no save function. I don’t want my unfinished ideas, reminders, and notes rendered within my post – even if they’re hidden by CSS.</p>
<h4>2. Helpful block transforms</h4>
<p>I added a couple transforms, to and from headings and paragraphs, and a raw shortcut when you type <code>%%</code> and hit the [space] key. This lets me quickly add comments, and even convert whole paragraphs or headings to a comment.</p>
<h4>3. Easily resolve comments</h4>
<p>To support that path towards simplicity, I wanted a method to quickly resolve — i.e. banish — a comment entirely. So, I added a toolbar control to quickly resolve the comment, removing the block entirely.</p>
<h4>4. No rich text support</h4>
<p>Comments need to have minimal impact on editing, and feel as natural as possible. That’s why there are no typical RichText controls (although you can still bold, italicize and add hyperlinks). And while you <em>can</em> change the color of the comment — there are no other typographic controls.</p>
<h4>5. Entirely CSS Variable ready</h4>
<p>Global styles and full site editing are opening the door for themes to be heavily powered by CSS variables. Blocks should be designed with that same mentality, which is exactly what I did here. I added simple CSS variables with fallbacks that are the default values. To further theme the comment, there’s no need to override any styles with classes, just write a few CSS variables.</p>


Markdown Comment Block

Add markdown inspired comments to posts that render only within the block editor.

Terry L.

<p>Generation of diagrams and flowcharts from text in a similar manner as markdown by using <a href="https://mermaid.js.org/" rel="nofollow ugc">mermaid.js</a></p>
<p>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.</p>
<p>= See also</p>
<p>If you are looking for a <a href="https://github.com/terrylinooo/githuber-md" rel="nofollow ugc">Markdown editor</a> supporting Mermaid, you can also check out my WordPress plugin called the <a href="https://wordpress.org/plugins/wp-githuber-md/" rel="ugc">WP Githuber MD</a>, which provides a variety of features not just Mermaid, it is worth to try.</p>
<h3>Translations</h3>
<p>Chinese (zh_TW) by <a href="https://terryl.in/" rel="nofollow ugc">Terry L.</a>.<br />
Japanese (ja_JP) by <a href="https://colocal.com/" rel="nofollow ugc">Colocal</a>.</p>
<h3>Copyright</h3>
<p>WP Mermaid, Copyright 2020 TerryL.in<br />
WP Mermaid is distributed under the terms of the GNU GPL</p>
<p>This program is free software: you can redistribute it and/or modify<br />
it under the terms of the GNU General Public License as published by<br />
the Free Software Foundation, either version 3 of the License, or<br />
(at your option) any later version.</p>
<p>This program is distributed in the hope that it will be useful,<br />
but WITHOUT ANY WARRANTY; without even the implied warranty of<br />
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the<br />
GNU General Public License for more details.</p>


WP Mermaid

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

Markdown Comment Block vs WP Mermaid