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 !

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

An, Hyeong-woo

<p>The plugin get markdown file URL like github raw content url. The plugin convert markdown file to html, and put it to post content.</p>
<p>It also provide text mode that write markdown in post edit page. Markdown text converted to html is put to editor. Text mode don’t use url.</p>
<p>이 플러그인은 마크다운 파일의 URL을 받아서 html로 변환하고 그걸 포스트 내용으로 집어넣습니다.<br />
기트허브 원본 내용 URL 같은 것을 활용할 수 있습니다.</p>
<p>포스트 편집 페이지에서 마크다운 텍스트를 작성하는 방법도 제공합니다. 마크다운 텍스트는 html로 변환돼 에디터에 들어갑니다.<br />
텍스트 모드를 사용하는 경우 URL은 사용하지 않습니다.</p>
<p><strong><a href="https://www.youtube.com/watch?v=wKcrIvlGVfo" rel="nofollow ugc">See intro video.</a></strong></p>
<span class="embed-youtube" style="text-align:center; display: block;"><iframe loading="lazy" class="youtube-player" width="750" height="422" src="https://www.youtube.com/embed/wKcrIvlGVfo?version=3&rel=1&showsearch=0&showinfo=1&iv_load_policy=1&fs=1&hl=en-US&autohide=2&wmode=transparent" allowfullscreen="true" style="border:0;" sandbox="allow-scripts allow-same-origin allow-popups allow-presentation allow-popups-to-escape-sandbox"></iframe></span>
<h4>Now you can migrate from Public link to Dropbox API</h4>
<p>I made up Mytory Markdown for Dropbox plugin. The plugin access Dropbox using API. So I divide the plugin to Mytory Markdown for Dropbox.<br />
Now you can install it in plugin page. This video describe how to migrate Public link to Dropbox API.</p>
<p>Install Mytory Markdown for Dropbox and activate it. Then see a video below.</p>
<p>[Youtube https://www.youtube.com/watch?v=ZmPWMBvGuS4]</p>
<p>If the video doesn’t be show, <a href="https://www.youtube.com/watch?v=ZmPWMBvGuS4" rel="nofollow ugc">click this to go to how to migration video</a>.</p>
<h4>이제 Public 링크를 드롭박스 API로 이전할 수 있습니다</h4>
<p>Mytory Markdown for Dropbox 플러그인을 만들었습니다. API를 이용해서 드롭박스에 접속하는 플러그인입니다. 별도로 만들었습니다.<br />
지금 플러그인 페이지에서 검색해 설치할 수 있습니다. 아래 비디오는 퍼블릭 링크를 드롭박스 API로 이전하는 방법을 설명합니다.</p>
<p>Mytory Markdown for Dropbox 플러그인을 설치한 뒤, 활성화하고 아래 비디오를 보세요.</p>
<p>(비디오는 위에서 보세요.)</p>
<h4>Features</h4>
<ul>
<li>This plugin get markdown file url like github raw content url. It convert markdown file to html, and put it to post content.</li>
<li>You can update post <strong>by editing file on your computer</strong>. e.g. <strong>By push your content to github</strong>. Of course, you can edit directly from github website.</li>
<li>If post was updated once, plugin check only URL server’s ETAG not full content. It is for speed.<br />
If ETAG was changed, plugin get new content and update post content. Or do nothing.</li>
<li>The plugin only pass converted html content to editor. Saving is WordPress’s work. So revision history is preserved.</li>
<li>The plugin is compatible with other plugins. Because the plugin updates only post content html. This doesn’t touch <code>the_content</code> process(vary plugins touch the process).</li>
<li>You can use <a href="http://michelf.ca/projects/php-markdown/extra/" rel="nofollow ugc">markdown extra syntax</a>.</li>
<li>It provide markdown editor that can use in post editing page instead of url.</li>
</ul>
<h4>Logic</h4>
<h4>On admin page</h4>
<p>On admin write page, put markdown url path. And click ‘update editor’ button. So markdown content converted to html is putted to editor. <a href="https://wordpress.org/plugins/mytory-markdown/screenshots/" rel="ugc">See screenshot 1</a>.</p>
<h4>On view page</h4>
<p>This plugin get file url(Github raw content url is recommended). And save header’s etag to postmeta and converted html to post_content.<br />
Next time on request same post, first this plugin olny get http etag.<br />
If changed etag, get md content and save again, or get html from post_content.</p>
<h4>This plugin divide title and content from md file</h4>
<p>If markdown file has <code>h1</code> this plugin puts first <code>h1</code> string to post_title. Of course, remove the <code>h1</code> from post_content so don’t print title twice.</p>
<h4>Source Code</h4>
<p><a href="https://github.com/mytory/mytory-markdown" rel="nofollow ugc">Mytory Markdown Github</a></p>
<h4>You can use Multimarkdown 6</h4>
<p>You can use the Muitimarkdown if you install it on your server. ((Website)[https://fletcher.github.io/MultiMarkdown-6/])</p>
<ol>
<li>
<p>Multimarkdown option will be enabled if a multimarkdown execution is on OS PATH and web server can run it.</p>
</li>
<li>
<p>Otherwise, you can define <code>MYTORY_MARKDOWN_MULTIMARKDOWN_EXECUTION</code> constant on <code>wp-config.php</code>.<br />
ex) <code>define('MYTORY_MARKDOWN_MULTIMARKDOWN_EXECUTION', '/opt/multimarkdown/bin/multimarkdown');</code></p>
</li>
</ol>


Mytory Markdown

The plugin get markdown file URL like github raw content url. It convert markdown file to html, and put it to post content.

Git it Write – Write posts from GitHub vs Mytory Markdown