Skip to content

Colinsp/knowledgebase

 
 

Repository files navigation

WordPress Plugin Version License WordPress Tested Build Status Scrutinizer Code Quality Code Climate

Knowledgebase

Requires: 4.1

Tested up to: 4.7

License: GPL-2.0+

Plugin page: Knowledgebase | WordPress.org Plugin page

The easiest way to create a Knowledgebase or FAQ on your WordPress blog.

Description

As the name suggests, Knowledgebase will allow you to create a simple Knowledgebase / FAQ section on your WordPress blog.

The plugin was born after I tried several free plugins and themes out there and that couldn't fit my purpose. It's designed to be very easy to install and use out of the box and I'll be adding more features into the core and as addons.

The plugin uses a custom post in conjunction with custom taxonomies to create and display your knowledgebase.

Main features:

  • Uses a custom post type wz_knowledgebase with a slug of wzkb ensuring your data always stays even if you choose to delete this plugin
  • Customizable permalinks: Archives are enabled so your knowledgebase can be viewed at /knowledgebase/ automatically on activation. You can change this in the Settings page
  • Uses Categories ( kbcategory ) to automatically draw up the knowledgebase. You will need at least one category in order to display the knowledgebase
  • Additionally tags ( kbtags ) can also be used for each knowledgebase article
  • Shortcode [[knowledgebase]] will allow you to display the knowledgebase on any page of your choosing
  • Inbuilt styles to display the knowledge beautifully
  • Supports unlimited level of categories

Contribute

Knowledgebase is fully functional and in fact, I use this to power https://webberzone.com/support/knowledgebase. However, there are still many features that I plan to add to this plugin. This includes inbuilt templates for articles, live search, etc.

If you have an idea, I'd love to hear it. Knowledgebase is also available on Github. You can create an issue on the Github page or, better yet, fork the plugin, add a new feature and send me a pull request.

Screenshots

Knowledgebase Menu in the WordPress Admin

Knowledgebase Menu in the WordPress Admin

For more screenshots visit the WordPress plugin page

Installation

WordPress install (The easy way)

  1. Navigate to “Plugins” within your WordPress Admin Area
  2. Click “Add new” and in the search box enter “Knowledgebase”
  3. Find the plugin in the list (usually the first result) and click “Install Now”
  4. Activate or Network activate the Plugin in WP-Admin under the Plugins screen

Manual install

Download the plugin

  1. Extract the contents of knowledgebase.zip to wp-content/plugins/ folder. You should get a folder called knowledgebase.
  2. Activate or Network activate the Plugin in WP-Admin under the Plugins screen
  3. Create a new page or edit an existing one and add the shortcode [knowledgebase] to set up this page to display the knowledgebase
  4. Visit Knowledgebase » Add New to add new Articles to the knowledgebase
  5. Visit Knowledgebase » Sections to add new categories to the knowledgebase. Alternatively, you can add new categories from the meta box in the Add New page

The plugin supports unlimited levels of category hierarchy, however, the recommended setting for creating the knowledge base is to create a top level category with the name of the knowledgebase and sub-level categories for each section of this knowledgebase. Check out the Category view screenshot as an example.

Knowledgebase Category view in the WordPress Admin

Frequently Asked Questions

Check out the FAQ on the plugin page.

If your question isn't listed there, please create a new post at the WordPress.org support forum. It is the fastest way to get support as I monitor the forums regularly. I also provide premium paid support via email.

404 errors on the knowledgebase

This is usually because of outdated permalinks. To flush the existing permalinks rules simply visit Settings » Permalinks in your WordPress admin area.

Shortcode

You can display the knowledgebase anywhere in your blog using the [knowledgebase] shortcode. The shortcode takes one optional attribute category:

[knowledgebase category="92"]

category : Category ID for which you want to display the knowledge base. You can find the ID in the Sections listing under the Knowledgebase menu in the WordPress Admin.

You can also display the search form using [kbsearch]

Using your own templates for archives and search

Knowledgebase comes inbuilt with a set of custom templates to display archives of the articles, category archives as well as search results. You can easily override any of these templates by creating your own template in your theme's folder

  1. Articles archive: archive-wz_knowledgebase.php
  2. Category archive: taxonomy-wzkb_category.php
  3. Search results: search-wz_knowledgebase.php

How do I sort the posts or sections?

The plugin doesn't have an inbuilt feature to sort posts or sections. You will need an external plugin like Intuitive Custom Post Order which allows you to easily drag and drop posts, sections or tags to display them in a custom order.

About this repository

This GitHub repository always holds the latest development version of the plugin. If you're looking for an official WordPress release, you can find this on the WordPress.org repository. In addition to stable releases, latest beta versions are made available under releases.

About

The easiest way to add a Knowledgebase / FAQ to your WordPress blog

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • PHP 92.0%
  • Shell 4.5%
  • CSS 3.5%