Logging In To Your HelpDocs
Understanding Smart 404 Pages
Setting Up a Custom Domain
The HelpDocs Trial
Adding or Changing Your Profile Image
Setting the URL Style for your Articles
Switching Between Multiple Accounts
Understanding Top Articles
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
Using Ordered Lists
Switching the Editor Mode
Adding Tags to Articles
Moving an Article to a Different Category
Text Editor Shortcuts
Understanding Article Statuses
Article Backups, Revisions, and Versioning
Inserting Images into Ordered Lists
Adding Note, Tip, and Warning Callouts
Featuring an Article
Downloading Articles to PDF
Restoring Deleted Articles
Creating Draft Versions of Published Articles with Working Copy
Exporting & Backing Up Your Articles
Getting Started with Taxonomy
Previewing Unpublished Articles
Adding a Table of Contents
Creating a Subcategory
Understanding Search Results
Linking to a Part of an Article
Bulk Select & Edit Multiple Articles
What is Readability?
Delete a Category
Hiding Articles from Public Search Engines
Incompatible Browser Extensions
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
Getting Help with Code Snippets
Customizing Feedback Icons
How to Change the Logo Link
Add HTML Before the Closing Body Tag
Overriding the Font on Your Knowledge Base
Using Different List Styles
Disabling Authorship and Updated Times
Using HelpDocs with RTL Languages
Disabling Related Articles
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
Custom HTML Templates
Customizing an Article Slug, Meta Description & Short Version
Adding Icons to Categories
Featuring a Category
Adding Custom CSS
Understanding the Contact Form
Uploading Your Brand Logo
Setting a Custom Favicon
Setting Category Display Order
Setting Article Display Order
Hosting HelpDocs at a Subfolder of Your Site
Adding an Open Graph Fallback Image
Adding URL Redirects
Changing the Language in Common Phrases
Choosing a Template
Hiding the Contact Button
Adding Custom Navigation Links
Automatically Translate Articles with Machine Translations
Setting Up Multilingual Docs
Translating Your Docs
Assigning Default Permission Groups to Categories
Creating and Managing Permission Groups
Getting Started with Permissioning
Assigning Permission Groups to Articles
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?
Lighthouse Widget API
Adding Lighthouse Trigger Buttons to Webflow
Cancelling Your Account
Tax Residency Certificates and Forms
Subscribing to a Plan for the First Time
Invoices and Email Receipts
Updating Your Billing Information
Changing Your Plan
European Union VAT Charges
Can I migrate or import my data from another service?
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?
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
Different people on your team build and market different parts of your product, so it makes sense to collaborate on your docs and let experts write everything they know about each feature.
You can assign roles to team members you invite to HelpDocs depending on the actions they'll take inside the product. Here's a breakdown:
The Owner role is automatically assigned to the creator of the account. This role can do everything, including manage billing. Owners can't be deleted, but they can transfer ownership.
Users with an Administrator role can do everything too. They can manage HelpDocs settings, billing, branding, and add/remove users and API keys. They can also edit all articles and content.
An Editor can see stats and manage content, but can't edit any settings or branding.
Users with this role can only view content. This is usually paired with the Restrict to Logged In Users auth option.
Inviting a User
- Head to Settings > Users
- Click Invite Member(s) at the bottom of the user table
- Fill out their email address, what their role should be, and whether to send them an email or not
- Click Send Invite
firstname.lastname@example.org, email@example.com, firstname.lastname@example.org
Changing the Default User Role
When you invite a new team member in Settings > Users, they'll automatically be assigned a specific user role. You can change the role they'll be assigned.
- Head to Settings > Users
- From the Default Role dropdown menu select the role you'd like to be assigned
- Click Save Changes
- In your HelpDocs dashboard, head to Settings > Users
- Click the checkbox next to the team members you'd like to edit and click Edit User
- Choose a new role from the Role dropdown
- Click Save Changes
If you're the owner of your account, you can transfer ownership to any other user. You'll see an Owner role in the dropdown where you select user roles. Select that, hit Save Changes, and that user will be your new account owner.
Viewing Last Active Time
In the corner of each user's profile image in the users table you'll see a little dot indicating their status. If the user is currently online, that dot will be green. If they're offline, that dot will be grey. You can hover over an offline user's profile image to see when they were last active.
If you're an Administrator or Owner you can delete users from your account
- Head to Settings > Users
- Select which users you'd like to delete using the checkboxes
- Click Edit x Users
- Click the trash icon in the top right of the popup