Isamu Takeda

<p>This block has the function of editing Markdown documents using SimpleMDE, and by parsing Markdown documents using marked, it can assign specific blocks to the converted HTML elements.<br />
This function allows users to customize Markdown documents using the styling functions of the corresponding blocks, allowing for a wide range of styling.<br />
The following are the blocks that are applied when Markdown documents are parsed into HTML elements.</p>
<ol>
<li>H element: itmar/design-title</li>
<li>P element: core/paragraph</li>
<li>PRE element: itmar/code-highlight</li>
<li>IMG element: core/image</li>
<li>BLOCKQUOTE element: core/quote</li>
<li>LI element: core/list</li>
<li>TABLE element: core/table</li>
</ol>
<p>The H element is also generated as a table of contents, and has the function of displaying nested items according to level.<br />
This plugin does not require any external resources (all scripts and styles are included locally)</p>
<h3>Related Links</h3>
<ul>
<li><a href="https://github.com/itmaroon/markdown-block" rel="nofollow ugc">markdown-block:Github</a></li>
<li><a href="https://github.com/itmaroon/block-class-package" rel="nofollow ugc">block-class-package:GitHub</a>  </li>
<li><a href="https://packagist.org/packages/itmar/block-class-package" rel="nofollow ugc">block-class-package:Packagist</a> </li>
<li><a href="https://www.npmjs.com/package/itmar-block-packages" rel="nofollow ugc">itmar-block-packages:npm</a>  </li>
<li><a href="https://github.com/itmaroon/itmar-block-packages" rel="nofollow ugc">itmar-block-packages:GitHub</a></li>
</ul>
<h3>Arbitrary section</h3>
<ol>
<li>
<p>PHP class management is now done using Composer.<br />
<a href="https://github.com/itmaroon/block-class-package" rel="nofollow ugc">GitHub</a><br />
<a href="https://packagist.org/packages/itmar/block-class-package" rel="nofollow ugc">Packagist</a></p>
</li>
<li>
<p>I decided to make functions and components common to other plugins into npm packages, and install and use them from npm.<br />
<a href="https://www.npmjs.com/package/itmar-block-packages" rel="nofollow ugc">npm</a><br />
<a href="https://github.com/itmaroon/itmar-block-packages" rel="nofollow ugc">GitHub</a></p>
</li>
</ol>
<h3>External services</h3>
<ol>
<li>This plugin uses EasyMDE to implement the editing function of Markdown documents. This is an open source JavaScript library provided under the MIT license.<br />
<a href="https://github.com/Ionaru/easy-markdown-editor/blob/master/LICENSE" rel="nofollow ugc">EasyMDE LICENSE</a><br />
EasyMDE comes with a spell check feature.<br />
When using this feature, it will try to load an external file (en_US.aff / en_US.dic) from a CDN. To avoid this, this plugin sets spellChecker: false, when instantiating EasyMDE, so that the external file will not be loaded.</li>
<li>This plugin uses marked to parse Markdown documents and convert them to HTML elements. This is an open source JavaScript library provided under the MIT license.<br />
<a href="https://github.com/markedjs/marked/blob/master/LICENSE.md" rel="nofollow ugc">marked LICENSE</a></li>
</ol>


MarkDown Block

This block converts Markdown documents into blocks for styling web pages.

vaakash

<p>Git it Write allows to publish the markdown files present in a GitHub repository to your WordPress site. So with this plugin, whenever the files are added, updated in the repository the WordPress post will be added, updated accordingly.</p>
<p>This plugin is inspired from static site generators like <code>Jekyll</code>, <code>Next.js</code>, <code>Gatsby.js</code> on how content is written is markdown. This is a similar idea for WordPress where markdown files are parsed from GitHub and published as posts.</p>
<p>👓 <strong>Live example:</strong> <a href="https://github.com/vaakash/aakash-web" rel="nofollow ugc">Source github repository</a> (<code>/docs/</code> folder) to <a href="https://www.aakashweb.com/docs/" rel="nofollow ugc">Posts published</a></p>
<p>⚡ <strong>Getting started:</strong> <a href="https://www.aakashweb.com/docs/git-it-write/getting-started/" rel="nofollow ugc">Get started</a> with Git it write. Learn how to write <code>.md</code> files and publish posts on WordPress.</p>
<p>This allows people to collaborate with the post, share edits and suggestions in GitHub which when pulled the WordPress post will be updated automatically.</p>
<p>If a repository has files in the below structure,</p>
<pre><code>docs/
    guide/
        introduction.md
        getting-started.md
