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

Terry L.

<p>An all-in-on WordPress Markdown Plugin provides a variety of features such as Markdown editor, live-preview, image-paste, HTML-to-Markdown helper, and more..</p>
<p>Read detailed document, please visit <a href="https://github.com/terrylinooo/githuber-md" rel="nofollow ugc">https://github.com/terrylinooo/githuber-md</a>.</p>
<h3>Demo</h3>
<p><iframe loading="lazy" title="WordPress Markdown Plugin - WP Githuber MD - DEMO" width="750" height="422" src="https://www.youtube.com/embed/it1noNCTXa4?feature=oembed" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen></iframe></p>
<p>The Video shows you the following steps:</p>
<ol>
<li>Convert HTML to Markdown by using <code>HTML to Markdown</code> tool.</li>
<li>Cut up a selection area of an image and copy it from Photoshop, then paste it to Markdown Editor.</li>
<li>Click “Update” button to save Markdown to <code>post_content_filtered</code> and save HTML to <code>post_content</code> (it is what you will see in result).</li>
<li>View the result.</li>
</ol>
<h3>How it works</h3>
<ol>
<li>WP Githuber MD will save your Markdown content into <code>wp_posts</code>.<code>post_content_filtered</code>.</li>
<li>Parse the Markdown to HTML, save the parsed HTML content into <code>wp_posts</code>.<code>post_content</code>.</li>
</ol>
<p>This plugin will detect your Markdown content and decide what scripts will be loaded, to avoid loading unnecessary scripts.<br />
For example, if you enabled Syntax highlight, you have to update your post again to take effects.</p>
<h3>Suggestions</h3>
<p>The better situation to use this plugin is you just started a new blog.</p>
<p>If you’re planning to use this plugin in an existing blog, be sure to:</p>
<ul>
<li>Turn off other Markdown plugins, because the similar plugins might do the same things when submitting your posts, may have some syntax conversion issues between Markdown and HTML.</li>
<li>My suggestion is to turn off revision and auto-save, there are options in setting page.</li>
</ul>
<h3>Features</h3>
<ul>
<li><a href="https://markdown-editor.github.io/" rel="nofollow ugc">Markdown editor</a>.</li>
<li>Live preview.</li>
<li>Spell check.</li>
<li>Enable / disable Markdown for single post.</li>
<li>Support Gutenberg editor.</li>
<li>Support custom post types.</li>
<li>Support Markdown extra syntax.</li>
<li>HTML-to-Markdown tool.</li>
<li>Image copy & paste (support uploading to Imgur.com and sm.ms)</li>
<li>Highlight code syntax. (prism.js or hightlight.js)</li>
<li>Flow chart.</li>
<li>KaTex.</li>
<li>Sequence diagram.</li>
<li>Mermaid.</li>
<li>MathJax.</li>
<li>Emoji.</li>
<li>Github flavored Markdown task list.</li>
<li>Fetch remote images.</li>
<li>Keyword suggestion tool.</li>
<li>and more…</li>
</ul>
<h3>Translations</h3>
<p>English (en_US) by <a href="https://colocal.com/" rel="nofollow ugc">Colocal</a>.<br />
Traditional Chinese (zh_TW) by <a href="https://www.alexclassroom.com/" rel="nofollow ugc">Alex Lion</a>.<br />
Simplified Chinese (zh_CN) by <a href="https://terryl.in/zh/" rel="nofollow ugc">Terry Lin</a>.</p>
<h3>Copyright</h3>
<p>WP Githuber MD, Copyright 2018-2020 TerryL.in<br />
WP Githuber MD 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 Githuber MD – WordPress Markdown Editor

I would love to give five stars but the developer decided that all URL text should be interpreted. It’s not the way Markdown is working and it breaks the very convenient feature that convert Youtube URL to video in WP. And all embeds feature I presume.

Not compatible with useful WP features


Undoubtedly the best plugin available, and well done too. However, some buttons (e.g. search, h5-h6, clear) present in other similar plugins were missing, so much so that I had to insert them manually, not with little trouble. Therefore, the inclusion of an option to choose the buttons to insert in the toolbar is welcome, or even just a filter that allows you to do so from the theme's functions.php. :-)



Another thing missing is the preview of the highlight themes for code. But it is certainly a minor aspect.


Best plugin but...

An all-in-on WordPress Markdown Plugin provides a variety of features such as Markdown editor, live-preview, image-paste, HTML-to-Markdown helper, and …

Git it Write – Write posts from GitHub vs WP Githuber MD – WordPress Markdown Editor