HelpDocs ships with a bunch of nice looking templates that work great out of the box. You can customize our default templates easily with CSS and JavaScript to make them look however you like.
If you want to make large changes to the layout, that's where custom HTML templates come in.
Handlebars
We use Handlebars to give our HTML templates superpowers. Handlebars lets you do things like loop through arrays of tags and authors, and output HTML for each. It also lets you register and reuse partials which cleans up your HTML no end.
HelpDocs templates are compatible with all the syntax of Handlebars v3, with the addition of Inline Partials from Handlebars v4. Other v4 additions, like partial blocks, aren't supported.
We also support a number of helpers for Handlebars. We've built these helpers in-house to make common tasks like internationalization easier. You can read more about our helpers here.
Enabling Custom HTML Templates
- Head to Settings > Customize
- In the Design panel, find the Brand section

- Choose Custom from the Template dropdown

- Either use our a Starter template (based on one of our stock templates) or create your own from scratch:
- Using a Starter template. If you select this, you'll get a choice of which template to use as a starting point and which partials it'll override. Just click Start from a template in the callout

- Start from scratch. If you want to create it yourself, head to the HTML tab straight away. This is where you'll manage the HTML and Handlebars for each partial of your Knowledge Base

- Using a Starter template. If you select this, you'll get a choice of which template to use as a starting point and which partials it'll override. Just click Start from a template in the callout
Partials
Since you only have to provide the content for each page, not the whole HTML (include <head> tags, <link>s, etc.), we call each section you can edit a partial. There's 7 total partials, 6 of which you can edit. Here's a breakdown of what you'll find by heading to Settings > Customize > HTML.
Partial Name | Purpose |
|---|---|
default.hbs | This is the default template that includes the main layout of the HTML. It's maintained by us here at HelpDocs and isn't user editable. This is where we insert metadata for SEO, our required JavaScript libraries, add your integrations, etc. |
header.hbs | You should add your header bar and navigation in here. This appears on every page of your Knowledge Base. Depending on how you wanna structure your template, this might also be the right place for your search bar and maybe some secondary navigation like a sidebar. If you need to register inline partials for use in all templates, here's a good place to do that too. |
footer.hbs | This gets added after your main content (e.g. after the category or article that's being displayed). You can use this to mirror the footer on your main website, or add any scripts to your site that you want before the closing |
home.hbs | The entry point of your Knowledge Base. This is where you display all your categories, so users can easily navigate to a category or article. |
category.hbs | Display a single category and all its articles. |
article.hbs | Display a single article. |
search.hbs | Display search results. Custom templates ship with instant search as standard, but this page is shown when someone hits return in the search bar regardless. |
Context Data by Partial
We pass through context data you can use in the templates. This differs slightly on each partial so you only have the information that's actually relevant to that page. Data can be accessed using Handlebars data accessors, e.g. {{categories}}
Data | Example | Available in Partial(s) |
|---|---|---|
categories | | home.hbs, category.hbs, article.hbs, search.hbs |
category | | category.hbs, article.hbs |
article | | The full article object is available in article.hbs. In other partials, some fields (notably |
articles | | search.hbs |
search_term |
| search.hbs. This is the term we searched for after normalizing it. |
original_search_term |
| search.hbs. This is what the reader typed. |
search_result_count |
| search.hbs |
meta | | meta is available on all partials, but some of its attributes may not be available on some partials. Notably top_articles is only available in home.hbs and related_articles is only available in article.hbs. |
user | | All partials. If there's no logged in user this will be empty. |
config | | All partials. These are your settings from Settings > Customize > Design and elsewhere, ready to use in your HTML. |
Starter Templates
It's not always fun, desirable, or time-sensible (totally a phrase now πΉ) to create a template totally from scratch. So you can start from one of our default layouts instead.
The quickest way is in the HTML panel:
- Hit Start from a template

- Choose a layout from the Template dropdown. It offers the Startup, Startup with Sidebar Navigation, Docs and Ask v6 starters. We'll tell you if this replaces anything you've already got
- Hit Start. We'll fill in your partials, CSS, and JavaScript
- Hit Publish when you're ready (you'll see Save instead if your plan doesn't include drafts)
README.md.