Setting the URL Style for your Articles
Understanding Smart 404 Pages
Adding or Changing Your Profile Image
Switching Between Multiple Accounts
Understanding Top Articles
The HelpDocs Trial
Logging In To Your HelpDocs
Setting Up a Custom Domain
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
Moving an Article to a Different Category
Text Editor Shortcuts
Switching the Editor Mode
Understanding Article Statuses
Adding Tags to Articles
Article Backups, Revisions, and Versioning
Inserting Images into Ordered Lists
Using Ordered Lists
Adding Note, Tip, and Warning Callouts
Understanding Search Results
Linking to a Part of an Article
Getting Started with Taxonomy
Bulk Select & Edit Multiple Articles
Restoring Deleted Articles
Previewing Unpublished Articles
What is Readability?
Adding a Table of Contents
Featuring an Article
Delete a Category
Hiding Articles from Public Search Engines
Downloading Articles to PDF
Incompatible Browser Extensions
Creating a Subcategory
Exporting & Backing Up Your Articles
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
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
Disabling Related Articles
Using HelpDocs with RTL Languages
Getting Help with Code Snippets
Disabling Authorship and Updated Times
Using Different List Styles
Overriding the Font on Your Knowledge Base
Add HTML Before the Closing Body Tag
How to Change the Logo Link
Customizing Feedback Icons
Custom HTML Templates
Adding Custom Navigation Links
Hiding the Contact Button
Choosing a Template
Changing the Language in Common Phrases
Adding URL Redirects
Adding an Open Graph Fallback Image
Hosting HelpDocs at a Subfolder of Your Site
Setting Article Display Order
Setting Category Display Order
Setting a Custom Favicon
Uploading Your Brand Logo
Understanding the Contact Form
Adding Custom CSS
Featuring a Category
Adding Icons to Categories
Customizing an Article Slug, Meta Description & Short Version
Translating Your Docs
Setting Up Multilingual Docs
Automatically Translate Articles with Machine Translations
Getting Started with Permissioning
Creating and Managing Permission Groups
Assigning Permission Groups to Articles
Assigning Default Permission Groups to Categories
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?
Tax Residency Certificates and Forms
Cancelling Your Account
Subscribing to a Plan for the First Time
Invoices and Email Receipts
Updating Your Billing Information
Changing Your Plan
European Union VAT Charges
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?
Can I migrate or import my data from another service?
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
Every HelpDocs customer gets a custom subdomain that looks a little like this:
It's yours—go wild.
Our subdomains make a lotta sense for customers already, but if you want to take the customer experience from good to great, you'll want to set up a custom domain. For example:
It's super simple to set up a custom domain for your HelpDocs, but if you're not comfortable with DNS and CNAMEs, forward this article to your developers.
Setting up your custom domain
Set up a CNAME record
The first step is to log into your DNS provider (e.g. Route 53, GoDaddy, etc.) and set up a new CNAME record for the subdomain you'd like your HelpDocs to be available at. This should be pointed to
domains.helpdocs.io, not to your HelpDocs subdomain, and have the lowest possible TTL setting.
Let us know where
You'll need to tell us what domain will be accessing your HelpDocs. It's only a couple seconds' work, and you'll need to head to your account Settings.
Then type your custom domain into the marked field, and hit Save Changes. Easy as that.
Sit back and wait
Sadly some DNS providers aren't as fast to respond as we are 🙁 So depending on your provider you may need to wait up to 48 hours for the changes to be applied. Don't worry though—you can still access your HelpDocs at your subdomain, and they won't be interrupted.
Add SSL to Your Custom Domain 🔒
All HelpDocs plans come with free custom domain SSL as standard. There's nothing for you to pay on your end and all it takes is a click of a button. Here's how to request SSL for your shiny new custom domain.
- Make sure your custom domain is already working non-SSL
- Head to Settings > General
- Next to Custom Domain, you'll see an unlocked padlock button
- Click the button to request SSL
- It should take a couple seconds to issue your certificate
- If the SSL was successful the button will go green
digicert.comto your CAA record if you have one.
Moving a Domain to HelpDocs with Zero Downtime
It's possible to move your docs to HelpDocs with zero downtime in most cases.
- Enter your custom domain in HelpDocs Settings > General and hit Save
- Switch the CNAME on your domain to point to domains.helpdocs.io (exactly as written, not replacing for your subdomain)
- Wait for your custom domain to show HelpDocs when you access it
- Optional: Generate an SSL certificate for your domain in Settings > General by hitting the lock icon
If you had an SSL certificate before, there will be difficulties accessing your docs for people that’ve visited before until that SSL cert is issued. If not, it’ll just start working seamlessly.