Getting Started
Managing Users
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
Stale Articles
Text Editor
Content Blocks
Inserting Videos
Adding an HTML Block
Using Markdown Blocks
Adding Embeddables
Using Code Blocks
Getting Started with Content Blocks
Using Quote Blocks
Inserting Images
Understanding Article Statuses
Article Backups, Revisions, and Versioning
Managing Clips
Text Editor Shortcuts
Adding Tags to Articles
Using Folds
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
Adding Buttons
Unassigned Articles
Understanding Search Results
Duplicating an Article
Incompatible Browser Extensions
Filtering Articles
Downloading Articles to PDF
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
Featuring an Article
Creating Draft Versions of Published Articles with Working Copy
Bulk Select & Edit Multiple Articles
Creating a Subcategory
Hidden Categories
Linking to a Part of an Article
Previewing Articles
Using help.new to Create Articles
Editing Images
Setting Up Integrations
Front Integration
Slack Integration
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
Intercom Integration
Drift Integration
Chrome Extension
Connecting Heap
Connecting Google Analytics
Adding a Feedier Carrier
Adding Hotjar
Connecting Gorgias
Connecting Lucidchart
Connecting GoSquared
Connecting Gainsight PX
Connecting Segment
Connecting Kommunicate
Using HelpDocs with Ticketing Systems
Connecting LiveChat
Connecting Chatra
Connecting Statuspage
Connecting Crisp
Connecting Belco
Syncing Content to elevio
Adding FullStory
Enabling Comments with Disqus
Connecting Doorbell
Connecting Sunshine Conversations
Connecting Hyperping
Customizing your HelpDocs
Code Snippets
Condense Top Article Spacing on Bars V4
Adding Lightboxes to Images
Overriding the Font on Your Knowledge Base
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
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
Add HTML Before the Closing Body Tag
Customizing Feedback Icons
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 Custom JavaScript
Adding Cookie Consent
Multilingual Translation
Machine Translations
Understanding Machine Translation Credits
Customizing How Machine Translations Work
Automatically Translate Articles with Machine Translations
Setting Up Multilingual
Understanding Multilingual Translation
Translating Categories
Translating Articles
Permissioning
Creating a Read-Only Permission Group for Public Articles
Creating and Managing Permission Groups
Getting Started with Permissioning
Assigning Permission Groups to Categories
Assigning Permission Groups to Articles
Removing Permission Groups from Articles
Authentication
Setting Up Two-Factor Authentication
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
Filtering Stats
Getting Team Event History with Audit Trail
Understanding Articles Clicked
What are Tickets Avoided?
Exporting Your Stats
What is the Happiness Score?
Lighthouse
Understanding Lighthouse
Lighthouse Widget API
Integrating Lighthouse with Live Chat Providers
Installing Lighthouse
Adding Lighthouse Trigger Buttons to Webflow
Billing
Cancelling Your Account
Downloading Invoices and Receipts
Updating Your Billing Information
Changing Your Plan
Subscribing to a Plan for the First Time
European Union VAT Charges
Tax Residency Certificates and Forms
FAQs
I can't log in to my HelpDocs account or complete signup
How do I reset my password?
How do I change my email?
Can I use multiple HelpDocs accounts together?
Can I migrate or import my data from another service?
Who counts towards the user limit on plans?
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?
I've added a script but it isn't working
Help! My app's not loading 😭
Can I embed files into HelpDocs?
How do related articles work?
Can I host my API docs in HelpDocs?
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?
Guides
Optimizing Your Knowledge Base for Search
Creating a Knowledge Base from Scratch
Finding CSS Selectors in Your Browser
Clearing the Cache in Your Browser
Writing Clear and Digestible Knowledge Base Articles
Resources
Security & Compliance
Table of Contents
- Knowledge Base
- Getting Started
- Managing Users
Managing Users
Updated
by Taylor Sloane
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.
Here's how to create, manage, and delete users on your HelpDocs account ⛳️
Understanding Roles
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:
Feature | Read-only | Writer | Editor | Administrator | Owner |
- | - | - | ✅ | ✅ | |
Manage Users | - | - | - | ✅ | ✅ |
- | - | - | ✅ | ✅ | |
- | - | - | ✅ | ✅ | |
- | - | - | ✅ | ✅ | |
- | - | ✅ | ✅ | ✅ | |
- | - | ✅ | ✅ | ✅ | |
- | - | ✅ | ✅ | ✅ | |
- | - | ✅ | ✅ | ✅ | |
Edit Authorship | - | - | ✅ | ✅ | ✅ |
Reorder Content | - | - | ✅ | ✅ | ✅ |
Delete Published Articles | - | - | ✅ | ✅ | ✅ |
Edit & Save Articles | - | ✅ | ✅ | ✅ | ✅ |
Create Articles | - | ✅ | ✅ | ✅ | ✅ |
Create Clips | - | ✅ | ✅ | ✅ | ✅ |
View Clips | - | ✅ | ✅ | ✅ | ✅ |
✅ | ✅ | ✅ | ✅ | ✅ |
Inviting a User
You can quickly invite users to your account. While you're waiting for them to accept the invitation they'll show up in the Invitations tab.

- Head to Settings > Users
- Switch to the Invitations tab
- Click Invite New Users at the top right
- Fill out their email address, their role, and whether to send them an email invite or notIf you don't send over an email invite they'll need to head to
yourdomain.helpdocs.io/signup
and enter their email address there - Click Send Invite
chromegoose@helpdocs.io,lindatherabbit@helpdocs.io,liveythepelican@helpdocs.io
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 > Access and head to the Defaults section
- From the Default User Role dropdown menu select the role you'd like to be assigned
- Click Save Changes
Changing Roles

- 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
Transferring Ownership
If you're the owner of your account you can transfer ownership to any other user.
- Head over to Settings > Users
- Select the user you wish to transfer ownership to
- Click Edit User
- In the Role dropdown select Owner
- Hit Save Changes
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 the dot will be grey.

You can hover over the status dot to find out when they were last active.
Filtering Users
Looking for a certain someone? You can filter by users' activity, role, and user groups to find the subset of users you're interested in.

- Head to Settings > Users
- On the User tab click Filter in the top right to expand the filtering options
- Add your filters. You can filter by:
- Name
- Inactive for x amount of time
- Active in the last x amount of time
- User group
- Role
- Click Apply
Bulk Edit Users
Looking to modify lots of your users at once? You can use our handy Bulk Edit tools for your users.

- Head to Settings > Users
- Select which users you'd like to modify using the checkboxes
- Change your attributes. You can modify:
- Role
- Read-only groups
- Full-access groups
- Hit Save Changes
Deleting Users
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 Delete users