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