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
Article Backups, Revisions, and Versioning
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
Understanding Article Statuses
Duplicating an Article
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
Changing the Language in Common Phrases
Understanding the Contact Form
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
Customizing How Machine Translations Work
Automatically Translate Articles with Machine Translations
Understanding Machine Translation Credits
Setting Up Multilingual
Understanding Multilingual Translation
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 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
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 River Sloane
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.