A script that converts a WordPress export XML file into Markdown files suitable for static site generators like Gatsby, Hugo, and especially Jekyll
Each post (and now each page too! custom types coming soon...) is saved as a separate Markdown file with appropriate frontmatter. Images are also downloaded and saved. Embedded content from YouTube, Twitter, CodePen, etc. is carefully preserved.
You'll need:
- Node.js v12.14 or later
- Your WordPress export file
It is recommended that you drop your WordPress export file into the same directory that you run this script from so it's easy to find. 'export.xml' is the default file name.
To run, clone the repo and install:
git clone https://github.com/kyle-cagb/wordpress-export-to-markdown
cd wordpress-export-to-markdown
npm install && node index.js
The script will start the wizard. Answer the questions and off you go!
The wizard makes it easy to configure your options, but you can also do so via the command line if you want. It's set up by default to work with Jekyll
node index.js --input=yourexport.xml --wizard=false
- Argument:
--wizard - Type:
boolean - Default:
true
Enable to have the script prompt you for each option. Disable to skip the wizard and use default values for any options not specified via the command line.
- Argument:
--input - Type:
file(as a path string) - Default:
export.xml
The path to the WordPress export file that you want to parse. It is recommended that you drop your WordPress export file into the same directory that you run this script from so it's easy to find.
- Argument:
--output - Type:
folder(as a path string) - Default:
output
The path to the output directory where Markdown and image files will be saved. If it does not exist, it will be created for you.
- Argument:
--export-posts - Type:
boolean - Default:
true
- Argument:
--export-pages - Type:
boolean - Default:
true
- Argument:
--export-custom - Type:
slug(as string) - Default: ``
- Argument:
--year-folders - Type:
boolean - Default:
false
Whether or not to organize output files into folders by year.
- Argument:
--month-folders - Type:
boolean - Default:
false
Whether or not to organize output files into folders by month. You'll probably want to combine this with --year-folders to organize files by year then month.
- Argument:
--post-folders - Type:
boolean - Default:
false
Whether or not to save files and images into post folders.
If true, the post slug is used for the folder name and the post's Markdown file is named index.md. Each post folder will have its own /images folder.
/first-post
/images
potato.png
index.md
/second-post
/images
carrot.jpg
celery.jpg
index.md
If false, the post slug is used to name the post's Markdown file. These files will be side-by-side and images will go into a shared /images folder.
/images
carrot.jpg
celery.jpg
potato.png
first-post.md
second-post.md
Either way, this can be combined with with --year-folders and --month-folders, in which case the above output will be organized under the appropriate year and month folders.
- Argument:
--post-folders - Type:
boolean - Default:
false
Whether or not to save files and images into post folders.
- Argument:
--prefix-date - Type:
boolean - Default:
false
Whether or not to prepend the post date to the post slug when naming a post's folder or file.
If --post-folders is true, this affects the folder.
/2019-10-14-first-post
index.md
/2019-10-23-second-post
index.md
If --post-folders is false, this affects the file.
2019-10-14-first-post.md
2019-10-23-second-post.md
- Argument:
--save-attached-images - Type:
boolean - Default:
true
Whether or not to download and save images attached to posts. Generally speaking, these are images that were uploaded by using Add Media or Set Featured Image when editing a post in WordPress. Images are saved into /images.
- Argument:
--save-scraped-images - Type:
boolean - Default:
true
Whether or not to download and save images scraped from <img> tags in post body content. Images are saved into /images. The <img> tags are updated to point to where the images are saved.