=== Wordpress2Jekyll ===
Contributors: liam_bowers
Donate link: https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=A5BPK7XBH54UY
Tags: jekyll, export, flat, blog
Requires at least: 4.3
Tested up to: 4.4.1
Stable tag: 0.1
License: GPLv2 or later
License URI: http://www.gnu.org/licenses/gpl-2.0.html

This allows you to use Wordpress as an admin interface to Jekyll. It will save your posts and author information out in a Jekyll friendly format.

== Description ==

Jekyll is a great tool that will build a full blog site using text files written in a specific format. It gives you the bonus of having a very light and quick site that can't be hacked through script vulnerabilities. The downside of this is that it's not always easy to edit. It's harder still when using a mobile device.

This is where Wordpress comes in. Wordpress can be used to modify the posts (both standard posts and pages) and these changes will automatically be exported. This means that it is possible to edit content using a mobile device and the Wordpress app.

Wordpress2Jekyll attempts to marry these two systems together in order to make a quick, secure website that can be easily managed from all devices.

== Installation ==

Installing this module is simple enough:

1. Upload the plugin files to the `/wp-content/plugins/wordpress2jekyll` directory, or install the plugin through the WordPress plugins screen directly.
1. Activate the plugin through the 'Plugins' screen in WordPress.
1. Use the Settings->Wordpress2Jekyll screen to configure the plugin. This Jekyll path must point to an existing Jekyll site directory. If you're using it for testing purposes then make sure it has _posts, _data and _assets directories.
1. Use Tools->Jekyll to perform a full export of the current posts

== Frequently Asked Questions ==

= What is Jekyll? =

Check out https://jekyllrb.com/. It should give you all the answers you need right here.

= What do I do after the site has exported? =

That completely depends on your setup. If you have Jekyll set up to watch the directory for changes then it will build or serve the site automatically.

Future versions will trigger Jekyll in to building the site.

== Changelog ==

= 0.1 =
* Initial version.
* Currently exports posts and pages with all the information Jekyll needs to build a page.
* Converts page content to Markdown format. Assumes it is HTML.
* Has option to use the Wordpress Permalinks patterns rather than using the configured Jekyll method.
* Automatically builds individual pages (or full build) depending on what has changed in the post.

== Upgrade Notice ==

= 1.0 =
Upgrade notices describe the reason a user should upgrade.  No more than 300 characters.

= 0.5 =
This version fixes a security related bug.  Upgrade immediately.

== Limitations ==

* Featured images will be exported and linked accordingly.
* Doesn't support passworded posts at this time (I'm not sure if it ever will).
* Doesn't support inline media at this time.
* Supports categories (exported in order)
* Supports tags (exported in order)
* Permalinks can be modified from within Wordpress
* Ideally the Wordpress installation should be hidden away and not publicly accessible. I'm working on a separate plugin to do this easily.

== Wishlist ==

* Add full builds to a cron job.
* Export inline media