Title: Git it Write – Write posts from GitHub Author: vaakash Published: augustus 15, 2020 Last modified: augustus 3, 2024 --- Search plugins ![](https://ps.w.org/git-it-write/assets/banner-772x250.png?rev=2362023) This plugin **hasn’t been tested with the latest 3 major releases of WordPress**. It may no longer be maintained or supported and may have compatibility issues when used with more recent versions of WordPress. ![](https://ps.w.org/git-it-write/assets/icon.svg?rev=2362025) # Git it Write – Write posts from GitHub By [vaakash](https://profiles.wordpress.org/vaakash/) [Download](https://downloads.wordpress.org/plugin/git-it-write.2.0.zip) * [Details](https://pap-aw.wordpress.org/plugins/git-it-write/#description) * [Reviews](https://pap-aw.wordpress.org/plugins/git-it-write/#reviews) * [Installation](https://pap-aw.wordpress.org/plugins/git-it-write/#installation) * [Development](https://pap-aw.wordpress.org/plugins/git-it-write/#developers) [Support](https://wordpress.org/support/plugin/git-it-write/) ## Description 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. 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 files are parsed from GitHub and published as posts. 👓 **Live example:** [Source github repository](https://github.com/vaakash/aakash-web)(`/ docs/` folder) to [Posts published](https://www.aakashweb.com/docs/) ⚡ **Getting started:** [Get started](https://www.aakashweb.com/docs/git-it-write/getting-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, ``` docs/ guide/ introduction.md getting-started.md help/ faq.md ``` 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)) ``` https://example.com/docs/guide/introduction/ https://example.com/docs/guide/getting-started/ https://example.com/help/faq/ ``` ### 🎲 What is the use of this plugin ? * Publish posts using the files in your GitHub repository. * Write your posts in Markdown format. * Write your posts on your desktop application (Notepad++, Sublime Text, Visual studio code). * Collaborate, involve communities on the files in GitHub and publish them on WordPress. * All the advantages of Git and it’s version management system. ### 🚀 Some use cases * Can be used for documentation posts, FAQs, Wikis etc. * Write blog posts. * Any articles which may need community involvement. ### ✨ Features * Markdown will be processed and post will be published as HTML. * Images used in the source file will be uploaded to WordPress. * Relative links are supported. * Set post properties like post status, title, order, category, tags etc, in the source file itself. * Webhook support (whenever repository is changed, it updates the plugin to pull the latest changes and publish the posts) * Add multiple repositories. * Publish to any post type. * Posts are published in hierarchial manner if they are under folders. Example: a file `dir1/hello.md` will be posted as `dir1/hello/` in WordPress if the post type supports hierarchy. * Support for post metadata like setting tags, categories, custom fields. ### ℹ Note * Only Markdown files will be pulled and published right now * Posts won’t be deleted when it’s source file is deleted on GitHub. * It is preferred to have a permalink structure. * It is preferred to select a post type which supports hierarchy. * Images have to present only in `_images` folder in the repository root. Markdown files have to relatively use them in the file. ### 🥗 Recommendation 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. ### 🏃‍♂️ Using the plugin 1. Have a GitHub repository where all the source files (markdown files) are maintained( organized in folders if needed the exact structure) 2. In the plugin settings page, click add a new repository. 3. Enter the details of the repository to pull the posts from and under what post type to publish them. 4. Save the settings 5. Click “Pull the posts” and then “Pull only” changes. This will publish posts for all the markdown files. 6. To automatically update posts whenever repository is updated, configure webhook as mentioned in the settings page. ### Links * [Documentation](https://www.aakashweb.com/docs/git-it-write/) * [Support forum/Report bugs](https://www.aakashweb.com/forum/) * [Donate](https://www.paypal.me/vaakash/) * [Contribute on GitHub](https://github.com/vaakash/git-it-write) ## Screenshots * [[ * Your files in a GitHub repository * [[ * Posts pulled and published from GitHub. * [[ * Content of the published post. * [[ * Published post. * [[ * Plugin admin page. * [[ * Repository configuration page. ## Installation 1. Extract the zipped file and upload the folder `git-it-write` to to `/wp-content/ plugins/` directory. 2. Activate the plugin through the `Plugins` menu in WordPress. 3. Open the admin page from the “Git it Write” link under the settings menu. ## FAQ Please visit the [plugin documentation page](https://www.aakashweb.com/docs/git-it-write/) for complete list of FAQs. ### When a post is edited in WordPress will that update the file in the GitHub repository ? 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. ### What all files in the repository will be published ? All markdown files will be published as posts. ### What are not published ? Any folder/file starting with `_` (underscore), `.` (dot) won’t be considered for publishing. ### Can I pull posts from a specific branch in the repository ? 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. ### Can I pull posts from a specific folder in the repository ? Yes, if you want to pull posts from a 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. ## Reviews ![](https://secure.gravatar.com/avatar/ced1b4f37979b3100f411c87679ca44da3b4e77b50efb223cfbc614296a7c864? s=60&d=retro&r=g) ### 󠀁[Beautiful!](https://wordpress.org/support/topic/beautiful-408/)󠁿 [marashmallow](https://profiles.wordpress.org/marashmallow/) juni 6, 2025 1 reply Does exactly what it says with no extraneous fuss! ![](https://secure.gravatar.com/avatar/5a3159e1ab540cfd9dc2b7b6d4288c6c6d63dcd8011bcd5318bde06a86840344? s=60&d=retro&r=g) ### 󠀁[Good idea that unfortunately only works partially](https://wordpress.org/support/topic/good-idea-that-unfortunately-only-works-partially/)󠁿 [Rico F. Lüthi](https://profiles.wordpress.org/rfluethi/) mei 9, 2024 1 reply Thank you for developing this plugin; it meets perfectly my needs. According to the settings, it should be possible to import data from the specific GitHub folder“ website/main/docs”. Unfortunately, this feature does not work as the folder structure can only be specified on one level. After consulting the developer, I was informed that this is a bug that was supposed to be fixed within a few days. However, the issue still persists three months later and even after a new version was released. I would have greatly appreciated clearer communication regarding this issue. The features promised in the plugin and by the support team should be reliably delivered. Unfortunately, I now find myself compelled to look for alternative solutions. ![](https://secure.gravatar.com/avatar/e10d2a9aacf0e456945701046bb6680c6832071a4aa16dbe5f5e2d603e21ab9f? s=60&d=retro&r=g) ### 󠀁[Excellent Plugin. Much needed](https://wordpress.org/support/topic/excellent-plugin-much-needed/)󠁿 [vigneshsweekaran](https://profiles.wordpress.org/vigneshsweekaran/) januari 26, 2024 Excellent Plugin. Much needed. ![](https://secure.gravatar.com/avatar/6150f45c1b8aaa6a4a7f0619f99c2283a18d4329d1fea04424f009e1277a3f2c? s=60&d=retro&r=g) ### 󠀁[Amazing Plugin!](https://wordpress.org/support/topic/amazing-plugin-2268/)󠁿 [thejokertm](https://profiles.wordpress.org/thejokertm/) october 8, 2022 1 reply I cannot recommend this plugin enough, it is the only viable solution to synch a markdown git repository with your WordPress page. Aakash is always quick to help you out if you have any questions. ![](https://secure.gravatar.com/avatar/bc6e6d31fab866a5b5772a63a7631d18f8d4a95a64ff8abddf083bf199217724? s=60&d=retro&r=g) ### 󠀁[Awesome Plugin and concept](https://wordpress.org/support/topic/awesome-plugin-and-concept/)󠁿 [dinesh6777](https://profiles.wordpress.org/dinesh6777/) mei 14, 2022 1 reply Easy interface to use. And very useful for collaborative docs and community pages. ![](https://secure.gravatar.com/avatar/e910665359cb329b538ebff11861a0f552bde241635316085b47c6c6e5a840b1? s=60&d=retro&r=g) ### 󠀁[Great](https://wordpress.org/support/topic/great-13134/)󠁿 [Junglei Kim](https://profiles.wordpress.org/imjlk/) april 15, 2021 1 reply Sometimes commits and pushes don’t reflect properly, but that’s enough. This is the way I wanted it. [ Read all 7 reviews ](https://wordpress.org/support/plugin/git-it-write/reviews/) ## Contributors & Developers “Git it Write – Write posts from GitHub” is open source software. The following people have contributed to this plugin. Contributors * [ vaakash ](https://profiles.wordpress.org/vaakash/) [Translate “Git it Write – Write posts from GitHub” into your language.](https://translate.wordpress.org/projects/wp-plugins/git-it-write) ### Interested in development? [Browse the code](https://plugins.trac.wordpress.org/browser/git-it-write/), check out the [SVN repository](https://plugins.svn.wordpress.org/git-it-write/), or subscribe to the [development log](https://plugins.trac.wordpress.org/log/git-it-write/) by [RSS](https://plugins.trac.wordpress.org/log/git-it-write/?limit=100&mode=stop_on_copy&format=rss). ## Changelog ### 2.0 * Fix: Disable inline URLs from being converted to link tags. (Thanks to @SienciLabs for the report) ### 1.9 * Fix: Filename with multiple dots are ignored. ### 1.8 * New: Error message during HTTP get/post is now logged. * Fix: Double quotes in WordPress shortcodes are escaped. * Fix: GitHub access token field in admin form is converted to a password field. * Fix: Typos in readme and admin page. ### 1.7 * New: Images (`_images`) can be now organized in folders. * New: Featured image can now be set to posts. * New: Markdown images are now wrapped with `figure` tag and added support for image caption. * New: Image tags now have class attributes similar to WordPress editor. * Fix: Images were not uploaded for private repositories. (Thanks to https://github. com/lukaszpiotrluczak for the contribution) * Fix: Webhook publish request fails to upload images. ### 1.6 * New: Options like comment status, page template, sticky post can now be set. * New: New option to skip file from being published. ### 1.5 * New: Post date can now be set. * Fix: Enhancements to data escaping in the admin page. ### 1.4 * Fix: Repository not found issue by adding GitHub authentication. * Fix: Duplicate posts when filename has special characters. * Fix: PHP warning when directory has no index.md file. ### 1.3 * New: Support for git branches (Thanks to https://github.com/AppalachiaInteractive for the contribution) * New: Logs directory has been changed to the uploads directory. * Fix: Minor admin page enhancements. ### 1.2 * New: Support for custom fields * New: New shortcode attribute in `[giw_edit_link]` to automatically wrap in `p` tag. * Fix: Added permission callback for the webhook REST API. * Fix: Minor admin UI enhancements. ### 1.1 * New: Support for Parsedown extra ### 1.0.1 * Fix: Webhook is changed to `POST` method. * Fix: Readme formatting. ### 1.0 * First version of the plugin. ## Meta * Version **2.0** * Last updated **2 years ago** * Active installations **100+** * WordPress version ** 4.4 or higher ** * Tested up to **6.6.5** * PHP version ** 5.3 or higher ** * Language * [English (US)](https://wordpress.org/plugins/git-it-write/) * Tags * [editor](https://pap-aw.wordpress.org/plugins/tags/editor/)[Github](https://pap-aw.wordpress.org/plugins/tags/github/) [markdown](https://pap-aw.wordpress.org/plugins/tags/markdown/)[posts](https://pap-aw.wordpress.org/plugins/tags/posts/) [publish](https://pap-aw.wordpress.org/plugins/tags/publish/) * [Advanced View](https://pap-aw.wordpress.org/plugins/git-it-write/advanced/) ## Ratings 4.7 out of 5 stars. * [ 6 5-star reviews ](https://wordpress.org/support/plugin/git-it-write/reviews/?filter=5) * [ 0 4-star reviews ](https://wordpress.org/support/plugin/git-it-write/reviews/?filter=4) * [ 1 3-star review ](https://wordpress.org/support/plugin/git-it-write/reviews/?filter=3) * [ 0 2-star reviews ](https://wordpress.org/support/plugin/git-it-write/reviews/?filter=2) * [ 0 1-star reviews ](https://wordpress.org/support/plugin/git-it-write/reviews/?filter=1) [Your review](https://wordpress.org/support/plugin/git-it-write/reviews/#new-post) [See all reviews](https://wordpress.org/support/plugin/git-it-write/reviews/) ## Contributors * [ vaakash ](https://profiles.wordpress.org/vaakash/) ## Support Got something to say? Need help? [View support forum](https://wordpress.org/support/plugin/git-it-write/) ## Donate Would you like to support the advancement of this plugin? [ Donate to this plugin ](https://www.paypal.me/vaakash/)