vaakash

<p>Git it Write allows to publish the markdown files present in a GitHub repository to your WordPress site. So with this plugin, whenever the files are added, updated in the repository the WordPress post will be added, updated accordingly.</p>
<p>This plugin is inspired from static site generators like <code>Jekyll</code>, <code>Next.js</code>, <code>Gatsby.js</code> on how content is written is markdown. This is a similar idea for WordPress where markdown files are parsed from GitHub and published as posts.</p>
<p>👓 <strong>Live example:</strong> <a href="https://github.com/vaakash/aakash-web" rel="nofollow ugc">Source github repository</a> (<code>/docs/</code> folder) to <a href="https://www.aakashweb.com/docs/" rel="nofollow ugc">Posts published</a></p>
<p>⚡ <strong>Getting started:</strong> <a href="https://www.aakashweb.com/docs/git-it-write/getting-started/" rel="nofollow ugc">Get started</a> with Git it write. Learn how to write <code>.md</code> files and publish posts on WordPress.</p>
<p>This allows people to collaborate with the post, share edits and suggestions in GitHub which when pulled the WordPress post will be updated automatically.</p>
<p>If a repository has files in the below structure,</p>
<pre><code>docs/
    guide/
        introduction.md
        getting-started.md
help/
    faq.md
</code></pre>
<p>Then below posts will be created like below (if permalinks are configured and the post type supports “hierarchy” i.e creating posts level by level (example: pages))</p>
<pre><code>https://example.com/docs/guide/introduction/
https://example.com/docs/guide/getting-started/
https://example.com/help/faq/
</code></pre>
<h3>🎲 What is the use of this plugin ?</h3>
<ul>
<li>Publish posts using the files in your GitHub repository.</li>
<li>Write your posts in Markdown format.</li>
<li>Write your posts on your desktop application (Notepad++, Sublime Text, Visual studio code).</li>
<li>Collaborate, involve communities on the files in GitHub and publish them on WordPress.</li>
<li>All the advantages of Git and it’s version management system.</li>
</ul>
<h3>🚀 Some use cases</h3>
<ul>
<li>Can be used for documentation posts, FAQs, Wikis etc.</li>
<li>Write blog posts.</li>
<li>Any articles which may need community involvement.</li>
</ul>
<h3>✨ Features</h3>
<ul>
<li>Markdown will be processed and post will be published as HTML.</li>
<li>Images used in the source file will be uploaded to WordPress.</li>
<li>Relative links are supported.</li>
<li>Set post properties like post status, title, order, category, tags etc, in the source file itself.</li>
<li>Webhook support (whenever repository is changed, it updates the plugin to pull the latest changes and publish the posts)</li>
<li>Add multiple repositories.</li>
<li>Publish to any post type.</li>
<li>Posts are published in hierarchial manner if they are under folders. Example: a file <code>dir1/hello.md</code> will be posted as <code>dir1/hello/</code> in WordPress if the post type supports hierarchy.</li>
<li>Support for post metadata like setting tags, categories, custom fields.</li>
</ul>
<h3>ℹ Note</h3>
<ul>
<li>Only Markdown files will be pulled and published right now</li>
<li>Posts won’t be deleted when it’s source file is deleted on GitHub.</li>
<li>It is preferred to have a permalink structure.</li>
<li>It is preferred to select a post type which supports hierarchy.</li>
<li>Images have to present only in <code>_images</code> folder in the repository root. Markdown files have to relatively use them in the file.</li>
</ul>
<h3>🥗 Recommendation</h3>
<p>It is recommended that a permalink structure is enabled in the WordPress site so that, if you have file under <code>docs/reference/my-post.md</code> then a post is published like <code>https://example.com/docs/reference/my-post/</code>. This will be the result when post type has hierarchy support. They will be posted level by level for every folder in the repository. The folder’s post will be taken from the <code>index.md</code> file if exists under that folder.</p>
<h3>🏃‍♂️ Using the plugin</h3>
<ol>
<li>Have a GitHub repository where all the source files (markdown files) are maintained (organized in folders if needed the exact structure)</li>
<li>In the plugin settings page, click add a new repository.</li>
<li>Enter the details of the repository to pull the posts from and under what post type to publish them.</li>
<li>Save the settings</li>
<li>Click “Pull the posts” and then “Pull only” changes. This will publish posts for all the markdown files.</li>
<li>To automatically update posts whenever repository is updated, configure webhook as mentioned in the settings page.</li>
</ol>
<h3>Links</h3>
<ul>
<li><a href="https://www.aakashweb.com/docs/git-it-write/" rel="nofollow ugc">Documentation</a></li>
<li><a href="https://www.aakashweb.com/forum/" rel="nofollow ugc">Support forum/Report bugs</a></li>
<li><a href="https://www.paypal.me/vaakash/" rel="nofollow ugc">Donate</a></li>
<li><a href="https://github.com/vaakash/git-it-write" rel="nofollow ugc">Contribute on GitHub</a></li>
</ul>


