Table Of Contents
Need to add documentation to one of your Divi websites? Documentation allows you to provide all kinds of helpful information to your readers and customers. But because documentation is its own content type, you probably don’t want to intermingle documentation content with regular WordPress posts or pages.
So to show you how to add documentation to WordPress (and, more specifically, to a WordPress install running the Divi WordPress theme), I’m going to give you a quick tutorial on how to use a new free plugin called DocuPress.
What is DocuPress And What Does It Do?
DocuPress is a free tool for adding documentation to any WordPress site. It’s developed by Robert DeVore and was born from Robert’s need for a lightweight documentation tool for some of his other WordPress development projects.
While there are plenty of heavy-duty knowledge base solutions for WordPress, DocuPress is helpful if you’re just looking to add some basic documentation to your site. That is, if you don’t need heaps of shortcodes and built-in analytics.
Here’s what DocuPress actually does when you install it:
- Creates a new Documentation custom post type
- Adds a new Collections custom taxonomy to divide your documentation into different categories.
- Gives you a widget to allow you to easily display documentation items in your sidebar or in the content you build with the Divi Builder (or other tools that let you display widgets inside your posts).
In the future, Robert has plans to add some basic shortcodes to give you even more flexibility.
If you want to see DocuPress in action, you can check out a real-world example at the documentation for Robert’s WP Dispensary plugin.
We should stress that this plugin is brand new. While it’s not doing anything especially complex, you should still always keep that mind before going all in right away.
How to Use DocuPress to Create Documentation
Now that you know what it does, here’s how you can actually use DocuPress to create documentation for your own WordPress site.
Step 1: Install and Activate DocuPress
DocuPress is available for free at the WordPress.org plugin repository, so you can install it directly from your WordPress dashboard.
Once it’s installed, there’s nothing you need to configure. Remember – this is a lightweight solution!
Step 2: Add Your Documentation Collections
Once you activate DocuPress, you should see a new Documentation custom post type. But before you start adding documentation articles, you should add some collections to categorize your articles.
To do that, head to Documentation → Collections. Fill in the details and click Add New Collection. This functions pretty much identically to a category for a normal WordPress post:
Add as many collections as you think you need to adequately divide up your documentation articles.
Step 3: Add Your Documentation Articles
Once you have your collections, head to Documentation → Add New to add actual documentation articles. This is pretty much the normal WordPress Editor except with one key addition.
Give your article a title and enter the post content. Then, select your Collection like you would a category for a normal WordPress post.
The only new thing you need to do is choose the Article Attributes → Order in the bottom right. This defines the order in which your articles display in the widget. For example:
- 0 displays first
- 1 is next on the list
- And so on.
Then, make sure to Publish your article.
Repeat the process for as many documentation articles as you need.
Step 4: Display Your Documentation Collections
Once you’ve added all of your collections and articles, you’re ready to display them on the front-end. To do that, you can use the included widget to add documentation listings to:
- Your sidebar
- Content you build with the Divi Builder (or another tool that allows you to use widgets in your content)
The sidebar is simple – just head to Appearance → Widgets and drag over the DocuPress Articles widget:
You can choose:
- The title that displays above the list of documentation articles
- How many documentation articles to show
- Whether to show all collections or a specific collection
- Whether or not to randomize the article order
If you’d like to show your documentation listings in your content instead of your sidebar, you can use Divi’s Sidebar Module instead.
To do that, start by adding a new Widget at the bottom of the Widgets area:
Once you do that, you’ll have a new Documentation sidebar area that you can add the DocuPress widget to:
If you want to display different sections, you can add multiple DocuPress widgets to this sidebar.
Then, head to the Divi Builder for the page you want to add your documentation to. Add a new Sidebar Module and select the Documentation area that you just created:
Then, assuming you’re using the Visual builder, you should see your documentation categories:
Like all Divi modules, you can also play around with the styling in the Design tab if you want to, say, change the font color and size for the documentation category headings:
And you can, of course, add other Divi modules as needed to spice up your documentation page. But that’s all you need to do to add the core documentation functionality.
If you need to add your documentation to a page without the Divi Builder, you can also use a plugin like Widget Shortcode to be able to pull in the DocuPress widget via a shortcode.
All in all, DocuPress is a pretty simple solution for creating and managing documentation in WordPress. Don’t expect tons of bells and whistles, but if you just want something simple and lightweight, it’s a good option.
And while it probably wouldn’t take you too long to create something similar for yourself with custom post types, this way you don’t need to get your hands dirty.
Like I mentioned, Robert does have plans to add some built-in shortcodes, so the plugin should soon become even easier to use.
Now over to you – what do you think about using something lightweight like DocuPress for your or your client’s documentation? Do you prefer this approach to some of the more heavy-duty documentation plugins out there?
Article thumbnail image by turali / shutterstock.com