vaakash

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.
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.
👓 Live example: <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>
⚡ Getting started: <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.
This allows people to collaborate with the post, share edits and suggestions in GitHub which when pulled the WordPress post will be updated automatically.
If a repository has files in the below structure,
<pre><code>docs/
 guide/
 introduction.md
 getting-started.md
help/
 faq.md
</code></pre>
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))
<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>
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.
<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

mitchmac

The plugin creates zip files containing posts converted to Markdown. A WP-CLI command exists to handle exporting sites with a large amount of content.
<ul>
<li>Move WordPress content to Gatsby-friendly Markdown.</li>
<li>Customize the export! Remap and restructure exported fields.</li>
<li>CLI: Avoid PHP timeouts by using the command line with WP-CLI.</li>
<li>CLI: Export progress bar (great for large sites)!</li>
</ul>
<blockquote>
Reminder: always keep a backup of the WordPress database and files in case your export doesn’t work as expected!
</blockquote>
<h3>Working with Gatsby</h3>
If you’re just getting started with Gatsby, we recommend experimenting with a Markdown based Gatsby starter like <a href="https://github.com/tinacms/tina-starter-grande" rel="nofollow ugc">Tina Grande</a>. Installation is as easy as:
<pre><code>git clone https://github.com/tinacms/tina-starter-grande.git

cd tina-starter-grande

yarn install && gatsby develop
</code></pre>
Then copy your exported WordPress Markdown into the <code>content</code> directory or point the wp gatsby-markdown-export command at the content directory.
Want to port your WordPress or HTML theme to Gatsby? Checkout <a href="https://www.gatsbyjs.org/docs/porting-an-html-site-to-gatsby/" rel="nofollow ugc">Porting an HTML Site to Gatsby</a> for tips.
<h3>Command Line Usage</h3>
The command line functionality uses WP-CLI to interact with WordPress. <a href="https://wp-cli.org/#installing" rel="nofollow ugc">WP-CLI is easy to install</a> if you haven’t already.
Once it’s installed, you can export content to a directory like this:
<pre><code>wp gatsby-markdown-export --directory=/example/gatsby-starter/src/content
</code></pre>
All CLI arguments are optional.
 Option 
 Description 
 Default value
 <code>--help</code> 
 get help
 <code>--directory=</code> 
 export output directory 
 random temp directory
 <code>--post_types=</code> 
 post types to export, see: https://developer.wordpress.org/reference/classes/wp_query/#post-type-parameters 
 page,post
 <code>--post_status=</code> 
 post status to export, see: https://developer.wordpress.org/reference/classes/wp_query/#status-parameters 
 any
 <code>--fields_to_markdown=</code> 
 fields to convert to Markdown 
 excerpt
 <code>--excluded_front_matter=</code> 
 fields to exclude from front matter
 <code>--post_date_format=</code> 
 format for post publish date, see: https://www.php.net/manual/en/function.date.php 
 c
 <code>--upload_dir=</code> 
 directory in the export to copy WordPress uploads 
 uploads
 <code>--remap_fields=</code> 
 remap front matter field names, example: find1,replace1;find2,replace2
 <code>--fields_to_array=</code> 
 convert single value front matter fields to arrays
 <code>--include_private_fields=</code> 
 private post meta fields to include (they start with _)
 <code>--skip_copy_uploads</code> 
 flag, skips copying WordPress uploads to the export
 <code>--skip_original_images</code> 
 flag, skips the use of original dimension images
 <code>--skip_enforce_charset</code> 
 flag, skips use of blog_charset for the XML charset
 <code>--create_type_directory</code> 
 flag, creates directories based on post type

WP Gatsby Markdown Exporter

Export WordPress content to Markdown for GatsbyJS.

Git it Write – Write posts from GitHub vs WP Gatsby Markdown Exporter