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

Rich Tabor

<h4>Editor-friendly blocks</h4>
<p>While diving into this project I’ve explored a few areas where I can improve my personal publishing flow. The first was bringing editor comments into Gutenberg with my <a href="https://richtabor.com/markdown-comment/?utm_source=wp-org&utm_medium=todo-list-block&utm_campaign=readme" rel="nofollow ugc">Markdown Comment block</a>, and this Todo List block.</p>
<p>Todo List is a simple, editor-only block designed to quickly add tasks directly within the editor.</p>
<p>Todo List makes it easy to keep track of those tasks, all in the context of a particular post. You may also use it to add a publishing checklist to the post, such as using a headline analyzer, adding featured images, adding social images, etc.</p>
<h4>Transforms</h4>
<p>I’m a huge fan of blocks transforms and how they improve the WordPress publishing experience. Being able to morph a block into another, without loosing content/attributes, is a powerful way to level-up editing.</p>
<p>That saying, you may transform paragraph text, list items and even editorial comments added by Markdown Comment directly into actionable todos, just like you can in the iOS Notes app for example. You may even take multiple blocks of the sort and convert them all into a single todo list.</p>
<p>Todo List also supports block prefixes, which are keyboard shortcuts in a sense, to toss blocks in the editor with a few keystrokes. Adding <code>[]</code>, or <code>-[]</code> plus the <code>space</code> key will add a Todo List to the page.</p>


Todo List Block

It works as advertised, I just wish there were some more features such as:

- Font size & font color options (per list item).
- Option to also display on the front end.
- Option to indent each list item, so we can have "category" items. This (maybe) would  not be necessary if we had the choice to change the font color and size per list item.

On the other hand, this plugin as it is, is still very useful, and the zip file is only 16kb, so adding things in and multiplying the file size by a a lot, may be it won't be worth it.

Nevertheless, I am sticking to my 5 star rating for this.

Good Start.

Add todo lists to posts that render only within the block editor.

Git it Write – Write posts from GitHub vs Todo List Block