Jason Stallings

<p>Github Shortcode is a plugin that allows you to embed a GitHub repository in a page or post using a simple shortcode.</p>
<p>Usage:</p>
<p>[github repo=”octalmage/Github-Shortcode”]</p>


Github Shortcode

Easily display GitHub Repositories in Pages/Posts.

Ben Balter

<h3>Features</h3>
<ul>
<li>Converts all posts, pages, and settings from WordPress to Markdown and YAML for use in Jekyll (or Hugo or any other Markdown and YAML based site engine)</li>
<li>Export what your users see, not what the database stores (runs post content through <code>the_content</code> filter prior to export, allowing third-party plugins to modify the output)</li>
<li>Converts all <code>post_content</code> to Markdown</li>
<li>Converts all <code>post_meta</code> and fields within the <code>wp_posts</code> table to YAML front matter for parsing by Jekyll</li>
<li>Generates a <code>_config.yml</code> with all settings in the <code>wp_options</code> table</li>
<li>Outputs a single zip file with <code>_config.yml</code>, pages, and <code>_posts</code> folder containing <code>.md</code> files for each post in the proper Jekyll naming convention</li>
<li>No settings. Just a single click.</li>
</ul>
<h3>Usage</h3>
<ol>
<li>Place plugin in <code>/wp-content/plugins/</code> folder</li>
<li>Activate plugin in WordPress dashboard</li>
<li>Select <code>Export to Jekyll</code> from the <code>Tools</code> menu</li>
</ol>
<h3>More information</h3>
<p>See <a href="https://ben.balter.com/wordpress-to-jekyll-exporter" rel="nofollow ugc">the full documentation</a>:</p>
<ul>
<li><a href="https://ben.balter.com/wordpress-to-jekyll-exporter/./docs/changelog/" rel="nofollow ugc">Changelog</a></li>
<li><a href="https://ben.balter.com/wordpress-to-jekyll-exporter/./docs/command-line-usage/" rel="nofollow ugc">Command-line-usage</a></li>
<li><a href="https://ben.balter.com/wordpress-to-jekyll-exporter/./docs/custom-post-types/" rel="nofollow ugc">Custom post types</a></li>
<li><a href="https://ben.balter.com/wordpress-to-jekyll-exporter/./docs/custom-fields/" rel="nofollow ugc">Custom fields</a></li>
<li><a href="https://ben.balter.com/wordpress-to-jekyll-exporter/./docs/developing-locally/" rel="nofollow ugc">Developing locally</a></li>
<li><a href="https://ben.balter.com/wordpress-to-jekyll-exporter/./docs/required-php-version/" rel="nofollow ugc">Minimum required PHP version</a></li>
</ul>
<h3>Security Policy</h3>
<p>To report a security vulnerability, please email <a href="mailto:ben@balter.com" rel="nofollow ugc">ben@balter.com</a>.</p>
<h3>Where to get help or report an issue</h3>
<ul>
<li>For getting started and general documentation, please browse, and feel free to contribute to <a href="http://ben.balter.com/wordpress-to-jekyll-exporter/" rel="nofollow ugc">the project documentation</a>.</li>
<li>For support questions (“How do I”, “I can’t seem to”, etc.) please search and if not already answered, open a thread in the <a href="https://wordpress.org/support/plugin/jekyll-exporter" rel="ugc">Support Forums</a>.</li>
<li>For technical issues (e.g., to submit a bug or feature request) please search and if not already filed, <a href="https://github.com/benbalter//wordpress-to-jekyll-exporter/issues" rel="nofollow ugc">open an issue on GitHub</a>.</li>
</ul>
<h3>Things to check before reporting an issue</h3>
<ul>
<li>Are you using the latest version of WordPress?</li>
<li>Are you using the latest version of the plugin?</li>
<li>Does the problem occur even when you deactivate all plugins and use the default theme?</li>
<li>Have you tried deactivating and reactivating the plugin?</li>
<li>Has your issue <a href="https://github.com/benbalter/wordpress-to-jekyll-exporter/issues" rel="nofollow ugc">already been reported</a>?</li>
</ul>
<h3>What to include in an issue</h3>
<ul>
<li>What steps can another user take to recreate the issue?</li>
<li>What is the expected outcome of that action?</li>
<li>What is the actual outcome of that action?</li>
<li>Are there any screenshots or screencasts that may be helpful to include?</li>
<li>Only include one bug per issue. If you have discovered two bugs, please file two issues.</li>
</ul>
<h3>Command-line Usage</h3>
<p>If you’re having trouble with your web server timing out before the export is complete, or if you just like terminal better, you may enjoy the command-line tool.</p>
<p>It works just like the plugin, but produces the zipfile on STDOUT:</p>
<pre><code>`
</code></pre>
<p>php jekyll-export-cli.php > jekyll-export.zip<br />
    `</p>
<p>If using this method, you must run first <code>cd</code> into the wordpress-to-jekyll-exporter directory.</p>
<p>Alternatively, if you have <a href="http://wp-cli.org" rel="nofollow ugc">WP-CLI</a> installed, you can run:</p>
<pre><code>`
</code></pre>
<p>wp jekyll-export > export.zip<br />
    `</p>
