Setting the URL Style for your Articles
Setting Up a Custom Domain
Logging In To Your HelpDocs
Understanding Smart 404 Pages
The HelpDocs Trial
Adding or Changing Your Profile Image
Understanding Top Articles
Switching Between Multiple Accounts
Writing and Editing Articles
Getting Started with Content Blocks
Adding a HTML Block
Using Code Blocks
Embedding Audio Files
Using Markdown Blocks
Using Quote Blocks
Using Ordered Lists
Adding Info, Tip and Warning Callouts
Inserting Images into Ordered Lists
Article Backups, Revisions and Versioning
Adding Tags to Articles
Understanding Article Statuses
Switching the Editor Mode
Text Editor Shortcuts
Moving an Article to a Different Category
Collaborating on Articles with Presence
Exporting & Backing Up Your Articles
Creating a Subcategory
Incompatible Browser Extensions
Downloading Articles to PDF
How to Add Extra Spacing
Hiding Articles from Public Search Engines
Delete a Category
Featuring an Article
Adding a Table of Contents
What is Readability?
Previewing Unpublished Articles
Restoring Deleted Articles
Bulk Select & Edit Multiple Articles
Getting Started with Taxonomy
Linking to a Part of an Article
Understanding Search Results
Setting Up Integrations
Installing the Slack Integration
Configuring your Slack Integration
Sharing Articles From HelpDocs to Slack
Available Commands in Your Slack Workspace
Get Feedback, Activity, and Contact Form Notifications in Slack
Enabling Comments with Disqus
Connecting Gainsight PX
Syncing Content to elevio
Connecting Google Analytics
Adding a Feedier Carrier
Using HelpDocs with Ticketing Systems
Customizing your HelpDocs
Using a Background Image in the Header
Making Tables Scroll When They're Too Wide for the Page
Disabling Top Articles
Adding Lightboxes to Images
Making Video Embeds Responsive
Making your printed HelpDocs look nicer
Disabling Related Articles
Using HelpDocs with RTL Languages
Getting Help with Code Snippets
Disabling Authorship and Updated Times
Using Different List Styles
Overriding the Font on Your Knowledge Base
Add HTML Before the Closing Body Tag
How to Change the Logo Link
Customizing Feedback Icons
Custom HTML Templates
Adding Custom Navigation Links
Hiding the Contact Button
Choosing a Template
Changing the Language in Common Phrases
Adding URL Redirects
Adding an Open Graph Fallback Image
Hosting HelpDocs at a Subfolder of Your Site
Setting Article Display Order
Setting Category Display Order
Setting a Custom Favicon
Uploading Your Brand Logo
Understanding the Contact Form
Adding Custom CSS
Featuring a Category
Adding Icons to Categories
Customizing an Article Slug, Meta Description & Short Version
Translating Your Docs
Setting Up Multilingual Docs
Automatically Translate Articles with Machine Translations
Creating and Managing Permission Groups
Removing Permission Groups from Articles
Assigning Permission Groups to Articles
Getting Started with Permissioning
Shared Password Protection
Restricting Your Docs by IP
Configuring Slack Single Sign On
Accessing User Data in HelpDocs
Restricting Your Docs to Logged In Users
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?
Cancelling Your Account
Subscribing to a Plan for the First Time
Invoices and Email Receipts
Updating Your Billing Information
Changing Your Plan
European Union VAT Charges
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?
Can I migrate or import my data from another service?
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?
Optimizing Your Knowledge Base for Search
Clearing the Cache in Your Browser
Finding CSS Selectors in Your Browser
Creating a Knowledge Base from Scratch
Writing Clear and Digestible Knowledge Base Articles
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 > User Management
- Click Invite Member 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
email@example.com, firstname.lastname@example.org, email@example.com
Changing the Default User Role
When you invite a new team member in Settings > User Management, they'll automatically be assigned a specific user role. You can change the role they'll be assigned.
- Head to Settings > User Management
- From the dropdown select the role you'd like to be assigned
- Click Save
- In your HelpDocs dashboard, head to Settings > User Management
- Click the checkbox next to the team members you'd like to edit
- 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.