Evan Solomon

<p>Comment forms allow some HTML, this plugin extends that to let users type in <a href="http://daringfireball.net/projects/markdown/" rel="nofollow ugc">Markdown</a> and have it automatically converted to HTML.  It also extends Markdown with a couple features made popular <a href="https://github.com/github/github-flavored-markdown" rel="nofollow ugc">by GitHub</a>.  Conversion from Markdown to HTML is completely automated and doesn’t require anything on the commenter’s part.</p>
<p>The feature additions from GitHub are:</p>
<ul>
<li>Single linebreaks are treated as new paragraphs</li>
<li>Code “fencing” with three backticks (“`)</li>
</ul>
<p>Two notable features from GitHub’s Markdown implementation are missing:</p>
<ul>
<li>To do lists: Doing these well would require some front end interaction, which I decided is outside the scope of this plugin at least for now</li>
<li>Repository autolinking (e.g. comments, issues, etc): These seemed a little <em>too</em> GitHub-specific.</li>
</ul>
<p>GitHub-Flavored Markdown Comments is developed, unsurprisingly, <a href="https://github.com/evansolomon/wp-github-flavored-markdown-comments" rel="nofollow ugc">on GitHub</a>.</p>


GitHub-Flavored Markdown Comments

WordPress plugin to let commenters use (GitHub-flavored) Markdown, and turn it into HTML.

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.

GitHub-Flavored Markdown Comments vs Markdown Comment Block