This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
All ImpEx features are exposed by it's WordPress REST API endpoint.
The REST API is available at `/wp-json/cm4all-wp-impex/v1/`.
See [ImpEx REST API documentation](./cm4all-wp-impex-oas.md).
The REST API is also available as [OpenAPI Specification Format](https://swagger.io/specification/v2/) : Download [ImpEx OpenAPI Specification](http://0.0.0.0:3000/api/cm4all-wp-impex-oas.json) here.
You can explore the ImpEx Rest API using any HTTP Rest API Client.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ImpEx separates Import and Export in 2 steps using the ImpEx Dashboard screen.

## Export
- You need to create a snapshot first.
The snapshot will contain the current data (defined by the used [ImpEx profile](explanation-of-terms.html#profile)) of the WordPress instance.
- Now you can download the snapshot to your local machine.
## Import
- Upload snapshot from your local machine to the WordPress instance.
Uploading does not modify your current WordPress contents.
- If you now import the snapshot, the contents of your WordPress instance will be updated with the snapshot data.
> Using the [impex-cli](./impex-cli.html) command line tool will combine both steps in one. You just export or import a local directory containing the snapshot in [ImpEx Export Format](./migrating-content.html#preparation). [impex-cli](./impex-cli.html) manages the temporary snapshot handling for you.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
@@ -4,10 +4,10 @@ This package provides a foundation of JavaScript functions/classes for transform
The framework does not require a WordPress instance. It rather offers an extensible platform for generating WordPress content consumable by the [ImpEx WordPress plugin](https://github.com/IONOS-WordPress/cm4all-wp-impex).
> [ImpEx WordPress plugin](https://github.com/IONOS-WordPress/cm4all-wp-impex) is a Open Source WordPress plugin for importing / exporting WordPress data.
> [ImpEx](https://github.com/IONOS-WordPress/cm4all-wp-impex) is a [Open Source WordPress plugin for importing / exporting WordPress data](https://github.com/IONOS-WordPress/cm4all-wp-impex).
> _[`@cm4all-wp-impex/generator`](https://www.npmjs.com/@cm4all-wp-impex/generator) is part of the [ImpEx WordPress plugin](https://github.com/IONOS-WordPress/cm4all-wp-impex) project._
[Watch the tutorial on YouTube](https://img.youtube.com/vi/pjG69RmULYo/2.jpg):
[Watch the tutorial on YouTube](https://www.youtube.com/watch?v=pjG69RmULYo):
[](https://www.youtube.com/watch?v=pjG69RmULYo)
Expand All
@@ -23,7 +23,7 @@ The [ImpEx WordPress plugin](https://github.com/IONOS-WordPress/cm4all-wp-impex)
- functions to [create file/folder structure expected](https://ionos-wordpress.github.io/cm4all-wp-impex/migrating-content.html) by the [ImpEx WordPress plugin](https://github.com/IONOS-WordPress/cm4all-wp-impex)
Last but not least [`@cm4all-wp-impex/generator`](https://www.npmjs.com/@cm4all-wp-impex/generator) includes a [full featured example transforming a complete static website into a WordPress content](https://github.com/IONOS-WordPress/cm4all-wp-impex/tree/develop/packages/%40cm4all-wp-impex/generator/examples/impex-complete-static-homepage-conversion) consumable by [ImpEx WordPress plugin](https://github.com/IONOS-WordPress/cm4all-wp-impex). The [example](https://github.com/IONOS-WordPress/cm4all-wp-impex/tree/develop/packages/%40cm4all-wp-impex/generator/examples/impex-complete-static-homepage-conversion) is the perfect starting point for creating your own WordPress content generator.
Last but not least [`@cm4all-wp-impex/generator`](https://www.npmjs.com/@cm4all-wp-impex/generator) includes a [full featured example transforming a complete static website into WordPress content](https://github.com/IONOS-WordPress/cm4all-wp-impex/tree/develop/packages/%40cm4all-wp-impex/generator/examples/impex-complete-static-homepage-conversion) consumable by [ImpEx WordPress plugin](https://github.com/IONOS-WordPress/cm4all-wp-impex). The [example](https://github.com/IONOS-WordPress/cm4all-wp-impex/tree/develop/packages/%40cm4all-wp-impex/generator/examples/impex-complete-static-homepage-conversion) is the perfect starting point for creating your own WordPress content generator.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
@@ -31,16 +31,18 @@ The conversion process is implemented in a single file `./index.js` :
The conversion process is implemented in less than 240 lines of code thanks to package [`@cm4all-wp-impex/generator`](https://www.npmjs.com/@cm4all-wp-impex/generator).
You can run the conversion script by executing `./index.js`
You can run the conversion script by executing `./index.js` (can be found at the GitHub repository : [packages/@cm4all-wp-impex/generator/examples/impex-complete-static-homepage-conversion\index.js](https://github.com/IONOS-WordPress/cm4all-wp-impex/blob/develop/packages/%40cm4all-wp-impex/generator/examples/impex-complete-static-homepage-conversion/index.js)
> Ensure the right nodejs version is active before using `nvm install` and to install the required NodeJS dependencies using `npm ci`.
> Ensure that you've installed the script dependencies by entering directory `cm4all-wp-impex/packages/@cm4all-wp-impex/generator` and executing `npm ci`.
The result is a folder `generated-impex-import/` containing the generated [ImpEx export folder layout](https://ionos-wordpress.github.io/cm4all-wp-impex/migrating-content.html#preparation) containing the ImpEx slice JSON files and media files.
This export can now be imported into WordPress using [ImpEx CLI](https://ionos-wordpress.github.io/cm4all-wp-impex/impex-cli.html) :
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
"description": "Foundation for transforming any data to Gutenberg block annotated WordPress content into WordPress ImpEx plugin (https://github.com/IONOS-WordPress/cm4all-wp-impex) export format",
"version": "1.3.5",
"description": "Transforming any data to Gutenberg block annotated WordPress content by generating WordPress ImpEx plugin (https://github.com/IONOS-WordPress/cm4all-wp-impex) files",
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters