Lighthouse

In-app help that puts your knowledge base right where customers get stuck.

Lighthouse is HelpDocs' contextual help widget. Customers search, read, and self-serve inside your product, and its Widget API lets you drive the whole thing from your own UI. No tab-switching, no redirects.

Available on Sprout and Bloom plans.

In-app answers

Light the way with in-app help.

Bring your knowledge base into the moments customers get stuck, so they can search, read, and self-serve without ever leaving your app. The Widget API lets you drive it from your own UI: open a category, jump to an article, show suggestions, or launch the contact form on cue.

The panel on the right is live. Try the buttons.

Lighthouse Widget APILive on this page, try it

Go tab-less

Customers search, read, and self-serve right inside your app, with no tab-switching and no losing their place.

Style it, control it

Match it to your product, shape how it behaves, and deep-link straight to any article or category through the Widget API.

Live in minutes

Copy one snippet, paste it into your app, and you're done. Tweak the config whenever you like, no redeploys required.

Widget API

One knowledge base, driven from your own UI.

Every app is different, so Lighthouse gives you programmatic control over how it looks and behaves. Call simple JavaScript methods to show, hide, and navigate the panel, and react to what customers do.

Search and read in place

Customers search your knowledge base, open an article, and read it right inside your product, so they never lose their place.

Deep-link with navigate()

Jump straight to a category, an article, the suggestions view, or the contact form with Lighthouse.navigate(), triggered by your own UI.

Show, hide, and react

Open and collapse the panel with show() and hide(), and hook into onOpen, onClose, and onNavigate callbacks to respond to what customers do.

Style it to match

Match Lighthouse to your product with your own colors, position, and branding so it reads as a native part of your app, not a bolt-on.

Set behaviours with methods and callbacks.

The same methods powering the live demo are yours to call from anywhere in your app.

  • show() andhide() open and collapse the help panel on demand.
  • navigate() jumps to home, a category, an article, suggestions, or the contact form.
  • onOpen,onClose, andonNavigate callbacks let you react to what customers do.
Read the Widget API docs
Lighthouse Widget API code example showing navigate and show methods

Setup is stupidly simple.

Copy, paste, customize. You'll be up and running in minutes.

1

Copy the snippet

Grab your unique widget code from your HelpDocs dashboard.

2

Paste into your app

Drop it into your HTML. Works with React, Vue, Angular, or vanilla JS.

3

Customize (optional)

Use the Widget API to match your brand and control behavior, or let it work out of the box.

Build in-app help experiences that make sense.

Because you drive Lighthouse from your own UI, you can put the right knowledge base content in front of customers at exactly the right moment.

In-app help button

Add a persistent help launcher that opens Lighthouse wherever customers need it.

Contextual help

Open the article or category that matches where someone is in your app.

Error recovery

When something breaks, deep-link the message straight to the troubleshooting guide.

Onboarding flows

Surface getting-started guides right inside your onboarding, without a redirect.

Feature discovery

Point customers to the docs the moment they find a new feature.

Deflect before contact

Let customers search answers first, then reach the contact form only if they still need it.

Start building your documentation infrastructure.

Start free 14-day trial

Create, organize, translate, and connect your docs without the admin sprawl of a support suite.

No credit card required.

HelpDocs onboarding example