fix documentation for custom post types & misc readme improvements fo…

docs/custom-post-types.md

@@ -3,7 +3,9 @@
 To export custom post types, you'll need to add a filter to do the following:
 
 ```php
-add_filter( 'jekyll_export_post_types', array('posts', 'pages', 'you-custom-post-type') );
+add_filter( 'jekyll_export_post_types', function() {
+	return array('posts', 'pages', 'you-custom-post-type');
+});
 ```
 
 The custom post type will be exported as a Jekyll collection. You'll need to initialize it in the resulting Jekyll site's `_config.yml`.

docs/developing-locally.md

@@ -2,14 +2,14 @@
 
 ### Prerequisites
 1. `sudo apt-get update`
-1. `sudo apt install composer`
-1. `sudo apt install php7.0-xml`
-1. `sudo apt install php7.0-mysql`
-1. `sudo apt install php7.0-zip`
-1. `sudo apt install php-mbstring`
-1. `sudo apt install subversion`
-1. `sudo apt install mysql-server`
-1. `sudo apt install php-pear`
+1. `sudo apt-get install composer`
+1. `sudo apt-get install php7.3-xml`
+1. `sudo apt-get install php7.3-mysql`
+1. `sudo apt-get install php7.3-zip`
+1. `sudo apt-get install php-mbstring`
+1. `sudo apt-get install subversion`
+1. `sudo apt-get install mysql-server`
+1. `sudo apt-get install php-pear`
 1. `sudo pear install PHP_CodeSniffer`
 
 ### Bootstrap & Setup

docs/required-php-version.md

@@ -4,7 +4,7 @@ Many shared hosts may use an outdated version of PHP by default. **WordPress to
 
 If you get an error message that looks like `unexpected T_STRING`, `unexpected '['` or `expecting T_CONSTANT_ENCAPSED_STRING`, you need to update your PHP version. In a shared hosting environment, you should be able to change the version of PHP used by simply toggling the setting in the host's control panel.
 
