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
Adding Tags to Articles
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
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 Your Printed HelpDocs Look Nicer
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
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
Creating and Managing Permission Groups
Assigning Permission Groups to Categories
Assigning Permission Groups to Articles
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
Is my data secure and protected?
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
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 Jarratt Isted
We love helping our customers create amazing experiences for their own customers. While we wish we could help you with everything there are some things that we just don't have time to support.
✅ What we can help with
Anything the light touches in your HelpDocs dashboard 🌟
This includes support with the Text Editor, Settings, Article Status', Data Migration, Stats, and Filtering just to name a few.
We've got a bunch of awesome features for your Knowledge Base. From Permissioning to Single Sign On and everything in between. If you have any questions about HelpDocs features and how to use 'em let us know!
- API Support
- Custom Domain Troubleshooting
- Multilingual/Machine Translations
- Single Sign On (SSO)
We provide a fully hosted service. You'll have SSL certificates and reliable uptime so your customers can always find the answers to their questions.
We've got a great set of Developer Docs to help along the way. We're able to get you pointed in the right direction about which APIs are available and how you can use them.
⛔ What we can't help with
We've provided a few code snippets we get asked for frequently in this section and we'll be adding more in the future. 🤗
If you wanna make minor changes and you're not a developer you should check out our guide to finding CSS selectors. It'll run you through the basics for your browser. You'll be a CSS whizz in no time!
We do our best to keep HelpDocs optimized so that your Knowledge Base can be found on search engines but aren't able to help with extra SEO support. Here's a guide on Optimizing Your Knowledge Base for Search to help get you started!
We are continuously working on making HelpDocs more accessible across different apps/platforms but we're not able to support third-party integrations.
If you have an integration you want to see in the future please let us know and we'll add it to our feature requests list.
Knowledge Base organization & structure
Every Knowledge Base is unique and how you structure your content is completely up to you. We aren't able to support any customizations or Knowledge Base structure requests. You should totally check out these articles though:
Providing customer examples
We totally get that it's helpful to see how someone else in your industry has their Knowledge Base set up but we can't share examples without consent.
If you're looking for inspiration we have a handful of awesome Knowledge Base examples on the HelpDocs Showcase.
🚀 HelpDocs support
You'll get our quickest and most efficient support through email. Send us a message anytime at email@example.com and we'll be happy to help answer any questions there 📫