Logging In To Your HelpDocs
Setting the URL Style for your Articles
Understanding Smart 404 Pages
Setting Up a Custom Domain
The HelpDocs Trial
Adding or Changing Your Profile Image
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
Switching the Editor Mode
Using Ordered Lists
Adding GIFs to Articles
Unassigned Articles Category
Understanding Article Statuses
Moving an Article to a Different Category
Adding Tags to Articles
Text Editor Shortcuts
Article Backups, Revisions, and Versioning
Inserting Images into Ordered Lists
Adding Note, Tip, and Warning Callouts
Delete a Category
Creating a Subcategory
Adding a Table of Contents
Previewing Unpublished Articles
Exporting & Backing Up Your Articles
Downloading Articles to PDF
Featuring an Article
Restoring Deleted Articles
Creating Draft Versions of Published Articles with Working Copy
Understanding Search Results
Linking to a Part of an Article
Bulk Select & Edit Multiple Articles
What is Readability?
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
Customizing Feedback Icons
Disabling Authorship and Updated Times
Overriding the Font on Your Knowledge Base
Getting Help with Code Snippets
How to Change the Logo Link
Add HTML Before the Closing Body Tag
Using Different List Styles
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
Removing Permission Groups from Articles
Assigning Permission Groups to Articles
Assigning Default Permission Groups to Categories
Getting Started with Permissioning
Creating and Managing Permission Groups
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
Changing Your Plan
Invoices and Email Receipts
Updating Your Billing Information
Subscribing to a Plan for the First Time
Cancelling Your Account
Tax Residency Certificates and Forms
European Union VAT Charges
My article has a blank space to the left of it. What's wrong?
Can I use multiple HelpDocs accounts together?
Can I change the HelpDocs branding?
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
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?
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 Matt Bradford-Aunger
Looking to restrict certain docs to certain users? Good news—HelpDocs supports permissioning.
This means you can host different articles for different people within the same knowledge base, and can easily manage access at an article-by-article level.
What you can do with Permissioning
Permissioning is a powerful way to use one knowledge base in totally different circumstances. Here's a few examples where it can work wonders.
Restrict by user
- Hyper-specific. You may only want a few people to have access to certain information, like how to connect to a database. In this case, you can select specific users from the list.
Restrict by user group
- Internal team. Create an Internal user group and create articles like how to bill customers only your team members should see.
- Partners. Team up with other companies often? Create a Partners user group with articles full of information about co-marketing and discounts.
- Partner developers. If you've got a special API only some partners should have access to, you might want to host some of the spec on HelpDocs. Create a Developers user group and create articles with information on specific API routes they can use.
Restrict by role
- Process. If you're training editors how to use HelpDocs and create documentation that reads well, target the role Editor and create process documentation.
- Internal role-specific. Inviting admins that have specific access to other tools can help you write documentation about how to interact and use them. Just target the role Admin.
Getting started with permissioning is super simple.
Understanding Whether an Article Has Permissioning
So you've set permissioning on an article, but how can you and your team tell it's permissioned? There are a few places we show it's permissioned.
Inside the Text Editor
When you're editing an article that has permissions you'll see an icon in the top right of the toolbar with a pink dot next to it. If you're hovering over it, you'll see Edit Permissions as a tooltip.
Within the Content View
If you're browsing articles within the content view you'll be able to tell if it's permissioned in a few ways. First, you'll see it next to the article meta like the published status.
Secondly you'll be able to see it to the right with the permissioning button. If it has permissions it'll appear with a pink dot, just like inside the text editor.
Inside Search Results
You'll be able to see if an article is permissioned when you're searching for an article within the Content view. Just look at the bottom of each search result, next to the article published status.
If you're using our stock V4 Bars template you'll also be able to see the permissions icon on the frontend knowledge base within search results too.