Documents from Git
A plugin to inject and render files in a WordPress post or page directly from most popular Git platforms. Currently supported file types: Markdown, J …
The facts
- Rating
- 5★ from 3
- Active installs
- 200+
- Price
- Free
- Last updated
- 9 Oct 2021
- Added
- Apr 2020
- Requires WP
- 5.0.0
- Tested up to
- WP 5.8.15
- Requires PHP
- 7.0
- Downloads
- 7,775
Our analysis
AI-assistedDocuments from Git is a WordPress plugin that allows you to publish and manage Markdown and Jupyter notebook documents directly from remote Git platforms like GitHub, Bitbucket, and GitLab. It supports version control, enabling you to publish different versions of documents in various posts and facilitating updates through reader pull requests.
The plugin uses GitHub’s markdown API to render documents as HTML. It features shortcodes for easy document publishing and offers caching options to manage API rate limits effectively. This plugin is suitable for users who want to integrate version-controlled documents into their WordPress site.
Best for: This plugin suits users who want to publish technical documents or tutorials on their WordPress site using version control.
What it does well
- ✓Supports Markdown and Jupyter notebook formats
- ✓Integrates with GitHub, Bitbucket, and GitLab
- ✓Allows version control for documents
- ✓Features shortcodes for easy publishing
- ✓Offers caching options to manage API requests
Where it falls short
- •Markdown content is limited to 400 KB
- •Requires authentication for higher API rate limits
Verdict
Documents from Git provides a practical solution for integrating Git-based document management into WordPress. However, the limitations on document size and API usage may affect some users.
From the developer
nilsnolde's own description of Documents from Git, lightly tidied.
Official documentation: https://github.com/gis-ops/wordpress-markdown-git
This WordPress Plugin lets you easily publish, collaborate on and version control your [Markdown, Jupyter notebook] documents directly from your favorite remote Git platform, even if it’s self-hosted.
The advantages are:
- Write documents in your favorite editor and just push to your remote repository to update your blog instantly
- Use the power of version control: publish different versions of the document in different posts, i.e. from another branch or commit than latest
master - Easy to update by your readers via pull requests, minimizing the chance of stale tutorials
The following document types are currently supported:
- Markdown
- Jupyter notebooks (only for public repositories)
The following platforms are currently supported:
- Github
- Bitbucket
- Gitlab
Usage
Note, this plugin uses Github’s wonderful /markdown API to render to HTML. This comes with 2 caveats:
- Unless authenticated, the rate limit is set at 60 requests per minute. Since v1.1.0 the plugin is capable of statically caching content. In case that’s not dynamic enough for you, your only option currently is to not use any cache in which case every document will be pulled from your provider every time someone opens it on your site. Then it’s strongly recommended to create a Github access token and register it with the plugin. Then the rate limit will be set to 5000 requests per hour. See Global attributes section for details on how to do that.
- The Markdown content cannot exceed 400 KB, so roughly 400 000 characters incl whitespace. If not a monographic dissertation, this should not be an applicable limit though.
Shortcodes
The plugin features a variety of shortcodes.
Publish documents
The document-specific shortcodes follow a pattern of [git-<platform>-<action>], where
<platform>can be one ofgithub: if you use Github as your VCS platformbitbucket: if you use Bitbucket as your VCS platformgitlab: if you use Gitlab as your VCS platform