npm-wpxml2md

Convert the WordPress XML file to Markdown files.

Installation

$ npm install wpxml2md

WordPress XML

Can export the WordPress XML in the following way.

1. Displays the management screen of WordPress
2. Select the Tools - Export from the menu
3. Select All content in Choose what to export
4. Click to Download Export File

Usage

Node API

wpxml2md is promisify function.

const wpxml2md = require('wpxml2md');
 
const options = {
  report: true,
  noGFM: false,
  noMELink: true,
  withMetadata: true,
  withImageDownload: true,
  withComment: true,
  replaceLinkPrefix: {
    old: 'http://akabeko.me/blog/',
    new: '/'
  }
}
 
wpxml2md('wordpress.xml', 'dest', options)
.then(() => {
  console.log('Completed!!');
} )
.catch((err) => {
  console.error(err);
});

wpxml2md

wpxml2md(src, dest, options)

Options:

CLI

Usage: wpxml2md [OPTIONS]

  Convert the WordPress XML file to Markdown files.

  Options:
    -h, --help            Display this text.
    -v, --version         Display the version number.
    -i, --input           Path of the XML file exported from WordPress.
    -o, --output          Path of the output directory.
    -r, --report          Output process reports.
    --no-gfm              Disable the GitHub Flavored Markdown.
    --no-melink           Disable the Markdown Extra link on header.
    --with-metadata       Enable output article metadata.
    --with-image-download Enable download and replace link syntaxes a linked images from article.
    --with-comment        Enable comment output from article.
    --replace-link-prefix Replace the link URL prefix with the specified word, format is "target=placeholder".
                          If "--replace-link http://example.com/=/" then "http://example.com/" will be replaced with "/".

  Examples:
    $ wpxml2md -i wordpress.xml -o ./dist -r
    $ wpxml2md -i wordpress.xml -o ./dist -r --with-metadata --with-image-download --with-comment --replace-link-prefix http://akabeko.me/=/

  See also:
    https://github.com/akabekobeko/npm-wpxml2md

Conversion

This section describes the conversion by this tool. Markdown conversion engine was in reference to the design and implementation of the domchristie/to-markdown, rewrite an ES2015 and more.

Output directories

Converted Markdown files are output in the following directory.

YYYYMMDD-hhmmss/
├── pages
│   └── YYYY
│       └── MM
│           └── DD.md
└── posts
    └── YYYY
        └── MM
            └── DD.md

• The name of the root directory is the date time that the execution of the processing
• The result of converting the Pages will be output to the pages directory
• The result of converting the Posts will be output to the posts directory
• Markdown's file name is posted date time.
• If the file or directory name is a duplicate will be added to the sequential number at the end.

HTML TAG

Default markdown.

GitHub Flavored Markdown.

Shortcode

caption

[caption]
<a href="example.png" title="Title">
  <img src="example.png" alt="Title"></a>
</a>
[/caption]

Remove the short code dregs. Contents will Markdown conversion as HTML.

[![Title](example.png)](example.png "Title")

code

[code lang="js"]
const test = 'test';
console.log(test);
[/code]

code is converted to a code block.

```js
const test = 'test';
console.log(test);
```

Short code of programming languages and converts it to a code block.

[js]
const test = 'test';
if (test) {
  console.log(test);
}
[/js]

For example, the above will be converted to the following.

```js
const test = 'test';
if (test) {
  console.log(test);
}
```

Language to be converted is the following. The language names are based on the SyntaxHighlighter - Bundled Brushes.

ChangeLog

• CHANGELOG

License

• MIT