-PHP 5.4 lost support from the PHP project itself in 2015. You'll need to be running at least PHP 5.5 which adds namespace support (the reason it's breaking), but I'd recommend at least 5.6 (or the latest your host supports) as it's the oldest supported version: <https://en.wikipedia.org/wiki/PHP#Release_history>
+PHP 5.4 lost support from the PHP project itself in 2015. You'll need to be running at least PHP 5.5 which adds namespace support (the reason it's breaking), but I'd recommend at least 7.3 (or the latest your host supports) as it's the [oldest supported version](https://www.php.net/supported-versions.php).
 
 ### How to determine which version of PHP you're running
 

readme.txt

@@ -27,51 +27,11 @@ License URI: http://www.gnu.org/licenses/gpl-3.0.html
 
 See [the full documentation](https://ben.balter.com/wordpress-to-jekyll-exporter):
 
-* [Changelog](http://ben.balter.com/wordpress-to-jekyll-exporter/changelog/)
-* [Command-line-usage](http://ben.balter.com/wordpress-to-jekyll-exporter/command-line-usage/)
-* [Custom post types](http://ben.balter.com/wordpress-to-jekyll-exporter/custom-post-types/)
-* [Developing locally](http://ben.balter.com/wordpress-to-jekyll-exporter/developing-locally/)
-* [Minimum required PHP version](http://ben.balter.com/wordpress-to-jekyll-exporter/required-php-version/)
-
-
-== Custom post types ==
-
-To export custom post types, you'll need to add a filter to do the following:
-
-```php
-add_filter( 'jekyll_export_post_types', array('posts', 'pages', 'you-custom-post-type') );
-```
-
-The custom post type will be exported as a Jekyll collection. You'll need to initialize it in the resulting Jekyll site's `_config.yml`.
-
-
-== Changelog ==
-
-[View Past Releases](https://github.com/benbalter/wordpress-to-jekyll-exporter/releases)
-
-
-== Developing locally ==
-
-= Prerequisites =
-1. `sudo apt-get update`
-1. `sudo apt install composer`
-1. `sudo apt install php7.0-xml`
-1. `sudo apt install php7.0-mysql`
-1. `sudo apt install php7.0-zip`
-1. `sudo apt install php-mbstring`
-1. `sudo apt install subversion`
-1. `sudo apt install mysql-server`
-1. `sudo apt install php-pear`
-1. `sudo pear install PHP_CodeSniffer`
-
-= Bootstrap & Setup =
-1. `git clone https://github.com/benbalter/wordpress-to-jekyll-exporter`
-2. `cd wordpress-to-jekyll-exporter`
-3. `script/bootstrap`
-4. `script/setup`
-
-= Running tests =
-`script/cibuild`
+* [Changelog](http://ben.balter.com/wordpress-to-jekyll-exporter//docs/changelog/)
+* [Command-line-usage](http://ben.balter.com/wordpress-to-jekyll-exporter//docs/command-line-usage/)
+* [Custom post types](http://ben.balter.com/wordpress-to-jekyll-exporter//docs/custom-post-types/)
+* [Developing locally](http://ben.balter.com/wordpress-to-jekyll-exporter//docs/developing-locally/)
+* [Minimum required PHP version](http://ben.balter.com/wordpress-to-jekyll-exporter//docs/required-php-version/)
 
 
 == Command-line Usage ==
@@ -80,17 +40,17 @@ If you're having trouble with your web server timing out before the export is co
 
 It works just like the plugin, but produces the zipfile on STDOUT:
 
-```
+`
 php jekyll-export-cli.php > jekyll-export.zip
-```
+`
 
 If using this method, you must run first `cd` into the wordpress-to-jekyll-exporter directory.
 
 Alternatively, if you have [WP-CLI](http://wp-cli.org) installed, you can run:
 
-```
+`
 wp jekyll-export > export.zip
-```
+`
 
 The WP-CLI version will provide greater compatibility for alternate WordPress environments, such as when `wp-content` isn't in the usual location.
 
@@ -101,7 +61,7 @@ Many shared hosts may use an outdated version of PHP by default. **WordPress to
 
 If you get an error message that looks like `unexpected T_STRING`, `unexpected '['` or `expecting T_CONSTANT_ENCAPSED_STRING`, you need to update your PHP version. In a shared hosting environment, you should be able to change the version of PHP used by simply toggling the setting in the host's control panel.
 
-PHP 5.4 lost support from the PHP project itself in 2015. You'll need to be running at least PHP 5.5 which adds namespace support (the reason it's breaking), but I'd recommend at least 5.6 (or the latest your host supports) as it's the oldest supported version: <https://en.wikipedia.org/wiki/PHP#Release_history>
+PHP 5.4 lost support from the PHP project itself in 2015. You'll need to be running at least PHP 5.5 which adds namespace support (the reason it's breaking), but I'd recommend at least 7.3 (or the latest your host supports) as it's the [oldest supported version](https://www.php.net/supported-versions.php).
 
 = How to determine which version of PHP you're running =
 
@@ -111,3 +71,73 @@ PHP 5.4 lost support from the PHP project itself in 2015. You'll need to be runn
 = How to upgrade your version of PHP =
 
 If you are using a shared hosting environment, upgrading to a newer version of PHP should be a matter of changing a setting in your host's control panel. You'll have to follow your host specific documentation to determine how to access it or where the setting lives. Check out [this list of common hosts](https://kb.yoast.com/kb/how-to-update-your-php-version/) for more details.
+
+
+== Changelog ==
+
+[View Past Releases](https://github.com/benbalter/wordpress-to-jekyll-exporter/releases)
+
+
+== Where to get help or report an issue ==
+
+* For getting started and general documentation, please browse, and feel free to contribute to [the project documentation](http://ben.balter.com/wordpress-to-jekyll-exporter/).
+* For support questions ("How do I", "I can't seem to", etc.) please search and if not already answered, open a thread in the [Support Forums](http://wordpress.org/support/plugin/jekyll-exporter).
+* For technical issues (e.g., to submit a bug or feature request) please search and if not already filed, [open an issue on GitHub](https://github.com/benbalter//wordpress-to-jekyll-exporter/issues).
+
+== Things to check before reporting an issue ==
+
+* Are you using the latest version of WordPress?
+* Are you using the latest version of the plugin?
+* Does the problem occur even when you deactivate all plugins and use the default theme?
+* Have you tried deactivating and reactivating the plugin?
+* Has your issue [already been reported](https://github.com/benbalter/wordpress-to-jekyll-exporter/issues)?
+
+== What to include in an issue ==
+
+* What steps can another user take to recreate the issue?
+* What is the expected outcome of that action?
+* What is the actual outcome of that action?
+* Are there any screenshots or screencasts that may be helpful to include?
+* Only include one bug per issue. If you have discovered two bugs, please file two issues.
+
+
+== Developing locally ==
+
+= Prerequisites =
+1. `sudo apt-get update`
+1. `sudo apt-get install composer`
+1. `sudo apt-get install php7.3-xml`
+1. `sudo apt-get install php7.3-mysql`
+1. `sudo apt-get install php7.3-zip`
+1. `sudo apt-get install php-mbstring`
+1. `sudo apt-get install subversion`
+1. `sudo apt-get install mysql-server`
+1. `sudo apt-get install php-pear`
+1. `sudo pear install PHP_CodeSniffer`
+
+= Bootstrap & Setup =
+1. `git clone https://github.com/benbalter/wordpress-to-jekyll-exporter`
+2. `cd wordpress-to-jekyll-exporter`
+3. `script/bootstrap`
+4. `script/setup`
+
+= Running tests =
+`script/cibuild`
+
+
+== Custom post types ==
+
+To export custom post types, you'll need to add a filter to do the following:
+
+`
+add_filter( 'jekyll_export_post_types', function() {
+	return array('posts', 'pages', 'you-custom-post-type')
+});
+`
+
+The custom post type will be exported as a Jekyll collection. You'll need to initialize it in the resulting Jekyll site's `_config.yml`.
+
+
+=== Security Policy ===
+
+To report a security vulnerability, please email [[email protected]](mailto:[email protected]).

script/build-readme

@@ -20,6 +20,7 @@ output.gsub! /^### ?(.*?)$/im, "= \\1 ="
 output.gsub! /^## ?(.*?)$/im, "== \\1 =="
 output.gsub! /^# ?(.*?)$/im, "=== \\1 ==="
 output.gsub! /\]\((.*?)\.md/, "](#{docs_url}\\1/"
+output.gsub! /```(php|js|html)?/im, "`"
 
 File.open("readme.txt", "wb") do |file|
   file << output