https://github.com/ytechie/wordpress-to-markdown

Wordpress Export XML converter that outputs Markdown posts
https://github.com/ytechie/wordpress-to-markdown

Last synced: 5 days ago
JSON representation

Wordpress Export XML converter that outputs Markdown posts

• Host: GitHub
• URL: https://github.com/ytechie/wordpress-to-markdown
• Owner: ytechie
• Created: 2013-11-19T03:51:24.000Z (almost 11 years ago)
• Default Branch: master
• Last Pushed: 2019-07-02T17:51:15.000Z (over 5 years ago)
• Last Synced: 2024-08-01T12:33:06.933Z (3 months ago)
• Language: JavaScript
• Size: 13.7 KB
• Stars: 86
• Watchers: 3
• Forks: 43
• Open Issues: 3
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• awesome-starred - ytechie/wordpress-to-markdown - Wordpress Export XML converter that outputs Markdown posts (others)

README

        
# wordpress-to-markdown

This script uses the standard exported XML file from WordPress, and creates a folder/file structure that contains all of the blog posts, converted to markdown format. It will also download all of the images.

Instructions for exporting your information from WordPress [can be found here](http://en.support.wordpress.com/export/).

The folder structure was designed after my blog. I like the structure because it groups the files for the post with the post itself. If you want a different format, you'll need to modify the script.

	/2013/11/this-is-a-post/index.html.md

	/2013/11/this-is-a-post/image-for-the-post.jpg

### Works on my box

**This is highly experimental at best. It was developed for my own use to do a one time conversion from WordPress to markdown for a static generator such as [DocPad](https://github.com/bevry/docpad). It is designed to be used one time and then throw away.**

### Technical Details

This uses [xml2js](https://github.com/Leonidas-from-XIV/node-xml2js) to parse the XML easily, and then uses [to-markdown](https://github.com/domchristie/to-markdown) to convert the HTML post content into Markdown.

### Requirements

* You must have Node.js installed and available in the folder you wish to run the script from.

* The folder the script is is *must* contain a WordPress export file called "export.xml". The file name is hard-coded.

### Usage

Clone the repo and go into its directory to install dependencies:

```

$ git clone https://github.com/ytechie/wordpress-to-markdown.git

$ cd wordpress-to-markdown/

$ npm install xml2js to-markdown

```

Copy your Wordpress content export into the folder as `export.xml`. Then run the script

```

$ node convert.js

```

### License

The MIT License (MIT)

Copyright (c) 2013 Jason Young

Permission is hereby granted, free of charge, to any person obtaining a copy

of this software and associated documentation files (the "Software"), to deal

in the Software without restriction, including without limitation the rights

to use, copy, modify, merge, publish, distribute, sublicense, and/or sell

copies of the Software, and to permit persons to whom the Software is

furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all

copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR

IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,

FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE

AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER

LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,

OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE

SOFTWARE.