Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dshved/wordpress-exporter
Adapter to extract data from Wordpress https://www.contentful.com
https://github.com/dshved/wordpress-exporter
Last synced: 15 days ago
JSON representation
Adapter to extract data from Wordpress https://www.contentful.com
- Host: GitHub
- URL: https://github.com/dshved/wordpress-exporter
- Owner: dshved
- License: mit
- Created: 2018-01-29T13:56:42.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2018-03-08T12:38:17.000Z (over 6 years ago)
- Last Synced: 2024-10-17T03:33:15.651Z (about 1 month ago)
- Language: JavaScript
- Size: 10.7 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Wordpress to Contentful Exporter
> **Note**: This is a ported code with a ruby on the nodejs wordpress-exporter.rb
> The original repository can be viewed [here](https://github.com/contentful-labs/wordpress-exporter.rb).
## Description
This adapter will allow you to extract content from a WordPress Blog and prepare it to be imported to [Contentful](https://wwww.contentful.com).
The following content will be extracted:
* Blog with posts
* Categories, tags and terms from custom taxonomies
* Attachments
## Installation
```bash
npm i -g wordpress-exporter
```
This will install the `wordpress-exporter` executable on your system.
## Setup
To extract the blog content you need to [export](http://en.support.wordpress.com/export/) it from the WordPress blog and save it as a XML file.
Further you need to define where the tool can find the XML file and the destination of the transformed content.
Create a `settings.json` file and fill in the `dataDir` and `wordpressXmlPath`:
```json
{
"dataDir": "PATH_TO_ALL_DATA",
"wordpressXmlPath": "PATH_TO_XML/file.xml"
}
```
To extract the content run:
```bash
wordpress-exporter --config-file settings.yml --extract-to-json
```
The result will be a directory structure with the WordPress content transformed into JSON files that are ready for import.
Use the [generic-importer](https://github.com/contentful/generic-importer.rb) to import your blog then to Contentful.
## Step by step
1. [Export](http://en.support.wordpress.com/export/) the content of the blog from WordPress and save it as XML file.
2. Create YAML file with settings (eg. settings.yml) and fill in the required parameters.
The generated `content types`, `entries` and `assets` will be saved to the `dataDir`.
We recommend you to use `wordpress_settings/wordpress_settings.yml` file in this repository
3. Extract the content from the XML file and generate the content model and JSON files for the import:
```bash
wordpress-exporter --config-file settings.yml --extract-to-json
```
If you want to create a different content model for your blog you can use `--omit-content-model`
```bash
wordpress-exporter --config-file settings.yml --extract-to-json --omit-content-model
```
It will only extract the content and store it as JSON, you need to take care about the content mapping yourself.
See the [Contentful-importer](https://github.com/contentful/generic-importer.rb) for details on how this needs to be done.
4. (Optional). HTML markup can be converted to markdown:
```bash
wordpress-exporter --config-file settings.yml --convert-markup
```
This will only touch the content body of a blog post, other attributes will not be changed.
5. Create your content model from JSON:
```bash
wordpress-exporter --config-file settings.yml --create-contentful-model-from-json
```
6. Use the [contentful-importer](https://github.com/contentful/contentful-importer.rb) to import the content to [contentful.com](https://www.contentful.com)
7. Add you organization id and the access token to your `settings.json`
8. Add the new created space id to your `settings.json` file.
9. Now follow the steps (starting from step 3) of our [contentful-importer guide](https://github.com/contentful/contentful-importer.rb#step-by-step) to publish your content.