Logging In To Your HelpDocs
Setting the URL Style for your Articles
Understanding Smart 404 Pages
The HelpDocs Trial
Adding or Changing Your Profile Image
Switching Between Multiple Accounts
Understanding Top Articles
Setting Up a Custom Domain
Writing and Editing Articles
Adding an HTML Block
Using Markdown Blocks
Embedding Audio Files
Using Code Blocks
Getting Started with Content Blocks
Using Quote Blocks
Inserting Images into Ordered Lists
Adding Note, Tip, and Warning Callouts
Switching the Editor Mode
Adding Tags to Articles
Article Backups, Revisions, and Versioning
Using Ordered Lists
Understanding Article Statuses
Moving an Article to a Different Category
Text Editor Shortcuts
Linking to a Part of an Article
Understanding Search Results
Creating a Subcategory
Adding a Table of Contents
Featuring an Article
Restoring Deleted Articles
What is Readability?
Incompatible Browser Extensions
Editing Category Metadata
Exporting & Backing Up Your Articles
Collaborating on Articles with Presence
Hiding Articles from Public Search Engines
Delete a Category
Downloading Articles to PDF
Creating Draft Versions of Published Articles with Working Copy
Bulk Select & Edit Multiple Articles
Setting Up Integrations
Available Commands in Your Slack Workspace
Get Feedback, Activity, and Contact Form Notifications in Slack
Installing the Slack Integration
Sharing Articles From HelpDocs to Slack
Configuring Your 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
Connecting Sunshine Conversations
Customizing your HelpDocs
Condense Top Article Spacing on Bars V4
Disabling Authorship and Updated Times
How to Add Extra Spacing
Getting Help with Code Snippets
Disabling Top Articles
Using HelpDocs with RTL Languages
Overriding the Font on Your Knowledge Base
Using Different List Styles
Disabling Related Articles
How to Change the Logo Link
Using a Background Image in the Header
Making Tables Scroll When They're Too Wide for the Page
Making Video Embeds Responsive
Adding Lightboxes to Images
Add HTML Before the Closing Body Tag
Customizing Feedback Icons
Making Your Printed HelpDocs Look Nicer
Custom HTML Templates
Adding Cookie Consent
Adding Custom Navigation Links
Setting a Custom Favicon
Hiding the Contact Button
Setting Article Display Order
Setting Category Display Order
Adding Custom CSS
Uploading Your Brand Logo
Adding URL Redirects
Featuring a Category
Adding Icons to Categories
Hosting HelpDocs at a Subfolder of Your Site
Customizing an Article Slug, Meta Description & Short Version
Changing the Language in Common Phrases
Adding an Open Graph Fallback Image
Choosing a Template
Testing Customizations with .dev
Understanding the Contact Form
Understanding Multilingual Translation
Setting Up Multilingual
Automatically Translate Articles with Machine Translations
Getting Started with Permissioning
Assigning Permission Groups to Articles
Creating and Managing Permission Groups
Assigning Permission Groups to Categories
Removing Permission Groups from Articles
Restricting your HelpDocs with Custom JWT SSO
Restricting Your Docs by IP
Restricting Your Docs to Logged In Users
Configuring Slack Single Sign On
Shared Password Protection
Accessing User Data in HelpDocs
Using OpenID Connect for Single Sign On
Setting Up and Using SAML Single Sign-On
Data & Analytics
Getting Team Event History with Audit Trail
Exporting Your Stats
What is the Happiness Score?
What are Tickets Avoided?
Understanding Articles Clicked
Lighthouse Widget API
Adding Lighthouse Trigger Buttons to Webflow
European Union VAT Charges
Invoices and Email Receipts
Updating Your Billing Information
Cancelling Your Account
Subscribing to a Plan for the First Time
Changing Your Plan
Tax Residency Certificates and Forms
I'm getting 'Your connection is not private' on my custom domain
Why isn't my contact form showing up?
Can I embed files into HelpDocs?
One of my headings isn't showing in the table of contents
Who counts towards the user limit on plans?
How do I change my email?
Is HelpDocs GDPR compliant?
Will translated articles be deleted if I remove that language?
I can't log into my HelpDocs account
Help! No articles are appearing on my knowledge base
What is an account slug?
How do I reset my password?
How do related articles work?
Can I host my API docs in HelpDocs?
Can I use multiple HelpDocs accounts together?
Can I migrate or import my data from another service?
Can I Change the HelpDocs Branding?
My Article Has a Blank Space to the Left. What's Wrong?
HelpDocs Support Scope
Can I host my internal docs in HelpDocs?
Help! My app's not loading 😭
I've added a script but it isn't working
I’m seeing a blank screen when I load my knowledge base
Is my data secure and protected?
Finding CSS Selectors in Your Browser
Clearing the Cache in Your Browser
Creating a Knowledge Base from Scratch
Optimizing Your Knowledge Base for Search
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 access to a new tab in Settings > Code called HTML. 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 > Code > HTML.
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.