help/
    faq.md
</code></pre>
<p>Then below posts will be created like below (if permalinks are configured and the post type supports “hierarchy” i.e creating posts level by level (example: pages))</p>
<pre><code>https://example.com/docs/guide/introduction/
https://example.com/docs/guide/getting-started/
https://example.com/help/faq/
</code></pre>
<h3>🎲 What is the use of this plugin ?</h3>
<ul>
<li>Publish posts using the files in your GitHub repository.</li>
<li>Write your posts in Markdown format.</li>
<li>Write your posts on your desktop application (Notepad++, Sublime Text, Visual studio code).</li>
<li>Collaborate, involve communities on the files in GitHub and publish them on WordPress.</li>
<li>All the advantages of Git and it’s version management system.</li>
</ul>
<h3>🚀 Some use cases</h3>
<ul>
<li>Can be used for documentation posts, FAQs, Wikis etc.</li>
<li>Write blog posts.</li>
<li>Any articles which may need community involvement.</li>
</ul>
<h3>✨ Features</h3>
<ul>
<li>Markdown will be processed and post will be published as HTML.</li>
<li>Images used in the source file will be uploaded to WordPress.</li>
<li>Relative links are supported.</li>
<li>Set post properties like post status, title, order, category, tags etc, in the source file itself.</li>
<li>Webhook support (whenever repository is changed, it updates the plugin to pull the latest changes and publish the posts)</li>
<li>Add multiple repositories.</li>
<li>Publish to any post type.</li>
<li>Posts are published in hierarchial manner if they are under folders. Example: a file <code>dir1/hello.md</code> will be posted as <code>dir1/hello/</code> in WordPress if the post type supports hierarchy.</li>
<li>Support for post metadata like setting tags, categories, custom fields.</li>
</ul>
<h3>ℹ Note</h3>
<ul>
<li>Only Markdown files will be pulled and published right now</li>
<li>Posts won’t be deleted when it’s source file is deleted on GitHub.</li>
<li>It is preferred to have a permalink structure.</li>
<li>It is preferred to select a post type which supports hierarchy.</li>
<li>Images have to present only in <code>_images</code> folder in the repository root. Markdown files have to relatively use them in the file.</li>
</ul>
<h3>🥗 Recommendation</h3>
<p>It is recommended that a permalink structure is enabled in the WordPress site so that, if you have file under <code>docs/reference/my-post.md</code> then a post is published like <code>https://example.com/docs/reference/my-post/</code>. This will be the result when post type has hierarchy support. They will be posted level by level for every folder in the repository. The folder’s post will be taken from the <code>index.md</code> file if exists under that folder.</p>
<h3>🏃‍♂️ Using the plugin</h3>
<ol>
<li>Have a GitHub repository where all the source files (markdown files) are maintained (organized in folders if needed the exact structure)</li>
<li>In the plugin settings page, click add a new repository.</li>
<li>Enter the details of the repository to pull the posts from and under what post type to publish them.</li>
<li>Save the settings</li>
<li>Click “Pull the posts” and then “Pull only” changes. This will publish posts for all the markdown files.</li>
<li>To automatically update posts whenever repository is updated, configure webhook as mentioned in the settings page.</li>
</ol>
<h3>Links</h3>
<ul>
<li><a href="https://www.aakashweb.com/docs/git-it-write/" rel="nofollow ugc">Documentation</a></li>
<li><a href="https://www.aakashweb.com/forum/" rel="nofollow ugc">Support forum/Report bugs</a></li>
<li><a href="https://www.paypal.me/vaakash/" rel="nofollow ugc">Donate</a></li>
<li><a href="https://github.com/vaakash/git-it-write" rel="nofollow ugc">Contribute on GitHub</a></li>
</ul>


Git it Write – Write posts from GitHub

You will like it !

Publish markdown files present in a GitHub repository as posts to WordPress automatically

MarkDown Block vs Git it Write – Write posts from GitHub