Setting Up a Custom Domain
Logging In To Your HelpDocs
Setting the URL Style for your Articles
Understanding Smart 404 Pages
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
Moving an Article to a Different Category
Text Editor Shortcuts
Adding Note, Tip, and Warning Callouts
Switching the Editor Mode
Adding Tags to Articles
Using Ordered Lists
Adding GIFs to Articles
Understanding Article Statuses
Article Backups, Revisions, and Versioning
Inserting Images into Ordered Lists
Delete a Category
Downloading Articles to PDF
Hiding Articles from Public Search Engines
Exporting & Backing Up Your Articles
Linking to a Part of an Article
Understanding Search Results
Creating a Subcategory
Adding a Table of Contents
Featuring an Article
Restoring Deleted Articles
Creating Draft Versions of Published Articles with Working Copy
Bulk Select & Edit Multiple Articles
What is Readability?
Incompatible Browser Extensions
Collaborating on Articles with Presence
Editing Category Metadata
Setting Up Integrations
Installing the Slack Integration
Sharing Articles From HelpDocs to Slack
Configuring Your Slack Integration
Available Commands in Your Slack Workspace
Get Feedback, Activity, and Contact Form Notifications in Slack
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
How to Change the Logo Link
Disabling Top Articles
Using a Background Image in the Header
Making Tables Scroll When They're Too Wide for the Page
Making Video Embeds Responsive
Using HelpDocs with RTL Languages
Adding Lightboxes to Images
Add HTML Before the Closing Body Tag
Customizing Feedback Icons
Disabling Authorship and Updated Times
Overriding the Font on Your Knowledge Base
Getting Help with Code Snippets
Using Different List Styles
Disabling Related Articles
Making Your Printed HelpDocs Look Nicer
How to Add Extra Spacing
Custom HTML Templates
Testing Customizations with .dev
Understanding the Contact Form
Adding Cookie Consent
Adding Custom Navigation Links
Setting a Custom Favicon
Hiding the Contact Button
Changing the Language in Common Phrases
Setting Article Display Order
Setting Category Display Order
Adding Custom CSS
Uploading Your Brand Logo
Featuring a Category
Customizing an Article Slug, Meta Description & Short Version
Adding Icons to Categories
Hosting HelpDocs at a Subfolder of Your Site
Adding an Open Graph Fallback Image
Adding URL Redirects
Choosing a Template
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
Creating and Managing Permission Groups
Getting Started with Permissioning
Restricting Your Docs to Logged In Users
Configuring Slack Single Sign On
Shared Password Protection
Accessing User Data in HelpDocs
Restricting Your Docs by IP
Using OpenID Connect for Single Sign On
Setting Up and Using SAML Single Sign-On
Restricting your HelpDocs with Custom JWT SSO
Data & Analytics
What are Tickets Avoided?
Getting Team Event History with Audit Trail
Search Click Analytics
What is the Happiness Score?
Exporting Your Stats
Lighthouse Widget API
Adding Lighthouse Trigger Buttons to Webflow
Invoices and Email Receipts
Updating Your Billing Information
Changing Your Plan
Subscribing to a Plan for the First Time
Cancelling Your Account
Tax Residency Certificates and Forms
European Union VAT Charges
Can I host my internal docs in HelpDocs?
Can I use multiple HelpDocs accounts together?
Help! My app's not loading 😭
I've added a script but it isn't working
I’m seeing a blank screen when I load my knowledge base
Can I migrate or import my data from another service?
HelpDocs Support Policy
Can I embed files into HelpDocs?
My article has a blank space to the left of it. What's wrong?
Can I change the HelpDocs branding?
One of my headings isn't showing in the table of contents
Who counts towards the user limit on plans?
Is my data secure and protected?
How do I reset my password?
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?
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
Writing Clear and Digestible Knowledge Base Articles
Finding CSS Selectors in Your Browser
Clearing the Cache in Your Browser
Creating a Knowledge Base from Scratch
Table of Contents
Updated by Jarratt Isted
Lighthouse makes it plain sailing for your users to help themselves without ever leaving your app or website. Here's the various states and actions users will see within your widget.
- Navigation bar
- Contact form/live chat button
- Article suggestions
- Instant search bar
- Widget toggle
- Categories & articles
The navigation bar helps users control where they are within your widget. We'll use your uploaded logo to the left and your brand name to the right from Settings > Brand.
Contact form/live chat button
The contact button helps users who can't find an answer from your knowledge base get in touch with your team. If you have a supported Live Chat product on the page where you've installed Lighthouse, we'll trigger that when someone hits Contact. If not, we'll show an email contact form. You can disable this if you don't want to show a contact button at all.
Lighthouse offers the ability to provide smart contextual help. You can set up articles to be suggested depending on the page your users are currently on.
To start creating suggestions, use the
suggestions config value to either suggest specific articles, articles within a category, or all articles with a certain tag.
Instant search bar
The search you know and love is included within the Lighthouse widget. As soon as a user start typing, they'll see article suggestions appear.
Lighthouse can either expand to provide information or hide away ready to be helpful. By default Lighthouse will appear in a closed state, although you can trigger behaviour using the Widget API methods.
When in a closed state, the Lighthouse icon will show. Depending on your primary color, it'll either show a light version or a dark version.
color_modeconfig value in the Widget API
Categories & articles
Just like on your knowledge base, users will be able to browse categories and articles to find information.
Your custom icons will show on category cards as well as any custom meta information you've added to categories and articles. Custom ordering will also stay intact.