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
Text Editor Shortcuts
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
Incompatible Browser Extensions
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
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
Adding a Feedier Carrier
Connecting Google Analytics
Connecting Gainsight PX
Using HelpDocs with Ticketing Systems
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?
Lighthouse Widget API
Integrating Lighthouse with Live Chat Providers
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 HelpDocs GDPR compliant?
Can I migrate or import my data from another service?
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 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?
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 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.
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
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/signupand enter their email address there
- Click Send Invite
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
- 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.
- 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.
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:
- Inactive for x amount of time
- Active in the last x amount of time
- User group
- Click Apply
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