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
Getting your knowledge base search ready can make a huge difference. Not only does it save your customers time, but it can help reduce support ticket numbers.
Here we'll show you how tools inside HelpDocs can help, what we automatically do to optimize it for you, and what you can do yourself to make those search robots happy.
HelpDocs SEO Tools
SEO title & description
Getting your knowledge base to rank well for searches related to your website is pretty crucial, particularly when your customers are looking for some help.
Good example 👍
Bad example 👎
Shoes&Stuff sell the best shoes in the whole world, and then some. Looking for support? Browse through our collection of help articles.
We sell cow related products to keep your cow in a good moo-d.
Editing your SEO title & description
- Head to Settings > General
- Scroll down and you'll find SEO title and SEO description
- Hit Save
Article title, slug, and meta data
One of the best ways to rank highly when users are searching for a solution is to make the most out of your article title, slug, and meta data. All these things have a big impact on whether you show up or not.
Good example 👍
Bad example 👎
Logging in to Shoes&Stuff
Accessing your account
Looking to log in to your shoes and stuff account? Here's how.
If you want to access your account this is where you can do it.
In the example above, Shoes&Stuff will rank highly because it's clear and repeats the brand name multiple times. It's easy for a search engine robot to understand and it's similar to what a user might type.
Unfortunately, the same cannot be said for Cows&Stuff. It's unlikely a user will type 'accessing', and the brand name isn't mentioned anywhere despite it being a critical help article.
Editing your article slug & meta description
- Head to the article you want to edit
- Click on more
- You'll see a sidebar slide down. Select Edit Meta
- Edit the slug and meta description
- Hit Save
Here's the stuff we do automatically to boost your SEO. You don't have to lift a finger.
Open Graph Support
You know those neat little cards you find on Twitter, Facebook, and in your messaging apps? We create them for you without you ever having to touch any code. Handy, right?
We'll use the article title as the
og:title, the first image or GIF as the
og:image, and the meta description as the
Structured data is exactly what it sounds like—data that's structured in a way for search engines to consume and understand. When you create articles and categories we'll generate data that leaves clues for robots. This means that you'll get a rich search result sooner, like the example with Drift's Help Docs below.
Sitemaps & Robots.txt
When you set up your knowledge base, we automatically create a
sitemap.xml for you. These help search engines understand your data, so your knowledge base articles have a good chance of ranking well. 🤖
Both these files are available at the root of your knowledge base, be it a HelpDocs subdomain or custom domain. e.g. our sitemap is available at https://support.helpdocs.io/sitemap.xml.
What's really neat is when you use our multilingual tools, though. If you turn that on and start using it, we'll generate a multilingual XML sitemap. This means that if you're writing in French, your articles will show up in French search engines with the correct version.