Wealthy Tabor, the Senior Product Supervisor of WordPress Expertise at GoDaddy, tweeted that he had an idea for a brand new block on the finish of final week. Shortly after, the Markdown Comment Block plugin appeared on WordPress.org.
The plugin is a one-off block. It permits customers to enter notes straight into the put up editor that won’t seem on the entrance finish of the positioning. Tabor stated he got here up with the concept when engaged on an article for constructing single-block plugins.
There are few issues I really like greater than easy plugins with a good focus, performing a single perform. Markdown Remark Block lands on this class.
The plugin creates a brand new block that works almost the identical as a typical Paragraph block:
Customers can change the textual content coloration, however they won’t have entry to the standard Wealthy Textual content controls. These ought to be pointless anyway.
As somebody who does long-form writing nearly completely in Markdown, the block’s use of the double percent-sign syntax for feedback intrigued me. Technically, the Markdown spec doesn’t help any form of particular characters for them. It handles HTML feedback. Nonetheless, these seem within the supply code on the entrance finish when the doc is rendered. I’ve solely seen the
%% mark to indicate feedback within the Inspire Writer app for Home windows. Tabor stated he had seen the identical in Ulysses. The characteristic additionally exists within the Iceberg editor for WordPress, which Tabor created alongside Jeffrey Carandang.
The plugin additionally introduces the
%% keyboard shortcut. Typing it straight within the editor will create a brand new Markdown Remark block.
My major use case for the plugin can be leaving notes for my later self. Nonetheless, it may be useful in customers’ publishing flows. The block provides a “Resolve” button to the toolbar. Clicking it deletes the remark.
The block itself is not going to possible supply a sturdy sufficient characteristic set for advanced workflows. Nonetheless, pairing it with a plugin like Post Descriptions might spherical out the expertise for bigger groups of writers and copyeditors.
The Put up Descriptions plugin permits customers so as to add notes on the put up stage. These notes seem on the post-management display, letting different group members know when to examine an article. Nonetheless, it could be exhausting to offer the complete context of what points have to be resolved earlier than publishing. Markdown Remark Block provides an inline feedback system, letting group members move in-text notes.
Theme builders ought to respect that the block makes use of CSS customized properties too, which makes it straightforward to overwrite its default model guidelines. In moments, I used to be capable of make it match my theme:
--markdown-comment-color variables can be found for theme builders who wish to add in help.
The one criticism I had concerning the block is its title: “Remark.” It’s straightforward to confuse it with the six different comment-related blocks already within the WordPress block listing. And, there’ll solely be extra in upcoming variations. Giving it a title of “Markdown Remark” would higher distinguish it from others.