/wordpress-to-markdown

A WP-CLI script to convert WordPress content to Markdown

Primary LanguagePHPGNU General Public License v3.0GPL-3.0

WordPress to Markdown

A WP-CLI command to convert WordPress content to Markdown files.

Requirements

  • WordPress
  • PHP 7.0
  • WP-CLI

Getting Started

You'll need WP-CLI installed and ready to use. Go to your WordPress's root directory (where wp-config.php is located) and run the following command:

❯ wp --version
WP-CLI 2.4.0

The best way to install this command is in your /wp-content/mu-plugins directory. First, clone this repo:

# From the WordPress root ...
❯ git clone git@github.com:joshcanhelp/wordpress-to-markdown.git wp-content/mu-plugins/wp-to-md
# ... or https://github.com/joshcanhelp/wordpress-to-markdown.git

Cloning into 'wp-content/mu-plugins/wp-to-md'...
# ... etc ...

Then add a file to include the command if WP-CLI is active.

❯ composer install -d wp-content/mu-plugins/wp-to-md
❯ echo "<?php if ( class_exists( 'WP_CLI' ) ) require_once 'wp-to-md/wp-to-md.php';" > wp-content/mu-plugins/wp-to-md.php
❯ wp wptomd-types
post
page
attachment

Look at the /filters folder for examples showing how to adjust the content and meta specially for your site. Once you're ready:

❯ wp wptomd /path/to/output
Output dir: /path/to/output/
Processing: First Post title
Filename: post/first-post-title.md