Customize your Documentation

The main advantage WP Help Scout Docs offers over Help Scout Docs and other support SaaS is it’s endless options for customization.

By default, WP Help Scout Docs uses your theme’s archive template to display articles in a certain category, and the post template to display articles. This should (in most cases) give your documentation the same look and feel of the rest of your website.

Should you still want to customize the look and feel, WP Help Scout Docs offers several ways to customize it.

Shortcode

Upon activation, a page is created for you, containing the following shortcode:

[docs_base]
Code language: JSON / JSON with Comments (json)

This shortcode shows a list containing all categories in your Help Scout Docs, and each list item links to the corresponding category.

Use archive instead of “base” page

If you’d much rather use your theme’s Archive template, you can disable the use of the above mentioned “base” page, by adding the WP_HELPSCOUT_DOCS_ARCHIVE constant to your wp-config.php as follows:

define( 'WP_HELPSCOUT_DOCS_ARCHIVE', true );
Code language: JavaScript (javascript)