DocuPress is a documentation plugin for WordPress that lets you, you guessed it, add documentation directly from your website’s WordPress dashboard.
This is the 6th free plugin I’ve released in the WordPress plugin repository and one that I definitely know I’m going to be using myself … a lot.
Why build a documentation plugin?
This has become a bit of a run-on story with me, but DocuPress was built for a self-serving reason; WP Dispensary needed better documentation than it had, and nothing I found fit my needs, so I built it.
In reality, there’s a few documentation plugins out there already and I’m sure I could have found something that worked well enough, but where’s the fun in that? ?
I had the original idea for DocuPress in December of 2015! ? and didn’t do anything else with it until about 4 months ago, when I created the initial core files for the plugin (which was just a boilerplate build from wppb.me).
A couple of weeks ago, I knew I had to do something about the WPD documentation, so I dove in and started writing code.
Again, I didn’t do much, but it did make it to my list of things to do, which was a step in the right direction.
Then, a couple of nights ago I had a couple of spare hours along with the urge to get it done, so I sat down and wrote code.
The rest, as they say, is history ✌
What does DocuPress actually do?
DocuPress is built as a custom post type for WordPress, along with a custom taxonomy for the collections, which act like categories.
After install and activation, you’ll see the Documentation tab in your dashboard.
This is where you can add new articles, which function similar to blog posts. You can also add the article to a specific collection, add a featured image and publish it.
There’s also a custom widget added which you can use to display all recent articles from your documentation.
It also comes with the ability to change which collection it will display articles from, so you can easily have multiple widgets for multiple collections of articles.
You’re also able to randomize the articles that are displayed, and also add a “view all” link to the bottom of the widget (only displays if you choose a specific Collection, not if “All” is selected).
In the pipeline
I’m working on adding some shortcodes to make it easy to create your own documentation page, as well as the ability for DocuPress to create a documentation page upon activation.
Approaching this right will take some time to think through and plan out properly, but it’s definitely in the works.
I’ve got a couple of other ideas as well, but want to keep those close to the chest right now while I take feedback from users ?
As I mentioned earlier, I built DocuPress to handle the documentation for WP Dispensary, and that’s where you can currently view the plugin in action.
The demo is using the Beaver Builder plugin to add the DocuPress widgets side-by-side in a grid format.
Where can I download DocuPress?
You can download DocuPress directly from your dashboard, by going to
Plugins - Add New
and searching for DocuPress.