From d18ba0046a1ecbbc3ddfc8537b6fb31731507261 Mon Sep 17 00:00:00 2001 From: Will Boyd Date: Wed, 12 Dec 2018 16:28:15 -0500 Subject: [PATCH] Make public --- README.md | 10 +++++----- package.json | 1 - 2 files changed, 5 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 00e0697..439abc5 100644 --- a/README.md +++ b/README.md @@ -2,23 +2,23 @@ Converts a WordPress export XML file into Markdown files. -This is useful if you want to migrate from WordPress to a static site generator such as [Gatsby](https://www.gatsbyjs.org/) or [Hugo](https://gohugo.io/), among others. +Useful if you want to migrate from WordPress to a static site generator ([Gatsby](https://www.gatsbyjs.org/), [Hugo](https://gohugo.io/), [Jekyll](https://jekyllrb.com/), etc.). Saves each post as a separate file with appropriate frontmatter. Also saves attached images and (optionally) any additional images found in post body content. Posts and images can be saved into a variety of folder structures. ## Quick Start -You just need two things to get started: +You'll need: - [Node.js](https://nodejs.org/) v10.12 or later - Your WordPress export file - Log into your WordPress admin site and go to Tools > Export > Download Export File - Save the file as `export.xml` inside this package's directory -Now open your terminal to this package's directory. Run `npm install`. Then run `node index.js`. +Open your terminal to this package's directory. Run `npm install` and then `node index.js`. -This will use default options to create an `/output` folder filled with your posts and images. +This will use default options to create an `/output` folder filled with your posts and images. Done! -## Command Line Arguments +## Customization You can use command line arguments to control options for how the script runs. For example, this will give you [Jekyll](https://jekyllrb.com/)-style output in terms of folder structure and filenames: diff --git a/package.json b/package.json index c273bbf..699c076 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,6 @@ { "name": "wp-to-gatsby-md", "version": "1.0.0", - "private": true, "description": "Converts a WordPress export XML file into Markdown files.", "main": "index.js", "scripts": {