Git it Write – Write posts from GitHub

You will like it !

Sometimes commits and pushes don't reflect properly, but that's enough.
This is the way I wanted it.

Great

Publish markdown files present in a GitHub repository as posts to WordPress automatically

Boone Gorges

Jeremy Boggs

sramsay

janaremy

gossettphd

patrickmj

<p>Anthologize is a free, open-source, WordPress-based platform for publishing. Grab posts from your WordPress blog, pull in feeds from external sites, or create new content directly in Anthologize. Then outline, order, and edit your work, crafting it into a coherent volume for export in several ebook formats, including PDF, EPUB, and TEI.</p>
<p>Visit <a href="http://anthologize.org/" title="Anthologize" rel="nofollow ugc">anthologize.org</a> to learn more about Anthologize.</p>
<h3>Usage</h3>
<p>Many optimizations to the PDF export have been added, but resource limits on the server will always be a potential issue. Here are some tips to try if you encounter errors or white screens of death while exporting PDF:</p>
<ol>
<li>Include page breaks between parts and items. This appears to reduce the memory that the PDF classes (TCPDF) require.</li>
<li>Change the following information in the php.ini file in the Resource Limits section. On most hosted servers, this file is in the top web directory and/or in your WordPress directory. If there is one in your WordPress directory, edit that one. If you have questions, please contact your web hosting provider.</li>
</ol>
<p>Change the max_execution_time setting:<br />
max_execution_time = 180;</p>
<p>Change the memory_limit setting:<br />
memory_limit = 128M;</p>
<p>The latest release of PHP has a default memory limit of 128M, but this might not be in place on your server. Increasing the execution time (measured in seconds) can also help.<br />
In a hosted server environment, increasing the resources Anthologize consumes could hurt performance for everyone else on your server. It might be worth consulting your hosting company before increasing these resource limits and exporting projects on a regular basis.</p>
<p>Cover images in ePub output.</p>
<p>To add your own cover images, just upload them to the anthologize/templates/epub/covers directory and they will appear as options in the export screen. Make sure they are readable by the server.</p>
<h3>Who built this?</h3>
<p>Anthologize was built during <a href="http://oneweekonetool.org/" title="One Week | One Tool" rel="nofollow ugc">One Week | One Tool</a>, an NEH Summer Institute at George Mason University’s <a href="http://chnm.gmu.edu/" title="CHNM" rel="nofollow ugc">Center for History and New Media</a>.</p>
<p>Major sponsors of Anthologize:<br />
* <a href="http://www.neh.gov/divisions/odh" rel="nofollow ugc">The Office of Digital Humanities of the National Endowment for the Humanties</a><br />
* <a href="http://chnm.gmu.edu" rel="nofollow ugc">The Roy Rosenzweig Center for History and New Media</a><br />
* <a href="http://openlab.citytech.cuny.edu" rel="nofollow ugc">City Tech OpenLab</a><br />
* <a href="http://www.demokratie-dialog.de/" rel="nofollow ugc">Demokratie & Dialog e.V.</a></p>
<p>See the Credits page in the Anthologize dashboard for more details.</p>


Anthologize

Use the power of WordPress to transform your content into a book.

Git it Write – Write posts from GitHub vs Anthologize