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.

Jason Bahl

Tyler

Gatsby Inc

<a href="https://github.com/gatsbyjs/wp-gatsby/blob/master/license.txt" rel="nofollow ugc">
 </a> 
 <a href="https://twitter.com/intent/follow?screen_name=gatsbyjs" rel="nofollow ugc">
 </a>

WPGatsby is a free open-source WordPress plugin that optimizes your WordPress site to work as a data source for <a href="https://www.gatsbyjs.com/docs/how-to/sourcing-data/sourcing-from-wordpress" rel="nofollow ugc">Gatsby</a>.
This plugin must be used in combination with the npm package <a href="https://www.npmjs.com/package/gatsby-source-wordpress" rel="nofollow ugc"><code>gatsby-source-wordpress@^4.0.0</code></a>.
<h3>Install and Activation</h3>
WPGatsby is available on the WordPress.org repository and can be installed from your WordPress dashboard, or by using any other plugin installation method you prefer, such as installing with Composer from wpackagist.org.
<h3>Plugin Overview</h3>
This plugin has 2 primary responsibilities:
<ul>
<li><a href="https://github.com/gatsbyjs/wp-gatsby/blob/master/docs/action-monitor.md" rel="nofollow ugc">Monitor Activity in WordPress to keep Gatsby in sync with WP</a></li>
<li><a href="https://github.com/gatsbyjs/gatsby/blob/master/packages/gatsby-source-wordpress/docs/tutorials/configuring-wp-gatsby.md#setting-up-preview" rel="nofollow ugc">Configure WordPress Previews to work with Gatsby</a></li>
</ul>
Additionally, WPGatsby has a settings page to connect your WordPress site with your Gatsby site:
<ul>
<li><a href="https://github.com/gatsbyjs/gatsby/blob/master/packages/gatsby-source-wordpress/docs/tutorials/configuring-wp-gatsby.md" rel="nofollow ugc">WPGatsby Settings</a></li>
</ul>

WPGatsby

The combination of WordPress with Gatsby is a game-changer for multiple reasons. This plugin is the perfect glue for that combination, along with WPGraphQL!

I have been following the development of this plugin from early on. The folks at Gatsby – Jason, Tyler have worked super hard on this plugin – and the results speak for themselves!

Jamstack with WP and Gatsby is my go-to stack for when someone needs a fast site. I couldn't be happier to see this plugin on the repo, making blazing fast sites accessible for more folks getting into this stack!

Thanks so much to Gatsby folks and the whole community for putting out amazing work and keeping the community strong and helpful!

To infinity and beyond! 🚀

WP + Gatsby = ❤️

This plugin (along with Gatsby Cloud) got incremental builds working on our Gatsby/WordPress integration. It cut the build time down from ~2 minutes to ~10 seconds.

Along with the new gatsby-source-wordpress-experimental Gatsby plugin, the plugin imports links and images from WordPress to your Gatsby site.

Thanks for all of the hard work!

⚡️ Supercharge your Gatsby + WordPress integration

WPGatsby is a free open-source WordPress plugin that optimizes your WordPress site to work as a data source for Gatsby. This plugin must be used in c …

WP Gatsby Markdown Exporter vs WPGatsby