<p>The WP-CLI version will provide greater compatibility for alternate WordPress environments, such as when <code>wp-content</code> isn’t in the usual location.</p>
<h3>Custom fields</h3>
<p>When using custom fields (e.g. with the Advanced Custom fields plugin) you might have to register a filter to convert array style configs to plain values.</p>
<p>By default, the plugin saves custom fields in an array structure that is exported as:</p>
<pre><code>`php
</code></pre>
<p>[“my-bool”]=><br />
    array(1) {<br />
        [0] => string(1) “1”<br />
    }<br />
[“location”]=><br />
    array(1) {<br />
        [0] => string(88) “My address”<br />
    }<br />
    `</p>
<p>And this leads to a YAML structure like:</p>
<pre><code>`yaml
</code></pre>
<p>my-bool:<br />
– “1”<br />
location:<br />
– ‘My address’<br />
    `</p>
<p>This is likely not the structure you expect or want to work with. You can convert it using a filter:</p>
<pre><code>`php
</code></pre>
<p>add_filter( ‘jekyll_export_meta’, function($meta) {<br />
    foreach ($meta as $key => $value) {<br />
        if (is_array($value) && count($value) === 1 && array_key_exists(0, $value)) {<br />
            $meta[$key] = $value[0];<br />
        }<br />
    }</p>
<pre><code>return $meta;
</code></pre>
<p>});<br />
    `</p>
<p>A more complete solution could look like that:</p>
<pre><code>`php
</code></pre>
<p>add_filter( ‘jekyll_export_meta’, function($meta) {<br />
    foreach ($meta as $key => $value) {<br />
        // Advanced Custom Fields<br />
        if (is_array($value) && count($value) === 1 && array_key_exists(0, $value)) {<br />
            $value = maybe_unserialize($value[0]);<br />
            // Advanced Custom Fields: NextGEN Gallery Field add-on<br />
            if (is_array($value) && count($value) === 1 && array_key_exists(0, $value)) {<br />
                $value = $value[0];<br />
            }<br />
        }<br />
        // convert types<br />
        $value = match ($key) {<br />
            // Advanced Custom Fields: “true_false” type<br />
            ‘my-bool’ => (bool) $value,<br />
            default => $value<br />
        };<br />
        $meta[$key] = $value;<br />
    }</p>
<pre><code>return $meta;
</code></pre>
<p>});<br />
    `</p>
<h3>Custom post types</h3>
<p>To export custom post types, you’ll need to add a filter (w.g. to your themes config file) to do the following:</p>
<pre><code>`php
</code></pre>
<p>add_filter( ‘jekyll_export_post_types’, function() {<br />
    return array(‘post’, ‘page’, ‘you-custom-post-type’);<br />
});<br />
    `</p>
<p>The custom post type will be exported as a Jekyll collection. You’ll need to initialize it in the resulting Jekyll site’s <code>_config.yml</code>.</p>
<h3>Developing locally</h3>
<h4>Prerequisites</h4>
<ol>
<li><code>sudo apt-get update</code></li>
<li><code>sudo apt-get install composer</code></li>
<li><code>sudo apt-get install php7.3-xml</code></li>
<li><code>sudo apt-get install php7.3-mysql</code></li>
<li><code>sudo apt-get install php7.3-zip</code></li>
<li><code>sudo apt-get install php-mbstring</code></li>
<li><code>sudo apt-get install subversion</code></li>
<li><code>sudo apt-get install mysql-server</code></li>
<li><code>sudo apt-get install php-pear</code></li>
<li><code>sudo pear install PHP_CodeSniffer</code></li>
</ol>
<h4>Bootstrap & Setup</h4>
<ol>
<li><code>git clone https://github.com/benbalter/wordpress-to-jekyll-exporter</code></li>
<li><code>cd wordpress-to-jekyll-exporter</code></li>
<li><code>script/bootstrap</code></li>
<li><code>script/setup</code></li>
</ol>
<h4>Running tests</h4>
<pre><code>script/cibuild<h3>Testing locally via Docker</h3>
</code></pre>
<p>1. <code>git clone https://github.com/benbalter/wordpress-to-jekyll-exporter</code><br />
2. <code>docker-compose up</code><br />
3. <code>open localhost:8088</code></p>
<h3>Minimum required PHP version</h3>
<p>Many shared hosts may use an outdated version of PHP by default. <strong>WordPress to Jekyll Export requires PHP 5.6 or greater.</strong></p>
<p>If you get an error message that looks like <code>unexpected T_STRING</code>, <code>unexpected '['</code> or <code>expecting T_CONSTANT_ENCAPSED_STRING</code>, 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.</p>
<p>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 <a href="https://www.php.net/supported-versions.php" rel="nofollow ugc">oldest supported version</a>.</p>
<h4>How to determine which version of PHP you’re running</h4>
<ul>
<li>Try <a href="https://wordpress.org/plugins/display-php-version/" rel="ugc">this plugin</a></li>
<li>Follow <a href="https://codex.wordpress.org/Finding_Server_Info" rel="nofollow ugc">WordPress’s tutorial</a> or <a href="https://www.wikihow.com/Check-PHP-Version" rel="nofollow ugc">this wikihow</a></li>
</ul>
<h4>How to upgrade your version of PHP</h4>
<p>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 <a href="https://kb.yoast.com/kb/how-to-update-your-php-version/" rel="nofollow ugc">this list of common hosts</a> for more details.</p>


Github Shortcode vs Jekyll Exporter