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

DAEXT

<p>Ultimate Markdown is a plugin for WordPress that allows you to create WordPress posts with the popular Markdown syntax.</p>
<p>Specifically, after installing the plugin, you will be able to:</p>
<ul>
<li>Create posts with perfectly formatted blocks from existing Markdown files or Markdown documents created with the plugin.</li>
<li>Instantly generate blocks from Markdown text.</li>
<li>Create and manage an unlimited number of Markdown documents in a dedicated plugin menu.</li>
<li>Import Markdown file in WordPress.</li>
<li>Create archives of Markdown files from the Markdown documents created with the plugin.</li>
</ul>
<p>Please note that this plugin requires the use of the default <a href="https://wordpress.org/support/article/blocks/">WordPress Blocks Editor</a>. With third-party visual editors or with the <a href="https://wordpress.org/plugins/classic-editor/">Classic Editor</a>, you will not be able to use most of the plugin functionalities.</p>
<h3>Pro Version</h3>
<p>We distribute the <a href="https://daext.com/ultimate-markdown/" rel="nofollow ugc">Pro version</a> of this plugin that includes more export options, REST API, additional Markdown parsers, document categories, and more.</p>
<h3>Additional post sidebar sections</h3>
<p>The plugin adds the following sections to the post sidebar.</p>
<h4>Import Markdown</h4>
<p>This section allows you to generate the blocks of a post from an uploaded Markdown file.</p>
<h4>Load Markdown</h4>
<p>Use this feature to create the blocks of a post from a Markdown document previously created with the plugin.</p>
<h4>Submit Markdown</h4>
<p>With this section, you can instantly transform Markdown text to blocks.</p>
<h3>Dedicated plugin menus</h3>
<h4>Documents</h4>
<p>This menu includes a Markdown editor with an HTML preview section. In addition, you will find functionalities to create, edit, duplicate or delete your Markdown documents.</p>
<h4>Import</h4>
<p>Import one or more Markdown files in the plugin with the upload form provided in this menu.</p>
<h4>Export</h4>
<p>With this menu, you can generate Markdown files from the Markdown documents stored in the plugin.</p>
<h3>Supported Markdown syntax</h3>
<p>The conversion from Markdown text to HTML is performed with <a href="https://github.com/markedjs/marked" rel="nofollow ugc">Marked</a>, a high-performance Markdown parser that supports documents written in the following <a href="https://github.com/commonmark/commonmark-spec/wiki/Markdown-Flavors" rel="nofollow ugc">Markdown flavors</a>.</p>
<h3>Front Matter</h3>
<p>The plugin supports Front Matter key-value pairs provided in the <a href="https://yaml.org/" rel="nofollow ugc">YAML</a> language. With this feature, you can configure specific post settings by providing their values at the beginning of the Markdown document.</p>
<p>Please see the <a href="https://daext.com/doc/ultimate-markdown/" rel="nofollow ugc">plugin documentation</a> for more information on the available Front Matter keys and practical examples.</p>
<h3>Credits</h3>
<p>This plugin makes use of the following resources:</p>
<ul>
<li><a href="https://github.com/cure53/DOMPurify" rel="nofollow ugc">DOMPurify</a> licensed under the <a href="https://www.apache.org/licenses/LICENSE-2.0" rel="nofollow ugc">Apache License Version 2.0</a></li>
<li><a href="https://github.com/markedjs/marked" rel="nofollow ugc">Marked</a> licensed under the <a href="http://www.opensource.org/licenses/mit-license.php" rel="nofollow ugc">MIT License</a></li>
<li><a href="https://github.com/select2/select2" rel="nofollow ugc">Select2</a> licensed under the <a href="http://www.opensource.org/licenses/mit-license.php" rel="nofollow ugc">MIT License</a></li>
<li><a href="https://getcomposer.org/" rel="nofollow ugc">Composer</a> licensed under the <a href="http://www.opensource.org/licenses/mit-license.php" rel="nofollow ugc">MIT License</a></li>
<li><a href="https://github.com/thephpleague/html-to-markdown" rel="nofollow ugc">HTML To Markdown for PHP</a> licensed under the <a href="http://www.opensource.org/licenses/mit-license.php" rel="nofollow ugc">MIT License</a></li>
<li><a href="https://github.com/mnapoli/FrontYAML" rel="nofollow ugc">FrontYAML</a> licensed under the <a href="http://www.opensource.org/licenses/mit-license.php" rel="nofollow ugc">MIT License</a></li>
</ul>


Ultimate Markdown

Using Markdown with Gutenberg is quite difficult. Markdown block from Jetpack is very limited, plugins proposing to edit in Markdown in a separate editor miss blocks philosophy.
As I prefer to work with my favorite Markdown Editor, Ultimate Markdown is a nice solution : it can import Markdown text in the post and convert the different elements in the relative block. A text paragraph will be a block text, a list a block list and so on. So the result is a real Gutenberg content.

The downside : you cannot convert back to Markdown the post content but it’s not a big deal for me.

Interesting management of Markdown

Ultimate Markdown is a plugin for WordPress that allows you to create WordPress posts with…

Git it Write – Write posts from GitHub vs Ultimate Markdown