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 Jarratt Isted
Knowledge Bases look best when they're customized to fit your brand and style. Luckily HelpDocs has a ton of customization options to change the look and feel of your docs 🦄✨
While big changes to the look and feel of your docs are super fun they can also be kinda stressful. Especially if your docs are already live to customers. Breaking things in production's never fun 😭
.dev gives you a way to preview changes to some of your Knowledge Base settings (especially custom code) without making those changes live to users right away.
.devfeature on your HelpDocs plan
Making non-live changes with .dev
There's two places in Settings you can make changes to your code without affecting your live Knowledge Base:
In areas where you're able to use
.dev you'll see an Enable .dev button in the navigation.
If a setting is part of
.dev we'll highlight that with a little badge or a callout with a descriptive message. Any changes you make to settings without a badge or callout will affect the live version of your docs.
- Head to
- Settings > Brand for Brand changes
- Settings > Code for Code changes
- Hit Enable .dev in the top right navigation
- Make any changes you want to areas that're marked as part of
.devRight now the Settings that're part of
Promoting .dev changes to the live version
Fixed that pesky CSS issue? ✅ Got your template looking just so? ✅ You're ready to go live!
Once you're happy with the changes you've made using
.dev you'll need to promote the changes to your live Knowledge Base. Only then will they be visible to your users.
Don't worry there's no need to copy/paste things here. You can promote all your changes at once with a couple clicks.
- Click the dropdown arrow next to the Disable .dev button
- Select Promote .dev changes to live version
- Read the warning. I know your changes are awesome. I know you probably hate warnings. But it's useful I promise 👀Promoting your changes from
.devto your live Knowledge Base will overwrite all live settings that're part of
.devwith the staging versions you've been working on. This includes any fields of
.dev'able settings that you've left empty. Be sure you really wanna do this before you move forward.
- Hit Save Changes
Restoring .dev from live version
You can populate
.dev with all your live Knowledge Base settings in a couple clicks. This is especially useful when you're just getting started with
.dev or if you've made any terrible errors with your customizations (happens to the best of us 😩). Here's how 👇
- Click the dropdown arrow next to the Disable .dev button in the top right navigation
- Choose Restore .dev from live version
- Read this warning too. I know you probably learned from the warning before. And you're excited to make your changes. I know warnings still kinda suck. But it's there for your protection 👷This will permanently overwrite your
.devchanges with settings from your live Knowledge Base. Once you hit Save we can't recover your old
- Hit Save Changes
Previewing changes on your .dev subdomain
The whole point of
.dev is so you can see your changes without pushing them live. But how do you see them? With our handy Preview .dev changes button of course!
- Click the dropdown arrow next to the Disable .dev button
- Hit Preview .dev changes
- You'll be taken to
<yourdomain>.helpdocs.devwhere you'll see all your articles and categories as normal plus all the settings changes you've made with
.dev subdomain visibility
.dev will not affect your SEO or confuse users with multiple copies of content on the internet. It's a preview area that's only accessible by certain members of your team that have access to HelpDocs Settings.
Specifically only members of your HelpDocs team that're Administrators and above can view changes made with
.dev. And it can only be accessed through Settings.