Git it Write is a WordPress plugin which 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.
This plugin is inspired from static site generators like Jekyll
, Next.js
, Gatsby.js
on how content is written is markdown. This is a similar idea for WordPress where markdown data is parsed from GitHub and published as posts.
π Live example: Source GitHub repository (/docs/
folder) to Posts published
π¦ Download/Install: Git it write on WordPress plugin repository
β‘ Getting started: Get started with Git it Write. Learn how to write .md
files and publish posts on WordPress.
This allows people to collaborate with the post, share edits and suggestions in GitHub which when pulled the WordPress post will be updated automatically.
If a repository has files in the below structure, then below posts will be created (if permalinks are configured and
the post type supports "hierarchy" i.e. creating posts level by level, like /pages
in the example below).
File structure in the GitHub repository:
docs/
guide/
introduction.md
getting-started.md
help/
faq.md
Generated web sides:
https://example.com/docs/guide/introduction/
https://example.com/docs/guide/getting-started/
https://example.com/help/faq/
dir1/hello.md
will be posted as dir1/hello/
in WordPress if the post type supports hierarchy._images
folder in the repository root. Markdown files have to relatively use them in the file.It is recommended that a permalink structure is enabled in the WordPress site so that, if you have file under docs/reference/my-post.md
then a post is published like https://example.com/docs/reference/my-post/
. 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 index.md
file if exists under that folder.
git-it-write
to the /wp-content/plugins/
directory.Plugins
menu in WordPress.Please visit the plugin documentation page for complete list of FAQs.
No. This plugin won't sync post content. It is a one way update. Only changes made to the GitHub repository will update the posts and not otherwise.
All markdown files will be published as posts.
Any folder/file starting with _
(underscore) and .
(dot) won't be considered for publishing.
Yes, if you want to pull posts from a branch in a repository then you can specify it in the plugin's repository settings page.
Yes, if you want to pull posts from the folder in a repository then you can specify it in the plugin's repository settings page. For example, if a repository has a folder website/main/docs
and if you want to pull only from docs folder, then you can specify website/main/docs
in the plugin settings.