Setting Up a Custom Domain
The HelpDocs Trial
Adding or Changing Your Profile Image
Setting the URL Style for your Articles
Understanding Smart 404 Pages
Switching Between Multiple Accounts
Understanding Top Articles
Logging In To Your HelpDocs
Writing and Editing Articles
Using Quote Blocks
Using Markdown Blocks
Embedding Audio Files
Using Code Blocks
Adding an HTML Block
Getting Started with Content Blocks
Using Ordered Lists
Switching the Editor Mode
Adding Tags to Articles
Moving an Article to a Different Category
Text Editor Shortcuts
Understanding Article Statuses
Article Backups, Revisions, and Versioning
Inserting Images into Ordered Lists
Adding Note, Tip, and Warning Callouts
Getting Started with Taxonomy
Restoring Deleted Articles
Previewing Unpublished Articles
Adding a Table of Contents
Creating a Subcategory
Exporting & Backing Up Your Articles
Understanding Search Results
Linking to a Part of an Article
Bulk Select & Edit Multiple Articles
What is Readability?
Featuring an Article
Delete a Category
Hiding Articles from Public Search Engines
Downloading Articles to PDF
Incompatible Browser Extensions
Collaborating on Articles with Presence
Editing Category Metadata
Setting Up Integrations
Available Commands in Your Slack Workspace
Get Feedback, Activity, and Contact Form Notifications in Slack
Sharing Articles From HelpDocs to Slack
Configuring Your Slack Integration
Installing the Slack Integration
Using HelpDocs with Ticketing Systems
Adding a Feedier Carrier
Connecting Google Analytics
Syncing Content to elevio
Connecting Gainsight PX
Enabling Comments with Disqus
Customizing your HelpDocs
Getting Help with Code Snippets
Customizing Feedback Icons
How to Change the Logo Link
Add HTML Before the Closing Body Tag
Overriding the Font on Your Knowledge Base
Using Different List Styles
Disabling Authorship and Updated Times
Using HelpDocs with RTL Languages
Disabling Related Articles
Making Your Printed HelpDocs Look Nicer
Making Video Embeds Responsive
Adding Lightboxes to Images
Disabling Top Articles
Making Tables Scroll When They're Too Wide for the Page
Using a Background Image in the Header
How to Add Extra Spacing
Custom HTML Templates
Customizing an Article Slug, Meta Description & Short Version
Adding Icons to Categories
Featuring a Category
Adding Custom CSS
Understanding the Contact Form
Uploading Your Brand Logo
Setting a Custom Favicon
Setting Category Display Order
Setting Article Display Order
Hosting HelpDocs at a Subfolder of Your Site
Adding an Open Graph Fallback Image
Adding URL Redirects
Changing the Language in Common Phrases
Choosing a Template
Hiding the Contact Button
Adding Custom Navigation Links
Automatically Translate Articles with Machine Translations
Setting Up Multilingual Docs
Translating Your Docs
Assigning Default Permission Groups to Categories
Creating and Managing Permission Groups
Getting Started with Permissioning
Assigning Permission Groups to Articles
Removing Permission Groups from Articles
Restricting Your Docs to Logged In Users
Shared Password Protection
Restricting Your Docs by IP
Configuring Slack Single Sign On
Accessing User Data in HelpDocs
Using OpenID Connect for Single Sign On
Setting Up and Using SAML Single Sign-On
Restricting your HelpDocs with Custom JWT SSO
Data & Analytics
Getting Team Event History with Audit Trail
Search Click Analytics
Exporting Your Stats
What is the Happiness Score?
What are Tickets Avoided?
Adding Lighthouse Trigger Buttons to Webflow
Lighthouse Widget API
Cancelling Your Account
Tax Residency Certificates and Forms
Subscribing to a Plan for the First Time
Invoices and Email Receipts
Updating Your Billing Information
Changing Your Plan
European Union VAT Charges
Can I migrate or import my data from another service?
One of my headings isn't showing in the table of contents
I’m seeing a blank screen when I load my knowledge base
I've added a script but it isn't working
Can I change the HelpDocs branding?
Can I use multiple HelpDocs accounts together?
Who counts towards the user limit on plans?
Is my data secure and protected?
Can I embed files into HelpDocs?
How do I reset my password?
Help! My app's not loading 😭
Help! No articles are appearing on my knowledge base
I can't log into my HelpDocs account
What is an account slug?
Can I host my API docs in HelpDocs?
My article has a blank space to the left of it. What's wrong?
How do related articles work?
Can I host my internal docs in HelpDocs?
Is HelpDocs GDPR compliant?
How do I change my email?
Will translated articles be deleted if I remove that language?
Finding CSS Selectors in Your Browser
Optimizing Your Knowledge Base for Search
Clearing the Cache in Your Browser
Creating a Knowledge Base from Scratch
Writing Clear and Digestible Knowledge Base Articles
Table of Contents
Updated by Jake Peters
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.
If you're not familiar with Handlebars you should check out the official documentation. HelpDocs templates are compatible with all the syntax of Handlebars v3, with the addition of Inline Partials from Handlebars v4.
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
You can enable custom HTML templates in Settings > Brand. Choose Custom from the Template dropdown.
Once you've enabled custom templates you'll get a new tab in Settings called Templates. This is where you'll manage the HTML and Handlebars for each partial of your knowledge base.
Since you only have to provide the content for each page, not the whole HTML (include
<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 in Settings > Templates.
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.
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
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.
Display a single category and all its articles.
Display a single article.
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.
Available in Partial(s)
The full article object is available in article.hbs. In other partials, some fields (notably
"My super awesome search term"
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.
All partials. If there's no logged in user this will be empty.
It's not always fun, desirable, or time-sensible (totally a phrase now 😹) to create a template totally from scratch. Here's a few of our default layouts you can start with. They're in .zip files, so just unzip, and follow the instructions in Readme.md.