# HelpCenter.io Help Center
---
Source: https://self.helpcenter.io/content/sign-in
# Sign in to HelpCenter.io
_Category: Getting started_
Sign in once to work on every help center you belong to, from one place. Whichever help center you manage or read, you sign in at [helpcenter.io/app/signin](https://helpcenter.io/app/signin).
**Who can do this:** Anyone with a HelpCenter.io account · **Plans:** All plans
## Sign in
1. Go to [helpcenter.io/app/signin](https://helpcenter.io/app/signin).
2. Enter your **Email address** and **Password**.
3. If you're on a device only you use, tick **Keep me logged in**.
4. Click **Sign in**.

Leave Keep me logged in unticked on a shared computer.
## Sign in with Google
Click **Continue with Google** on the sign-in page and pick your Google account. You're signed in without typing a password.
- **Your Google address matches your HelpCenter.io account.** The first time, Google is connected to that account for you, as long as you've verified your email address with us.
- **Your Google address is different.** Sign in with your password once, then connect Google under **Account Settings** → **Sign-in Methods**. See [Change or reset your password](https://self.helpcenter.io/content/change-your-password).
- **You don't have an account yet.** You're taken to the sign-up page to finish creating one. See [Create your HelpCenter.io account](https://self.helpcenter.io/content/create-your-account).
## After you sign in
Next you see the list of your help centers. Click one to open its dashboard. If you opened a link to a dashboard page before signing in, you go straight to that page instead. See [Switch between your help centers](https://self.helpcenter.io/content/switch-help-centers).
## If you use two-factor authentication
After your password, or after you pick your Google account, the **Two-Factor Authentication** page asks for a code. Open your authenticator app, type the code it shows under **Authentication Code** and click **Verify and Continue**.
Lost the phone with your authenticator app? See [I lost my authenticator device](https://self.helpcenter.io/content/lost-two-factor-device).
## Forgot your password?
1. Click **Forgot password?** on the sign-in page.
2. Enter your **Email address** and click **Send Password Reset Link**.
3. Open the email and click the reset link within 60 minutes.
4. Enter your email address and a new password of at least 8 characters, twice. Then click **Reset Password**.
The page answers "If an account exists for that address, we've emailed a password reset link." whichever address you enter, so check that you typed the one on your account. No email after a few minutes? Check your spam folder. See [Change or reset your password](https://self.helpcenter.io/content/change-your-password) for more.
## Reading a private help center
If a team invited you to read their private help center, sign in with the email address the invitation went to. When you open a private help center while signed out, it sends you to this sign-in page, and you return to the help center once you're in.
Some help centers sign readers in with their company's own login instead. If yours does, you're sent to that company's login page rather than this one.
## Sign out
Click your avatar at the bottom of the left menu and choose **Log out**. On a shared computer, sign out when you're done.
## Troubleshooting
**"The provided email and password do not match."** Check that you're using the email address you signed up with. If you still can't get in, reset your password.
**"An account with this email already exists. Sign in with your password, then connect Google from Account Settings."** Your HelpCenter.io email address isn't verified yet, so Google can't be connected for you. Sign in with your password and connect Google yourself.
**"Too Many Requests" (error 429).** You tried to sign in too many times in a short while. Wait a minute, then try again.
**"This account has been suspended. Please contact support for more information."** [Contact our support team](https://self.helpcenter.io/content/contact-support).
For more fixes, see [I can't sign in](https://self.helpcenter.io/content/cant-sign-in).
## Related articles
- [I can't sign in](https://self.helpcenter.io/content/cant-sign-in)
- [Change or reset your password](https://self.helpcenter.io/content/change-your-password)
- [Turn on two-factor authentication](https://self.helpcenter.io/content/two-factor-authentication)
- [Switch between your help centers](https://self.helpcenter.io/content/switch-help-centers)
---
Source: https://self.helpcenter.io/content/free-trial
# How the free trial works
_Category: Plans and billing_
Every HelpCenter.io account starts with a 14-day free trial. You don't need a credit card, so you can build and publish a real help center before you decide to pay.
**Length:** 14 days · **Credit card:** Not needed · **Features:** Those of the plan you picked when you signed up
## What the trial includes
- **The features of your plan.** If you signed up from a plan on the [pricing page](https://helpcenter.io/pricing), you're trying that plan. If you signed up without picking one, you're trying Growth.
- **AI.** A Catalyst trial includes AI Answers and AI writing help. On Bootstrap and Growth they come with the AI add-on, which you can add once you activate your subscription.
- **Your team.** You can send up to 10 invitations during the trial, within your plan's team size.
- **A private start.** New help centers start private, so only your team can see them. [Make your help center public](https://self.helpcenter.io/content/make-your-help-center-public) when it's ready.
Want to try a different plan? Email support@helpcenter.io and we'll switch your trial.
## See how many days are left
1. At the bottom of the left menu, click your avatar, then **Billing & Invoices**.
2. Under **Let's get you started**, you see the plan you're trying and the days left in your trial. Click **Change** to compare it with the other plans.

The days left in your trial appear under the page title.
During the last 7 days, a banner at the top of the dashboard counts down ("Your trial expires in 5 days") with an **Activate Now** button.
## Keep your help center after the trial
Choose a plan and add a payment method whenever you're ready. Activating early doesn't cut your trial short: you keep the days you have left, and your first payment is taken when the trial ends. See [Choose a plan and start your subscription](https://self.helpcenter.io/content/activate-your-subscription).
## When the trial ends
If you haven't activated a plan, your help center goes offline. Visitors see a page that says "This Help Center is Taking a Break", and the dashboard asks you to activate your subscription. Your articles, categories and settings are kept, and activating brings everything back right away. See [What happens when a trial or subscription ends?](https://self.helpcenter.io/content/when-a-subscription-ends)
## Adding more help centers
To create a second help center, activate your subscription first. The new help center gets its own subscription, which starts with the rest of your trial, or with 5 free days if your trial is over. See [Create another help center](https://self.helpcenter.io/content/create-another-help-center).
## Decided HelpCenter.io isn't for you?
You don't need to do anything. We never asked for a card, so nothing is charged. You can delete your help center yourself (see [Export or delete a help center](https://self.helpcenter.io/content/delete-a-help-center)), or email support@helpcenter.io to have your account deleted. We'd be grateful to hear what was missing.
## Related articles
- [Choose a plan and start your subscription](https://self.helpcenter.io/content/activate-your-subscription)
- [What happens when a trial or subscription ends?](https://self.helpcenter.io/content/when-a-subscription-ends)
- [Plans and pricing](https://self.helpcenter.io/content/plans-and-pricing)
- [Will I be charged as soon as I activate?](https://self.helpcenter.io/content/will-i-get-immediately-charged-when-i-activate-my-subscription-plan)
---
Source: https://self.helpcenter.io/content/change-your-subdomain
# Change your help center's address
_Category: Domain, access and SEO_
Every help center has its own address on helpcenter.io, like yourbrand.helpcenter.io. The first part is your subdomain, and you can change it whenever your name changes. Read what happens to the old address before you do.
**Who can do this:** Owners and Admins · **Plans:** All plans
**The old address stops working the moment you save.** It isn't redirected to the new one, and it becomes free for anyone else to take. Links, bookmarks and search results that use it show a "This Help Center Doesn't Exist" page.
## Change your subdomain
1. In the left menu, click the gear icon, then **Settings**.
2. Under **General**, type the new name in **Subdomain**.
3. Click **Save changes**.

The old address stops working as soon as you save.
You'll see "Help center settings successfully updated. Please wait to be redirected..." and the Settings page opens again at its new address.
## Update everything that uses the old address
- **Links and bookmarks.** Update links on your website, in your product, in emails and in saved support replies. Bookmarks to dashboard pages include the old name too.
- **Your custom domain.** If you use one, change the value of its CNAME record to the new address (newname.helpcenter.io) right away, then click **Verify DNS** under **Settings** → **Custom domain**. Links that use your own domain keep working once the record points to the new name. See [Use your own domain](https://self.helpcenter.io/content/custom-domain).
- **Subfolder hosting.** If your help center is served from a path of your website, change your proxy to forward to the new address (newname.helpcenter.io) right away. Until you do, your help center doesn't load at that path. **Settings** → **Subfolder hosting** shows the rules with the new address. See [Host your help center in a subfolder of your website](https://self.helpcenter.io/content/host-your-help-center-in-a-subfolder).
- **Single sign-on.** If your login endpoint sends readers back to the old address, point it at the new one.
- **Iframes and embeds.** Anything that loads your help center by its address, such as an iframe, needs the new address.
- **AI assistants.** Without a custom domain, your help center's public MCP server moves to the new address too. Readers who connected it to their AI assistant need the new URL.
The widget keeps working without changes: its code finds your help center by its widget ID, not by its address.
Custom redirects can't send the old address anywhere, because it no longer belongs to your help center. They only handle paths on your current address. See [Redirect old links to the right page](https://self.helpcenter.io/content/custom-redirects).
## Subdomain rules
- 3 to 63 characters.
- Letters, numbers and dashes. Capital letters are saved as lowercase, and underscores become dashes.
- Not a reserved word. Common names such as www, help, support, docs, kb, api, app, admin, blog and status are reserved.
- Not already used by another help center.
## Choose a good subdomain
Your subdomain is how people find and remember your help center, especially if you don't use a custom domain. Pick one that clearly stands for your business, brand or project. Most companies use their name in lowercase, with dashes instead of spaces: a help center for "My Company" becomes my-company.helpcenter.io.
For a private help center, a short, memorable name makes it easier for your team to come back to it.
## Troubleshooting
**"Subdomain must contain only letters, numbers, and dash (-)."** Remove spaces, dots and other symbols.
**"The subdomain you have chosen is a reserved word. Please choose another one."** Add something that makes it yours, such as your company name.
**"The subdomain has already been taken."** Another help center uses that name. Try a variation.
**Your custom domain stopped verifying after the rename.** Its CNAME record still points to the old address. Update the record's value to your new helpcenter.io address.
## Related articles
- [Use your own domain](https://self.helpcenter.io/content/custom-domain)
- [Redirect old links to the right page](https://self.helpcenter.io/content/custom-redirects)
---
Source: https://self.helpcenter.io/content/is-helpcenter-io-right-for-my-company
# Is HelpCenter.io right for my company?
_Category: Why HelpCenter.io_
Yes, if you want a branded help center that's quick to set up and easy to keep up to date, without paying for a full support suite. It works for teams of any size that answer customer questions with articles.
- **SaaS companies** that want help inside their product: the widget, sign-in for customer-only docs (Catalyst) and an API. See [HelpCenter.io for SaaS companies](https://self.helpcenter.io/content/helpcenter-io-for-saas).
- **E-commerce and service businesses** that answer the same questions every day, with FAQ sections on product and checkout pages.
- **Agencies** that run help centers for clients: each one has its own design, domain and plan.
- **Internal knowledge bases:** keep a help center private or password-protected for your team.
**You may want something else if** you need a ticketing system or shared inbox (HelpCenter.io connects to tools like Zendesk, Front and HubSpot instead), a general website builder, or multi-step content approval.
The quickest way to find out is to try it: start a 14-day free trial, no credit card needed. On Growth and Catalyst, we'll move your existing help center for free.
## Related articles
- [What makes HelpCenter.io different?](https://self.helpcenter.io/content/what-makes-helpcenter-io-unique)
- [HelpCenter.io for SaaS companies](https://self.helpcenter.io/content/helpcenter-io-for-saas)
- [Plans and pricing](https://self.helpcenter.io/content/plans-and-pricing)
---
Source: https://self.helpcenter.io/content/what-is-a-help-center
# What is a help center?
_Category: Help center best practices_
A help center is a website where your customers find answers on their own: how-to guides, troubleshooting steps, FAQs and policies, organized by topic and easy to search. It's where people go when they get stuck, at any hour, before they write to your team.
You're reading one right now. This is HelpCenter.io's own help center, and it's built with HelpCenter.io.
**In one sentence:** a help center is the self-service home for everything your customers need to know to use your product, solve problems and reach a person when they need one.
## What goes in a help center
Most help centers mix a few kinds of content, and each kind answers a different question. Here's what that could look like for an online invoicing app.
| Content | The question it answers | Example title |
| --- | --- | --- |
| Getting started guide | "Where do I begin?" | Send your first invoice |
| How-to article | "How do I do this?" | Add your logo to invoices |
| Troubleshooting article | "Why isn't this working?" | A client didn't get their invoice |
| FAQ | A quick question with a short answer | Can I change my plan later? |
| Account and billing article | "How do I pay, upgrade or cancel?" | Download your receipts |
| Policy | "What are the rules?" | Refund policy |
| Reference | "What exactly does this mean?" | Glossary of invoicing terms |
Alongside the articles, a good help center always shows people how to reach a person when the articles don't solve their problem.
## Who uses a help center
- **Customers** use it to get unstuck without waiting for a reply, including at night, on weekends and in time zones your team doesn't cover.
- **People comparing products** read it to see how yours works, and how well you look after customers, before they buy.
- **Your support team** sends a link instead of typing the same answer again, so every customer hears the same, correct answer.
- **The rest of your company** relies on it too: sales checks what the product can do, and new colleagues learn the product from it.
- **Search engines** list your public articles, so people who type their question into a search box can land on your answer.
- **AI assistants** such as ChatGPT and Claude can read public help centers when someone asks them about your product. Many help centers also have AI built in: readers ask a question in their own words and get an answer written from your articles, with links to the sources.
Each of these readers is a reason to have one. For the full business case, see [Why your business needs a help center](https://self.helpcenter.io/content/why-you-need-a-help-center).
## Public, private or both
Most help centers are public, so anyone can read them and search engines can list them. Some sit behind a login and serve only paying customers or partners.
Others are private and made for your own team: processes, policies, support playbooks and onboarding guides in one searchable place. That's usually called an internal knowledge base, and many companies run one next to their public help center. See [Use a private help center as an internal knowledge base](https://self.helpcenter.io/content/internal-knowledge-base).
## Help center vs FAQ page, knowledge base, forum and contact form
These terms overlap, and people often mix them up. Here's how each one relates to a help center.
| Term | What it is | How it relates to a help center |
| --- | --- | --- |
| **FAQ page** | One page of short questions and answers. | Fine for a handful of questions, but hard to scan as it grows. A help center includes FAQs, plus full guides, categories and search. |
| **Knowledge base** | The organized collection of articles. | The heart of a help center. The two terms are often used for the same thing. See [Help center vs knowledge base: what's the difference?](https://self.helpcenter.io/content/help-center-vs-knowledge-base) |
| **Documentation** | Detailed reference material, often for developers. | Can live inside a help center or next to it. |
| **Community forum** | A place where customers ask and answer each other's questions. | Good for discussion and ideas, but answers vary in quality and go out of date. Turn the best ones into help center articles. |
| **Contact form or ticketing system** | A way to send a message to your team. | For problems that need a person. A good help center makes the form easy to find, and can suggest articles while people type their question. |
## What a modern help center includes
The basics haven't changed: useful articles in a clear structure. What has changed is how people reach them.
- **Search that works as you type.** Results appear while people type, and good search copes with different ways of saying the same thing.
- **AI answers with sources.** Readers ask a question in their own words and get a direct answer built from your articles, with links so they can check it.
- **Help inside your product.** A widget on your website or in your app brings search and articles to the page where people got stuck, so they don't have to leave it.
- **Your brand and your address.** Your logo, your colors and a domain like help.yourcompany.com, so customers know they're in the right place.
- **Works for everyone, on any device.** Pages that read well on a phone and work with a keyboard and a screen reader.
- **Your customers' languages.** Translated articles for each market you serve.
- **Feedback and statistics.** "Was this helpful?" ratings, your most-read articles, and the searches that found nothing.
- **Access control.** Public for everyone, private for your team, or behind your own login.
- **Open to search engines and AI tools.** A sitemap, stable addresses and machine-readable versions of your articles, so answers about your product come from you.
## Help centers worth a look
A few well-run help centers show these ideas in practice:
- [Slack Help Center](https://slack.com/help) leads with search and example questions, groups articles into a handful of sections such as Getting started and Workspace administration, and names articles after tasks.
- [Figma's help center](https://help.figma.com/hc/en-us) pairs search with a short getting-started path for new users, and puts Contact support next to its community forum.
- [Stripe Support](https://support.stripe.com/) opens with "How can we help?" and a list of the most popular articles, so the common questions are one click away.
- [GitHub Docs](https://docs.github.com/en) organizes a very large library by product area and says plainly when a feature has been retired, instead of letting its pages disappear.
## How to start a help center
1. **Collect the questions people already ask.** Your support inbox, chat history, sales calls and onboarding sessions are full of them. Write each one down in the customer's own words.
2. **Group them into five to ten categories.** Name each category the way customers would, not the way your teams are organized. See [Plan your help center's structure](https://self.helpcenter.io/content/plan-your-help-center).
3. **Write your first ten articles.** Start with the questions you answer most often, one question per article. See [The first 10 articles every help center needs](https://self.helpcenter.io/content/first-articles).
4. **Choose where it lives.** Help center software gives you hosting, search, structure and statistics from day one. A custom build takes longer and needs someone to maintain it. See [Why use a hosted help center instead of building your own?](https://self.helpcenter.io/content/why-should-i-go-with-a-hosted-solution-instead-of-creating-my-own)
5. **Make it easy to find.** Link to it from your website's header or footer, your product's help menu, your emails and your support replies.
6. **Improve it every month.** Look at the searches that found nothing and the articles with low ratings, then fix what they point to. See [Help center metrics that matter](https://self.helpcenter.io/content/help-center-metrics).
## A quick checklist
Your help center is doing its job when:
- It answers the questions your team hears most often.
- Article titles use your customers' words, not internal jargon.
- Search finds the right article on the first try.
- Each article covers one task or one question.
- People can reach a person when the articles aren't enough.
- It's linked from your website, your product and your emails.
- It reads well on a phone.
- Someone owns it and keeps it accurate as your product changes.
## How HelpCenter.io helps
HelpCenter.io is help center software. You write articles in a visual editor, pick a theme and publish to your own domain. Every plan includes search, the widget for your website and app, statistics, and a way for readers to connect their own AI assistant to your public help center. AI Answers are included on Catalyst and available as an add-on on Bootstrap and Growth. To try it, [create your HelpCenter.io account](https://self.helpcenter.io/content/create-your-account). The 14-day free trial needs no credit card.
## Related articles
- [Why your business needs a help center](https://self.helpcenter.io/content/why-you-need-a-help-center)
- [Help center vs knowledge base: what's the difference?](https://self.helpcenter.io/content/help-center-vs-knowledge-base)
- [Plan your help center's structure](https://self.helpcenter.io/content/plan-your-help-center)
- [The first 10 articles every help center needs](https://self.helpcenter.io/content/first-articles)
- [Create your HelpCenter.io account](https://self.helpcenter.io/content/create-your-account)
---
Source: https://self.helpcenter.io/content/why-you-need-a-help-center
# Why your business needs a help center
_Category: Help center best practices_
A help center answers your customers' questions at any hour, takes repeat questions off your team's plate, and gives people, search engines and AI assistants one reliable source of truth about your product. Here's what that looks like in practice, and what it takes.
## Customers get answers when they want them
Questions don't wait for office hours. A customer setting up your product late on a Sunday, or in a time zone your team doesn't cover, can find the answer and keep going instead of waiting until morning for a reply.
And not everyone wants to write to support. Some people don't want to wait, some find it hard to describe a problem in a message, and some prefer to learn a product on their own terms. A help center lets them solve the problem now.
## Your team stops answering the same question twice
Every support team has questions it answers again and again. Write the answer once, carefully, and link to it from then on. Your frequently asked questions become frequently answered ones, and your team spends its time on the problems that need a person.
A link in a support reply also shows the customer where to look next time.
## New customers get going faster
The first days with a product often decide whether people stay. Getting started guides and short how-tos help new customers reach their first success without booking a call. A help widget inside your product puts that help on the page where they need it.
## Everyone gives the same answer
When answers live in people's heads, customers hear one thing from support and another from sales. A help center gives everyone the same version, and when something changes, you update it in one place.
The same goes for your team. An internal knowledge base with your processes and policies means fewer interruptions and a faster start for new colleagues. See [Use a private help center as an internal knowledge base](https://self.helpcenter.io/content/internal-knowledge-base).
## People find you through search
People type questions into search engines all day, including questions your product answers. Public help center articles can appear for those searches, both for your customers and for people who are still comparing options. Every useful article is one more way for someone to find you. See [Help center SEO: get your articles found](https://self.helpcenter.io/content/help-center-seo).
## AI assistants give better answers about your product
People ask AI assistants about products too. When someone asks about yours, the assistant answers from what it can read. Clear, current, public articles give it the right facts to work with.
AI answers inside your own help center work the same way: they reply to questions in the customer's own words, using your articles as the source. See [Make your help center ready for AI](https://self.helpcenter.io/content/ai-ready-help-center).
## You learn what confuses customers
A help center shows you things a ticket queue doesn't. Searches that find nothing show what's missing. Articles with low ratings show what doesn't help. A troubleshooting article that everyone reads can point to a part of your product worth fixing. See [Help center metrics that matter](https://self.helpcenter.io/content/help-center-metrics).
## Signs you need one now
- Your team answers the same questions every week.
- Customers wait hours for answers you could have written down once.
- New customers need a call or a demo before they can get started.
- Your FAQ page has grown too long to scan.
- Colleagues keep asking each other how things work.
- You're moving into new markets or languages.
## What it takes
A help center doesn't have to be a big project, but it does need some care. You need:
- **Time to write the first articles.** Start with ten, not a hundred. See [The first 10 articles every help center needs](https://self.helpcenter.io/content/first-articles).
- **An owner.** One person who makes sure articles stay accurate and gaps get filled.
- **A habit.** Update articles when the product changes, and check what people search for. See [Keep your help center up to date](https://self.helpcenter.io/content/keep-your-help-center-up-to-date).
## What a help center won't do
It won't replace your support team. Some problems need a person, and a help center works best when reaching one is easy. It won't fix a confusing product either, though it will show you where the confusion is. And it only stays useful while someone keeps it current.
## Make the case to your team
If you need buy-in, use the numbers you already have rather than industry averages:
1. List your five most common support questions and how many times each came in last month.
2. Estimate how long your team spends answering them.
3. Note how long customers wait for a first reply, especially outside office hours.
4. Propose a small start: articles for those five questions, then compare next month's numbers with this month's.
For example, if 120 messages a month ask how to reset a password and each one takes your team four minutes, one clear article can win back up to eight hours a month. Two or three questions like that usually make the case on their own.
## How HelpCenter.io helps
HelpCenter.io gives you a help center on your own domain, with search, the widget for your website and app, and statistics on every plan. AI Answers reply to questions from your articles and link to their sources, on Catalyst or with the AI add-on on Bootstrap and Growth. You pay a flat price per help center, not per agent. See [Plans and pricing](https://self.helpcenter.io/content/plans-and-pricing).
## Related articles
- [What is a help center?](https://self.helpcenter.io/content/what-is-a-help-center)
- [Reduce support tickets with self-service](https://self.helpcenter.io/content/reduce-support-tickets)
- [Help center metrics that matter](https://self.helpcenter.io/content/help-center-metrics)
- [The first 10 articles every help center needs](https://self.helpcenter.io/content/first-articles)
---
Source: https://self.helpcenter.io/content/custom-css
# Add custom CSS
_Category: Design and templates_
Fine-tune your help center's look with your own CSS when the theme settings don't go far enough. You add CSS as labeled snippets, watch the preview change as you type, and publish when it looks right.
This is for people comfortable with CSS. For colors, fonts, spacing and corner radius, start with the **Theme** tab: those settings work in light and dark mode without any code.
**Who can do this:** Owners and Admins (Editors through **Customize** on your help center) · **Plans:** All plans
## Add a CSS snippet
1. In the left menu, click **Template editor**, then open the **Advanced** tab.
2. Under **Custom CSS**, click **Add custom CSS**.
3. Give the snippet a label that says what it does, for example "Bigger logo".
4. Write your CSS in the code editor. The preview updates as you type.
5. Click **Save** to fold the snippet away. Your draft saves on its own either way.
6. Click **Publish** to put it live.

Label each snippet so your team knows what it's for.
The recording uses a snippet like this one. Your logo shows 32 pixels tall, and this makes it 48:
```
.hc-logo-img {
height: 48px;
}
```
## Manage your snippets
- **Edit** opens a folded snippet again.
- The **Enabled** switch turns a snippet off without deleting it. A disabled snippet stays saved but isn't used.
- The up and down arrows change the order. Snippets are combined from top to bottom, so when two rules are equally specific, the lower one wins.
- The trash icon removes a snippet. Press ⌘Z (Ctrl+Z) to bring it back.
Your theme may come with snippets of its own. Compass's start with "Compass ·" and hold part of its look. Leave them in place and add yours below them.
## How your CSS is applied
- **It only styles your help center.** HelpCenter.io puts `#hc-site` in front of every selector, so your rules can't leak into anything else. You don't need to write `#hc-site` yourself.
- **Rules for `html`, `body` or `:root`** apply to that `#hc-site` wrapper instead. The [Custom CSS reference](https://self.helpcenter.io/content/custom-css-reference) explains what that means for your selectors.
- **Up to 200 KB in total.** That covers all your enabled snippets together. Above the limit, none of your custom CSS is applied, and your draft can't be saved until you trim it.
- **Some things are removed for safety:** `@import`, `@charset`, `@namespace`, `javascript:` URLs, `behavior` and `expression()`. To change fonts, use the **Theme** tab.
- **Applying a theme can replace your snippets.** When you apply a theme with **Custom CSS** ticked, the theme's snippets replace yours. Untick it in the **Apply theme** dialog to keep them.
**One missing brace turns off all your custom CSS.** If any snippet has an unmatched `{` or `}`, none of your snippets are applied, in the preview or on your live help center. If all your styling disappears at once, look for the missing brace in the snippet you edited last.
## Write CSS that keeps working
- Target the hooks made for customization, such as `[data-hc-component-type="CategoryGrid"]` or `.hc-article__title`, rather than utility classes that can change. The [Custom CSS reference](https://self.helpcenter.io/content/custom-css-reference) lists them.
- Use theme variables instead of fixed colors, so your rules look right in light and dark mode.
- Check **Mobile**, **Tablet** and **Dark** in the preview before you publish.
- Keep a visible focus outline on anything readers can click, for people who use a keyboard.
For example, this colors every article title with your brand color, in a shade that stays readable in both modes:
```
.hc-article__title {
color: var(--hc-color-primary-text);
}
```
## Troubleshooting
**The preview is right, but your help center isn't.** Click **Publish**. Custom CSS goes live with the rest of your draft.
**All your custom CSS stopped working.** Look for an unmatched brace, and check that your snippets together stay under 200 KB.
**One rule does nothing.** Check that the snippet is enabled and that the selector matches the page. See [My custom CSS doesn't work](https://self.helpcenter.io/content/custom-css-not-working).
## Related articles
- [Custom CSS reference: selectors and examples](https://self.helpcenter.io/content/custom-css-reference)
- [My custom CSS doesn't work](https://self.helpcenter.io/content/custom-css-not-working)
- [Add analytics and other scripts](https://self.helpcenter.io/content/scripts)
---
Source: https://self.helpcenter.io/content/cant-sign-in
# I can't sign in
_Category: Troubleshooting_
Most sign-in problems have a quick fix. Find the message you see below, or work through the checks in order.
## "The provided email and password do not match."
HelpCenter.io didn't recognize that email and password together.
1. Check that you're on the sign-in page at [helpcenter.io/app/signin](https://helpcenter.io/app/signin).
2. Use the email address your account was created with. If a team invited you, that's the address the invitation went to.
3. Check that Caps Lock is off, and that your password manager didn't fill in the details of another account.
4. Still no luck? Reset your password (next section).
Were you invited but never finished signing up? Open the invitation email and create your account from its link first. Until you do, there's no password to sign in with.
## Reset your password
1. On the sign-in page, click **Forgot password?**
2. Enter your email address and click **Send Password Reset Link**.
3. Open the email with the subject "Reset Password Notification" and click the link in it. The link works for 60 minutes.
4. Enter your **Email address** and a **New password** of at least 8 characters, confirm it, then click **Reset Password**.
Messages you might see along the way:
- **"If an account exists for that address, we've emailed a password reset link."** You see this for every address, to keep it private who has an account. If no email arrives, try the other email addresses you use, and wait a minute before you ask for another link.
- **"This password reset token is invalid."** The link is more than 60 minutes old, or it was already used. Request a new one.
No email after a few minutes? Check your spam folder for a message from app@helpcenter.io. See [I'm not getting emails from HelpCenter.io](https://self.helpcenter.io/content/not-getting-emails).
## Signing in with Google doesn't work
- **"An account with this email already exists. Sign in with your password, then connect Google from Account Settings."** Your HelpCenter.io email address isn't verified yet. Sign in with your password, then click **Connect** under **Sign-in Methods** in Account Settings.
- **"This account is connected to a different Google account. Sign in with that one, or with your password."** Pick the Google account you connected before, or use your password.
- **"Google has not verified the email address on that account, so it cannot be used to sign in."** Verify the address with Google, or sign in with your email and password.
- **"Your Google sign-in expired or was started in another tab. Please try again."** Go back to the sign-in page and click **Continue with Google** again.
- **You created your account with Google and have no password.** Use **Continue with Google**. To add a password, see [Change or reset your password](https://self.helpcenter.io/content/change-your-password).
## "Too Many Requests" (error 429)
After several sign-in attempts in a short time, HelpCenter.io pauses sign-in for that email address for a minute. Wait a minute, then try again. If you're not sure of your password, reset it instead of guessing.
## Your two-factor code isn't accepted
If the **Two-Factor Authentication** page says **"The provided two factor authentication code was invalid."**:
- Type the code your authenticator app shows at that moment. Codes change every 30 seconds, and each code works only once.
- Check that you're reading the HelpCenter.io entry in your app, not the code for another account.
- Set your phone's date and time to update automatically. Codes are based on the clock, so a phone that runs fast or slow produces codes that don't match.
Lost the phone with your authenticator app? See [I lost my authenticator device](https://self.helpcenter.io/content/lost-two-factor-device).
## "This account has been suspended."
The full message reads **"This account has been suspended. Please contact support for more information."** Only our team can help here. Contact us from the email address on the account.
## "Page Expired" (error 419), or the page reloads without an error
HelpCenter.io needs cookies to sign you in. If your browser blocks them or holds on to old ones, you can land back on the sign-in page with no message at all.
1. Reload the sign-in page and try again. A sign-in page that was left open for a long time shows "Page Expired" when you submit it.
2. Try a private (incognito) window. If sign-in works there, the problem is in your usual browser's cookies or extensions.
3. Allow cookies for helpcenter.io, or clear its cookies. Here's how in [Chrome](https://support.google.com/chrome/answer/95647), [Firefox](https://support.mozilla.org/en-US/kb/delete-cookies-remove-info-websites-stored), [Safari](https://support.apple.com/guide/safari/manage-cookies-sfri11471/mac) and [Edge](https://support.microsoft.com/en-us/help/4027947/windows-delete-cookies).
## Signing in to read a help center
- **A private help center** opens only for people on its team. Ask the team to invite you (the Viewer role is enough to read), then sign in with the address the invitation went to.
- **A help center that uses single sign-on** signs you in through its company's own login page, not with a HelpCenter.io password. If that doesn't work, contact the company that runs the help center.
## Still stuck?
Write to us from the email address on your account and tell us what you see on the screen. See [Contact HelpCenter.io support](https://self.helpcenter.io/content/contact-support).
## Related articles
- [Sign in to HelpCenter.io](https://self.helpcenter.io/content/sign-in)
- [Change or reset your password](https://self.helpcenter.io/content/change-your-password)
- [I lost my authenticator device](https://self.helpcenter.io/content/lost-two-factor-device)
---
Source: https://self.helpcenter.io/content/table-of-contents
# When does an article show a table of contents?
_Category: Write articles_
When the article has headings and your theme's Article page includes the **Table of contents** component. Readers then see an **On this page** list beside the article and can jump to any section.

The On this page list follows the reader down the article.
The list is built from the article's headings, starting at Heading 2. The article title isn't included, and an article without headings shows no list. Use Heading 2 for your main sections and Heading 3 for the parts inside them.
Compass, the default theme, includes the component. To add it, remove it or change it:
1. Open the **Template editor**, go to **Pages** and pick the **Article** page.
2. The component lives in the **Sidebar** or **Utility** region. Add it there with **Add component**, or click it to edit it.
3. In **Heading levels**, choose how deep the list goes, from Heading 2 only down to Heading 5. **Sticky** keeps it in view while readers scroll.
4. Click **Publish**.
## Related articles
- [Add headings, lists and other blocks](https://self.helpcenter.io/content/add-blocks)
- [Customize the article page](https://self.helpcenter.io/content/article-page)
---
Source: https://self.helpcenter.io/content/why-should-i-go-with-a-hosted-solution-instead-of-creating-my-own
# Why use a hosted help center instead of building your own?
_Category: Why HelpCenter.io_
A help center looks like a few pages of articles, but behind it sits software: an editor, search, hosting, security, SEO and more. A hosted help center gives you all of that ready to use, so your team spends its time on the answers instead of on the platform.
## What you'd have to build and keep running
Here's what a good help center needs, and what HelpCenter.io takes care of for you.
| What you need | What HelpCenter.io gives you |
| --- | --- |
| An editor your whole team can use | A rich editor with drafts, templates, version history, and roles for writers, translators and admins. |
| Search that finds answers | Results that appear as readers type. With AI Answers (Catalyst, or the AI add-on), readers can ask a question and get an answer written from your articles, with sources. |
| Search engine basics | A sitemap, canonical links, language tags and a search title and description for every article. |
| Readiness for AI tools | AI-readable versions of your pages, an llms.txt file, and a public MCP server readers can add to their AI assistant. |
| Accessibility | Themes with keyboard navigation, a skip link, screen reader landmarks, automatic color contrast and support for reduced motion. |
| Security and access | HTTPS on every page, free SSL certificates for your own domain, two-factor sign-in for your team, and private or password-protected help centers. Catalyst adds single sign-on for readers. |
| Hosting and backups | We run the servers, update the software and back up your data several times a day. Growth and Catalyst come with a 99.9% uptime guarantee. |
| Languages | Several languages, each with its own addresses, on Growth and Catalyst, plus AI translation on Catalyst. |
| Knowing what's missing | Statistics on what readers search for and don't find, and which articles they rate as helpful. |
| Help inside your product | A widget for your website or app, and FAQ sections you can embed on any page. |
## The real cost of building it yourself
Each row above has to be designed, built and tested, then maintained. The work doesn't stop at launch: browsers, search engines and AI tools keep changing, certificates expire, and someone has to fix the site when it goes down. For most teams, that's a second product to look after.
HelpCenter.io starts at $29/month per help center (Bootstrap, billed yearly), with no per-agent fees. See [Plans and pricing](https://self.helpcenter.io/content/plans-and-pricing).
## When building your own can make sense
Some large companies with specific requirements build their own. That can be the right call if your documentation has to live inside a system you already run, or you need workflows HelpCenter.io doesn't offer, such as multi-step approvals.
If you'd rather host a knowledge base yourself, Compass, HelpCenter.io's default theme, is also free and open source (GPL-3.0) as plain HTML, CSS and JavaScript on [knowledgebase.dev](https://knowledgebase.dev/).
## You stay in control of your content
A hosted help center doesn't mean giving up your content. Serve it from your own domain, export articles as PDF whenever you like, or copy everything out through the API. See [Do you back up my content?](https://self.helpcenter.io/content/do-you-create-a-backup-of-my-content)
## Related articles
- [Is HelpCenter.io right for my company?](https://self.helpcenter.io/content/is-helpcenter-io-right-for-my-company)
- [Security and privacy at HelpCenter.io](https://self.helpcenter.io/content/security-and-privacy)
- [Plans and pricing](https://self.helpcenter.io/content/plans-and-pricing)
---
Source: https://self.helpcenter.io/content/create-your-account
# Create your HelpCenter.io account
_Category: Getting started_
Sign up to start your 14-day free trial. You create your account and your first help center in two short steps, and you don't need a credit card.
**Who can do this:** Anyone · **Plans:** 14-day free trial, no credit card needed
## Create your account
1. Go to [helpcenter.io/app/signup](https://helpcenter.io/app/signup), or click **Start free trial** on our [pricing page](https://helpcenter.io/pricing).
2. Under **What is your name?**, enter your full name.
3. Under **What's your email?**, enter your work email address.
4. Under **Choose a password**, enter a password of at least 6 characters. Type it again under **Confirm your password**.
5. Tick **I agree to the terms of service and privacy policy.** The box for news and offers from HelpCenter.io is optional.
6. Click **Continue**.

Continue stays grayed out until you fill in your details and tick the terms box.
## Or sign up with Google
Click **Sign up with Google** at the top of the sign-up page and pick your Google account. The form comes back as **Finish creating your account**, with your Google address under **Your email** and no password fields. Check your name, tick the terms box and click **Continue**, then choose your subdomain as described below.
You sign in with that Google account from then on, and your email address counts as verified, so no verification email is sent. You can add a password later in **Account Settings**. To go back to the email form, click **Use email instead**.
## Choose your subdomain
Your subdomain is your help center's address, such as `acme.helpcenter.io`. Your company or product name is a good choice.
1. Type it under **Your subdomain**. A tick means it's free.
2. Click **Ready? Let's Start!**

Your help center is created and its dashboard opens.
A subdomain is 3 to 63 characters long and uses letters, numbers and dashes. Capital letters are saved as lowercase. Reserved words, such as `app`, `help`, `support` and `www`, and some protected brand names aren't available.
You can change your subdomain later, but links to the old address stop working, so it pays to choose carefully. See [Change your help center's address](https://self.helpcenter.io/content/change-your-subdomain). You can also serve your help center from your own domain, such as help.yourcompany.com: see [Use your own domain](https://self.helpcenter.io/content/custom-domain).
## What you get
- **A help center named after your subdomain.** To rename it, change **Site name** under **Brand** in the template editor, then publish.
- **A first category and article.** A **General** category with a draft article named after your help center, such as "What is Acme?". Edit them or delete them.
- **A ready-made design** that you can change in the template editor.
- **Privacy while you build.** New help centers are **Private**: only you and the people you invite can see yours. [Make it public](https://self.helpcenter.io/content/make-your-help-center-public) when you're ready.
- **A 14-day free trial** of the plan you picked on our pricing page, or of Growth if you signed up without picking one. See [How the free trial works](https://self.helpcenter.io/content/free-trial).
## Verify your email
If you signed up with Google, skip this step. Otherwise, we send you an email to confirm your address. Open it and click **Verify Email Address**. The link works for 60 minutes.
You need a verified email to make your help center public and to activate your subscription. If the email doesn't arrive, check your spam folder. To get a new link, click your avatar at the bottom of the dashboard's left menu, then **Account Settings**, and click **Resend** under your email address.
## Joining a teammate's help center?
If someone invited you, use the link in your invitation email instead of signing up here. You create your account without choosing a subdomain and go straight to their help center.
## Troubleshooting
**"The email has already been taken."** You already have an account with that address. [Sign in](https://self.helpcenter.io/content/sign-in) instead, or reset your password from the sign-in page.
**"The password field must be at least 6 characters." or "The password field confirmation does not match."** Use at least 6 characters, and type exactly the same password in both fields.
**"The subdomain has already been taken." or "The subdomain you have chosen is a reserved word. Please choose another one."** Try another address, for example your company name with your product name added.
**"Subdomain must contain only letters, numbers, and dash (-)."** Remove spaces, dots and other symbols.
**"This subdomain contains a protected brand name."** Subdomains that contain certain well-known brand names are blocked. Choose one based on your own company's name.
**"The captcha verification failed. Please try again." or "The captcha has expired. Please refresh and try again."** Reload the page and sign up again.
## Related articles
- [Set up your help center: a first-hour checklist](https://self.helpcenter.io/content/set-up-your-help-center)
- [Sign in to HelpCenter.io](https://self.helpcenter.io/content/sign-in)
- [Make your help center public](https://self.helpcenter.io/content/make-your-help-center-public)
- [How the free trial works](https://self.helpcenter.io/content/free-trial)
---
Source: https://self.helpcenter.io/content/switch-help-centers
# Switch between your help centers
_Category: Getting started_
Manage several help centers? Move between them without signing in again. You land in the same section of the other help center, so if you're looking at Statistics in one, you see Statistics in the next.
**Who can do this:** Anyone on the team of more than one help center · **Plans:** All plans
## Switch from the left menu
1. Hover over the logo at the top of the left menu. It shows which help center you're in.
2. Click the arrow next to it to list your other help centers.
3. Click the help center you want.

You stay in the same section when you switch.
In the list, a lock means the help center isn't public, and a globe means it has more than one language. **View Site** opens the help center you're in.
If your role in the other help center doesn't include the section you're on, you land on its Articles page. If you're a Viewer there, you go to the help center itself, because Viewers don't use the dashboard.
## Use My Help Centers
My Help Centers lists every help center you belong to. Open it at [helpcenter.io/app/sites](https://helpcenter.io/app/sites), or open **Account Settings**, click your name at the top of the page, then click **My Help Centers**. Click a help center to open it.
It's also the page you see right after you sign in, and where account owners create new help centers. See [Create another help center](https://self.helpcenter.io/content/create-another-help-center).
## Troubleshooting
**A help center is missing from the list.** Check that you signed in with the email address you were invited with. If it's still missing, ask the help center's owner or an admin to check that you're on its team.
## Related articles
- [Create another help center](https://self.helpcenter.io/content/create-another-help-center)
- [Find your way around the dashboard](https://self.helpcenter.io/content/dashboard-tour)
---
Source: https://self.helpcenter.io/content/resize-images-and-add-alt-text
# Resize images and add alt text
_Category: Write articles_
Give each image the right size and position in your article, and add alt text so everyone understands it, including people who use screen readers.
**Who can do this:** Owners, Admins and Editors · **Plans:** All plans (AI alt text: Catalyst plan, or the AI add-on on Bootstrap and Growth)
## Start with an image
1. If the image isn't in the article yet, type `/image` on an empty line, press Enter and pick a file.
2. Click the image. Its toolbar appears above it.

Start by adding the image to your article.
## Resize an image
1. Click the image.
2. Point at its left or right edge until the pointer becomes a double arrow.
3. Drag inward to make the image smaller, or outward to make it bigger.
The width is saved as a share of the article's width, from 10% up to the full width, and the height follows so the image keeps its shape. On phones, images shrink to fit the screen.
### Images inside a line of text
For a small image that sits inside a sentence, click it and click **Size**. Choose **Text height** to make it as tall as the words around it, **Original** for its own size, or type a width in pixels and click the check mark.
## Align an image
Click the image, then click **Align to left**, **Align to center** or **Align to right**. With left or right alignment, the text flows around the image, which works well for small images next to a short paragraph.
## Add alt text
1. Click the image, then click **Alt text and title**.
2. In **Alt text**, describe what the image shows.
3. If you like, add a **Title**. Readers see it as a tooltip when they point at the image.
4. Press Enter or click the check mark to save.
## Write alt text that helps
Screen readers read alt text aloud, search engines use it to understand your images, and browsers show it when an image can't load.
- Describe what matters for the reader's task. "The Settings page with the Custom domain field filled in" says more than "Screenshot".
- Skip "Image of" and "Picture of". Screen readers already announce that it's an image.
- Keep it to a sentence. If the text next to the image already explains it, a few words are enough.
## Draft alt text with AI
In the **AI writing help** card, click **Write alt text for images**. AI writes alt text for up to four block images that don't have any yet, and adds it to them straight away. Click each image and open **Alt text and title** to check what it wrote. Run it again for the next four.
## Related articles
- [Add images to an article](https://self.helpcenter.io/content/add-images)
- [Write accessible help content](https://self.helpcenter.io/content/accessible-help-content)
- [How accessible is my help center?](https://self.helpcenter.io/content/accessibility)
---
Source: https://self.helpcenter.io/content/do-you-create-a-backup-of-my-content
# Do you back up my content?
_Category: Why HelpCenter.io_
Yes. We back up all your data several times a day, so if something goes wrong on our side, we can restore it.
You also have safety nets of your own:
- **Version history:** every change your team saves in the editor is listed with who made it and when, and you can restore an earlier version. Changes made through the API or by an AI agent are listed too, under the name System. How far back you can go depends on your plan. [Learn how to restore a version](https://self.helpcenter.io/content/article-versions).
- **Trash:** deleted articles go to Trash, where you can restore them. Only Owners and Admins can delete them permanently. See [Delete and restore articles](https://self.helpcenter.io/content/delete-and-restore-articles).
- **PDF export:** export the articles you select, or your whole help center from **Settings** → **Danger zone**. See [Export articles as PDF](https://self.helpcenter.io/content/export-articles-as-pdf).
- **API export:** with an API key, `GET /v1/export` returns your categories and articles with their content, so you can keep your own copy. Articles in Trash and your team's notes aren't included. See [Create an API key](https://self.helpcenter.io/content/create-an-api-key) and [Back up your help center](https://developers.helpcenter.io/content/back-up-your-help-center) on the developer portal.
## Related articles
- [Security and privacy at HelpCenter.io](https://self.helpcenter.io/content/security-and-privacy)
- [See and restore earlier versions of an article](https://self.helpcenter.io/content/article-versions)
- [Delete and restore articles](https://self.helpcenter.io/content/delete-and-restore-articles)
---
Source: https://self.helpcenter.io/content/who-can-see-your-help-center
# Control who can see your help center
_Category: Domain, access and SEO_
Decide who can read your help center: anyone on the internet, only your team, or anyone who knows a password. New help centers start as Private, so you can get your content ready before anyone else sees it.
**Who can do this:** Owners and Admins
## The three options
You'll find them in **Settings**, under **General** → **Access & visibility**.
| Option | Who can read it | How they get in |
| --- | --- | --- |
| **Public** | Anyone on the internet. Search engines can list it. | No sign-in needed. |
| **Private** | People on your team, in any role, including Viewers. | They sign in with their HelpCenter.io account. |
| **Password** | Anyone you give the password to. | One shared password. No account needed. |
## Make your help center private
1. In the left menu, click the gear icon, then **Settings**.
2. Under **Access & visibility**, choose **Private**.
3. Click **Save changes**.

Private limits reading to your team.
To let someone read a private help center, invite them to your team. The **Viewer** role is for people who only need to read. See [Invite your team](https://self.helpcenter.io/content/invite-your-team).
Anyone who opens a private help center without being signed in is asked to sign in with their HelpCenter.io account. After they sign in, they go straight back to the page they were trying to open. If you use JWT single sign-on, visitors go to your own login instead.

What visitors see when they open a private help center.
## Protect it with a password
1. In the left menu, click the gear icon, then **Settings**.
2. Under **Access & visibility**, choose **Password**.
3. Enter the **Access password** you'll share with readers.
4. Click **Save changes**.

Everyone who reads your help center uses the same password.
Visitors now see a password page first. After they enter the right password, the help center stays open in that browser for up to 7 days. Team members who are signed in to HelpCenter.io skip the password page.

The password page shows your help center's name.
- **To change the password,** type a new one in **Access password** and save. Everyone who used the old password is signed out and needs the new one.
- **To keep the current password** while you change other settings, leave the field empty.
- You have to enter a password the first time you choose this option. Otherwise saving fails with "Please set a password before switching the help center to password-protected visibility."
## Make it public
1. In **Settings**, under **Access & visibility**, choose **Public**.
2. Click **Save changes**.
The account owner has to confirm their email address first. Until then, choosing Public shows "Confirm the owner's email address before making the help center public." See [Make your help center public](https://self.helpcenter.io/content/make-your-help-center-public).
## Which to choose
| You want | Use |
| --- | --- |
| Help for customers and prospects that anyone can find | **Public** |
| An internal knowledge base for your team | **Private**. See [Use a private help center as an internal knowledge base](https://self.helpcenter.io/content/internal-knowledge-base). |
| A customer portal for people who sign in to your product | **Private** with JWT single sign-on, so readers use their existing login (Catalyst plan). See [Sign readers in with your own login](https://self.helpcenter.io/content/jwt-sso). |
| A preview before launch, or access for a few partners without accounts | **Password** |
| Help that appears only inside your product | **JS-only access**. See [Show your help center only inside your app](https://self.helpcenter.io/content/js-only-access). |
| Access only from your office network or VPN | **IP whitelisting**, on top of any option above. See [Restrict access by IP address](https://self.helpcenter.io/content/ip-allowlist). |
To keep a help center public but hide some of its content, make individual categories or articles private instead. See [Make a category private](https://self.helpcenter.io/content/private-categories) and [Choose who can read an article](https://self.helpcenter.io/content/article-access).
## Search engines and AI assistants
Private and Password help centers never appear in search results, because search engines can't get past the sign-in or password page. They also have no public MCP server, so readers can't connect them to an AI assistant. To keep a public help center out of search results, see [Hide your help center from search engines](https://self.helpcenter.io/content/hide-from-search-engines).
## Related articles
- [Restrict access by IP address](https://self.helpcenter.io/content/ip-allowlist)
- [Sign readers in with your own login (JWT SSO)](https://self.helpcenter.io/content/jwt-sso)
- [Show your help center only inside your app](https://self.helpcenter.io/content/js-only-access)
- [Make a category private](https://self.helpcenter.io/content/private-categories)
- [Someone can't see an article or the help center](https://self.helpcenter.io/content/cant-see-an-article)
---
Source: https://self.helpcenter.io/content/create-another-help-center
# Create another help center
_Category: Getting started_
You can run as many help centers as you need from one HelpCenter.io account, for example one for each product or brand. Each help center has its own subscription, and you manage them all from the same place.
**Who can do this:** The account owner · **Plans:** All plans, once your subscription is active (each help center is billed on its own)
## Before you start
- **Activate your subscription.** On the free trial, before you subscribe, you can't add a second help center: you see "Oops, you do not seem to have an active subscription, yet." Click **Activate Subscription** to subscribe first. See [Choose a plan and start your subscription](https://self.helpcenter.io/content/activate-your-subscription).
- **Use the account owner's login.** If you created your HelpCenter.io account from a teammate's invitation, you don't see **Create New Help Center**. Ask the account owner to create the help center.
## Create a help center
1. Go to My Help Centers at [helpcenter.io/app/sites](https://helpcenter.io/app/sites).
2. Click **Create New Help Center**.
3. Under **Choose your subdomain**, type the new help center's address. A tick means it's free.
4. Click **Create**.
5. Check the confirmation: it shows the price of the new subscription. To choose a different plan or billing period for this help center, click **Adjust Plan**.
6. Click **Yes, continue and create it**.

You see the price before anything is created.
## What happens next
- The new help center opens on its Articles page, with a **General** category and a draft article to start from.
- It starts **Private**. When it's ready for readers, see [Make your help center public](https://self.helpcenter.io/content/make-your-help-center-public).
- Its subscription starts with a free trial: the days left on your own free trial, or 5 days if your trial is over.
- Nothing is copied from your other help centers. Give it its own design, and invite its team separately. See [Invite your team](https://self.helpcenter.io/content/invite-your-team).
Each help center is billed at its plan's flat price, not per team member. See [How much does each additional help center cost?](https://self.helpcenter.io/content/additional-help-centers) and [Plans and pricing](https://self.helpcenter.io/content/plans-and-pricing).
## Troubleshooting
**"The subdomain has already been taken."** Pick another address. The same rules apply as when you signed up: 3 to 63 characters, using letters, numbers and dashes.
**"Could not create your help center at the moment. Please contact us."** [Contact our support team](https://self.helpcenter.io/content/contact-support) and tell us the subdomain you tried.
## Related articles
- [Switch between your help centers](https://self.helpcenter.io/content/switch-help-centers)
- [How much does each additional help center cost?](https://self.helpcenter.io/content/additional-help-centers)
- [Plans and pricing](https://self.helpcenter.io/content/plans-and-pricing)
---
Source: https://self.helpcenter.io/content/article-metadata
# Show or hide the author, date and reading time
_Category: Design and templates_
Under each article's title, readers can see who wrote it, when it was last updated and how long it takes to read. Choose which of the three to show, or hide the line altogether.
**Who can do this:** Owners and Admins (Editors through **Customize** on your help center) · **Plans:** All plans
## Choose what shows
1. In the template editor, open **Pages** and pick the **Article** page.
2. Under **Regions**, click **Main**. The **Article metadata** component sits in the **After the title** zone.

How to reach the Article page's Main region. The recording then adds other components.
1. Click **Article metadata** to open its settings.
2. Under **What each item shows**, turn **Author**, **Last updated** and **Reading time** on or off.
3. Click **Publish**.
## What each part shows
| Part | What readers see |
| --- | --- |
| **Author** | The name of the article's author. It's left out on articles without an author. |
| **Last updated** | The date the article was last updated, written the way the reader's language writes dates. |
| **Reading time** | An estimate such as "4 min read", based on the article's length at about 220 words a minute. Notes for your team don't count. |
## Hide the line completely
1. In the **Main** region of the Article page, open the **⋯** menu on the **Article metadata** row.
2. Choose **Delete**, then **Remove**.
3. Click **Publish**.
To bring it back, click **Add to "After the title"** and pick **Article metadata**.
## Move it
- Drag it by its handle (⋮⋮) to the **Before the title** zone to show it above the title.
- Set its **Width** to **Half width** to share a row with the Export menu.
- Or add it to the **Sidebar** region instead of Main.
## Troubleshooting
**My help center still shows the old line.** Click **Publish**. Your change is in the draft until you do.
**I deleted it, but the author still shows.** Check the Article page's **Sidebar** region too: each region can hold its own Article metadata.
## Related articles
- [Customize the article page](https://self.helpcenter.io/content/article-page)
- [Add, move and remove components](https://self.helpcenter.io/content/components)
---
Source: https://self.helpcenter.io/content/preview-an-article
# Preview an article before you publish
_Category: Write articles_
Save the article, then click the eye icon (**Preview article**) in the top bar. The preview opens in a new tab and shows the article on your help center, with your design, the way readers will see it.

Preview a draft before anyone else can see it.
- **Save first.** The eye icon is grayed out until the article has been saved once. The preview shows the last saved version, so click **Save draft** before you preview your latest edits.
- **Published articles:** your edits are saved when you click **Update**, which also publishes them. Until then, the preview shows the live version. On help centers with staged changes, click **Preview** in the staged changes banner to see your edits before they go live.
- **Who can open it:** only teammates who can edit articles (Owners, Admins and Editors). Someone who isn't signed in is asked to sign in first, and anyone else gets a page-not-found page for an unpublished article.
You'll also find **Preview article** in the menu next to **Publish**.
## Related articles
- [Publish an article](https://self.helpcenter.io/content/publish-an-article)
- [Get to know the article editor](https://self.helpcenter.io/content/article-editor)
---
Source: https://self.helpcenter.io/content/similar-article-warnings
# Avoid duplicate articles
_Category: Write articles_
When the title you type closely matches an article you already have, HelpCenter.io tells you. Catching a duplicate early saves you from writing the same article twice and keeps your answers consistent.
**Who can do this:** Owners, Admins and Editors · **Plans:** All plans
## How the warning works
1. Type a title for your article.
2. Click into the body, or anywhere outside the title. HelpCenter.io looks for an existing article that's a close match.
3. If it finds one, a banner starting with **Heads up** appears above the article, with a link to the existing article.

The warning links straight to the article you already have.
The check runs each time you finish editing the title.
## What to do next
- **Update the existing article.** Click its title in the banner. If it already covers the topic, improve that article instead of starting a new one. Copy anything useful from your draft first.
- **Combine the two.** If each has something the other lacks, merge them into one article, then delete the extra one.
- **Make your title more specific.** If the topics are different, change the title so readers can tell the two apart, for example by naming the product or the situation.
- **Carry on.** If the match is fine, click **Ignore** to hide the banner.
## Why duplicates hurt
- **Search gets harder.** Readers see two results that look alike and have to guess which one to open.
- **Answers can disagree.** AI Answers writes its replies from your articles, so an outdated copy can end up in an answer.
- **Upkeep doubles.** Every change has to be made twice, and the copy nobody remembers goes stale.
Before you write a new article, search for the topic first: press ⌘K (Ctrl+K on Windows) in the editor, or use the search on the **Articles** page.
## Related articles
- [Find articles with search and filters](https://self.helpcenter.io/content/find-articles)
- [Keep your help center up to date](https://self.helpcenter.io/content/keep-your-help-center-up-to-date)
---
Source: https://self.helpcenter.io/content/contact-form
# Set up your contact page and form
_Category: Design and templates_
Give readers a contact page where they can message your team, with article suggestions that often answer the question before they send it. The contact page stays hidden until you tell HelpCenter.io where to deliver messages.
**Who can do this:** Owners and Admins (Editors through **Customize** on your help center) · **Plans:** All plans
## Switch on your contact page
1. In the left menu, click **Template editor**. Open **Pages** and pick **Contact** in the page menu.
2. In the **Main** region, click **Contact form** to edit it.
3. Under **Recipient email**, enter the address that should receive messages, such as your support inbox.

The amber notice disappears as soon as the form has a recipient.
1. Click **Publish**.
Until the form has a recipient, the preview shows it inside an amber notice: "Hidden on your live help center: nobody would receive these messages. Add a contact email to your contact form to switch it on." Readers see no contact page at all, so nobody sends a message into the void.
Once you publish with a recipient, these switch on together:
- Your contact page, at `/contacts` on your help center.
- Contact links in your header and footer.
- "Ask us" buttons (the **Contact CTA** component) that point to your contact page.
- The contact form in [the widget](https://self.helpcenter.io/content/widget-contact-form), which sends to the same address.
## Choose the fields
Under **Form fields**, each field has a **Label**, a **Field name**, a **Type**, a **Placeholder** and a **Required** checkbox. The types are **Single-line text**, **Email**, **Phone**, **Multi-line text**, **Dropdown** and **Checkbox**.
- Click **Add field** to add one. For a Dropdown, add its choices with **Add option**.
- Use the arrows to reorder fields and the trash icon to remove one.
- **Field name** is the internal name the value is sent under. You rarely need to change it.
Keep the form short: name, email, a subject and a message are enough for most teams. Keep an Email field, because your replies go to that address. Add a Dropdown only when the answer changes who handles the request.
## More options
| Option | What it does |
| --- | --- |
| **Heading** | The contact page's title. Left empty, it reads "Contact us". |
| **Submit label** | The button text. Left empty, it reads "Send message". |
| **Success message** | What readers see after their message is sent. |
| **Suggest articles while typing** | On by default. As readers describe their problem in the first Multi-line text field, the three best-matching articles appear under it. |
| **Width** | **Full width**, or **Half width** to share a row with another component. |
| **Confirmation email** (under **Advanced**) | Emails readers a confirmation that you received their message. Write your own **Confirmation email subject** and **Confirmation email text**. Both can use `{companyName}` for your brand name (the **Site name** under Brand), and the text can also use `{name}` for their first name. |
Suggestions work best when your article titles use the words your customers use. In a confirmation email, set honest expectations, such as when you usually reply.
## What your team receives
- Each message arrives by email with the subject "You've got a new support request", from no-reply@helpcenter.io.
- The email holds the message and every field the reader filled in. Reply to it and your answer goes straight to the reader's email address.
- Confirmation emails also come from no-reply@helpcenter.io, and replies to them reach your recipient address. With no subject of your own, it reads "[Site name Support] Thanks for your support request". A subject that contains a link, an email address or a domain name is replaced with that default.
- The form uses Google's invisible reCAPTCHA to block spam, so there's nothing to set up. It loads a script from Google on your contact page.
## Add "Ask us" buttons to other pages
The **Contact CTA** component is a "can't find it? ask us" banner with a button. Add it to the Home, Category, Search or Not found page, in the Main, Utility or Footer region. Set its **Heading**, **Subtext**, **Button label** and **Button url**: a page such as `/contacts`, a `mailto:` address, or a full link to your own helpdesk. Turn on **Custom content** to write the banner in your own HTML instead.
A banner whose button points to your contact page stays hidden while that page is off, and so does one with no destination. The preview shows why with an amber notice.
You can also place a **Contact form** in the Home page's Main region, so readers can write to you without leaving it. Keep the one on the Contact page too: your contact page and the links to it depend on it.
## Test it
1. Publish your changes. The form's button is inactive in the preview, so testing happens on your live help center.
2. Open `/contacts` on your help center in a private browser window.
3. Send a test message, then check that it arrives and that your reply reaches the address you entered.
## Troubleshooting
**The contact page shows "not found", or the "Ask us" button is missing.** The published form has no recipient. Add a **Recipient email** and publish. See [The contact form or "Ask us" button is missing](https://self.helpcenter.io/content/contact-form-missing).
**Messages don't arrive.** Check the recipient address for typos, and look in your spam folder for mail from no-reply@helpcenter.io. See [I'm not getting emails from HelpCenter.io](https://self.helpcenter.io/content/not-getting-emails).
**You changed the form but your help center didn't.** Click **Publish**. Edits stay in your draft until you do.
## Related articles
- [Let visitors message your team from the widget](https://self.helpcenter.io/content/widget-contact-form)
- [The contact form or "Ask us" button is missing](https://self.helpcenter.io/content/contact-form-missing)
- [Add links to your header and footer](https://self.helpcenter.io/content/navigation-links)
- [Publish your design](https://self.helpcenter.io/content/publish-your-design)
---
Source: https://self.helpcenter.io/content/how-do-i-get-a-free-migration-of-my-existing-help-center
# How do I get a free migration?
_Category: Why HelpCenter.io_
Request it on our free migration page, and our migration team moves your existing help center to HelpCenter.io for you. Free migration is included with the Growth and Catalyst plans.
1. Go to [helpcenter.io/free-migration](https://helpcenter.io/free-migration) and click **Start your migration**.
2. Under **Where does your help center live today?**, pick your platform, or **Something else** if it isn't listed. Click **Continue**.
3. Enter your current help center's address under **Its address**, then answer **Roughly how many articles?** and **In how many languages?**
4. Under **Anything we should plan around?**, mention a deadline, private articles or a new domain. This one is optional. Click **Continue**.
5. Enter **Your name** and **Work email**, then click **Start my migration**.
We review your knowledge base and tell you how long the move will take. Most migrations are done in under a week. If you'd like your new help center to look like your old one, ask for that in your request too. Prefer email? Write to migrate@helpcenter.io.
Not sure your plan includes free migration? Ask us at support@helpcenter.io.
## Related articles
- [Can you move my existing help center to HelpCenter.io?](https://self.helpcenter.io/content/can-you-migrate-my-existing-help-center-to-helpcenter.io)
- [Plans and pricing](https://self.helpcenter.io/content/plans-and-pricing)
---
Source: https://self.helpcenter.io/content/customize-your-help-center
# Make your help center look like your brand
_Category: Getting started_
Give your help center your logo, colors and fonts so customers know they're in the right place. You work on a draft, so readers see nothing until you publish.
**Who can do this:** Owners and Admins (Editors can open the template editor with **Customize** on your help center) · **Plans:** All plans
## Pick a theme
1. Sign in to HelpCenter.io and click **Template editor** in the left menu. Your help center opens in a preview, with the settings beside it.
2. Click **Theme gallery**.
3. Click **Compare & apply…** on a theme you like.
4. Untick anything you want to keep as it is.

A theme changes your design, never your articles or categories.
1. Click **Apply theme**. The preview switches to the new theme. It stays a draft until you publish.

Nothing changes for visitors until you publish.
**Brand** starts unticked, so your logo and name stay as they are.
## Add your logo and favicon
1. Click **Brand**.
2. Check the **Site name**. It's your brand name everywhere your help center is named, including the widget.
3. Under **Logo**, click **Upload** and choose your logo. PNG or SVG works best.
4. If your logo is dark, upload a light version under **Dark-mode logo**. Set the preview's appearance to **Dark** to check it.
5. Under **Favicon**, upload the small icon that browser tabs show. A 32×32 PNG or ICO file works in every browser.

The dark-mode logo shows whenever your help center appears in dark mode.
## Set your colors and fonts
1. Click **Theme**.
2. Under **Light mode**, set **Primary** to your main brand color. Change the other colors if you like, and the **Dark mode** colors too.
3. Under **Typography**, choose a **Body font** and a **Heading font**.
The preview updates as you go. Where a color would make text hard to read, HelpCenter.io adjusts it automatically.
## Publish your design
1. Click **Publish** at the top of the template editor.
2. Check the list of changes, add a **Version note** if you like, then click **Publish**.
Your live help center switches to the new design. Every publish is kept in **Version history**, so you can go back to an earlier design.
Your changes save to a draft automatically, and the top bar shows **All changes saved**. Readers keep seeing your last published design until you click **Publish**.
## Next steps
- Rearrange what's on each page: [Add, move and remove components](https://self.helpcenter.io/content/components).
- Check your design on phones and in dark mode: [Preview on phones, tablets and in dark mode](https://self.helpcenter.io/content/preview-your-design).
## Related articles
- [Get started with the template editor](https://self.helpcenter.io/content/template-editor)
- [Choose a theme](https://self.helpcenter.io/content/choose-a-theme)
- [Add your logo, favicon and brand name](https://self.helpcenter.io/content/logo-and-brand)
- [Change colors, fonts and spacing](https://self.helpcenter.io/content/colors-and-fonts)
- [Publish your design](https://self.helpcenter.io/content/publish-your-design)
---
Source: https://self.helpcenter.io/content/set-up-your-help-center
# Set up your help center: a first-hour checklist
_Category: Getting started_
Your help center is ready to fill. Work through this checklist in order to go from a blank help center to one your customers can use. Each step links to a full guide.
**Who can do this:** Owners and Admins · **Plans:** All plans (AI Answers needs Catalyst or the AI add-on)
## Where you start
A new help center comes with a **General** category and a draft article to get you going. Edit them or delete them. It's also **Private** until you make it public, so nobody outside your team sees it while you work.
## The checklist
1. **Make it look like your brand.** Pick a theme, then add your logo, colors and fonts in the template editor, so readers know they're in the right place. See [Make your help center look like your brand](https://self.helpcenter.io/content/customize-your-help-center).
2. **Plan your categories.** Group articles the way your customers think about your product, and name categories in their words. See [Create and organize categories](https://self.helpcenter.io/content/organize-categories) and [Plan your help center's structure](https://self.helpcenter.io/content/plan-your-help-center).
3. **Write and publish your first articles.** Start with the questions your customers ask most. Click **View help center** at the top of the Articles page to see them the way readers will. See [Write and publish your first article](https://self.helpcenter.io/content/write-your-first-article) and [The first 10 articles every help center needs](https://self.helpcenter.io/content/first-articles).
4. **Make it public.** Open your help center to everyone once your first articles are live. See [Make your help center public](https://self.helpcenter.io/content/make-your-help-center-public). Building an internal knowledge base instead? Keep it private and invite your team: see [Use a private help center as an internal knowledge base](https://self.helpcenter.io/content/internal-knowledge-base).
5. **Connect your own domain.** Serve your help center from an address like help.yourcompany.com, with free SSL, on every plan. See [Use your own domain](https://self.helpcenter.io/content/custom-domain).
6. **Add the widget to your website or app.** Customers find answers without leaving the page they're on. See [Add the widget to your website](https://self.helpcenter.io/content/install-the-widget).
7. **Invite your team.** Give writers, translators and admins their own logins and the right role. See [Invite your team](https://self.helpcenter.io/content/invite-your-team).
8. **Turn on AI Answers.** Readers ask a question and get an answer written from your published articles, with its sources. It's included in Catalyst, and available as an add-on on Bootstrap and Growth. See [Turn on AI Answers](https://self.helpcenter.io/content/ai-answers).
9. **Watch your statistics.** See what people search for, what they don't find and which articles need work. See [Read your help center statistics](https://self.helpcenter.io/content/statistics).
## After launch
A help center is never quite finished. Check your statistics regularly, write articles for searches that found nothing, and update articles whenever your product changes. See [Keep your help center up to date](https://self.helpcenter.io/content/keep-your-help-center-up-to-date).
## Related articles
- [Write and publish your first article](https://self.helpcenter.io/content/write-your-first-article)
- [Make your help center look like your brand](https://self.helpcenter.io/content/customize-your-help-center)
- [Make your help center public](https://self.helpcenter.io/content/make-your-help-center-public)
- [Use your own domain](https://self.helpcenter.io/content/custom-domain)
- [Add the widget to your website](https://self.helpcenter.io/content/install-the-widget)
- [Invite your team](https://self.helpcenter.io/content/invite-your-team)
- [Turn on AI Answers](https://self.helpcenter.io/content/ai-answers)
---
Source: https://self.helpcenter.io/content/can-i-cancel-my-subscription-at-any-time
# How do I cancel my subscription?
_Category: Plans and billing_
You can cancel at any time: email support@helpcenter.io from the account owner's email address and tell us which help center to cancel. There's no cancel button in the dashboard, so our team does it for you.
- You won't be charged again after your current billing period.
- When the subscription ends, your help center goes offline and shows a "This Help Center is Taking a Break" page. Your content is kept, so you can come back by activating a plan again.
- Want your account and data deleted as well? Say so in the same email.
- If you agreed to a 12-month term, it runs until the end of the term. Tell us before it ends to stop it from renewing.
You can also delete a help center yourself in **Settings** → **Danger zone** (account owner only). Deleting cancels that help center's subscription straight away and permanently removes its content, so export it first. If you have more than one help center, contact support before you delete the first one you created, so the others stay online. See [Export or delete a help center](https://self.helpcenter.io/content/delete-a-help-center).
## Related articles
- [Export or delete a help center](https://self.helpcenter.io/content/delete-a-help-center)
- [Change your email, transfer ownership or delete your account](https://self.helpcenter.io/content/account-changes)
- [What happens when a trial or subscription ends?](https://self.helpcenter.io/content/when-a-subscription-ends)
---
Source: https://self.helpcenter.io/content/can-you-migrate-my-existing-help-center-to-helpcenter.io
# Can you move my existing help center to HelpCenter.io?
_Category: Why HelpCenter.io_
Yes. Our migration team moves your existing help center to HelpCenter.io for you, free on the Growth and Catalyst plans. You keep your content, your structure and the search traffic you've already earned.
## What we move
- **Articles**, with their formatting.
- **Categories** and subcategories, so your structure stays the same.
- **Images**, copied to HelpCenter.io so they keep working after you close your old account.
- **Old links**, through redirects. Once your domain points to HelpCenter.io, old article addresses lead to the right new pages, so bookmarks and search results keep working.
- **Your look**, if you ask: we can style your new help center like your old one.
Have several languages, content that isn't public, or a deadline? Mention it in your request so we can plan around it.
## Where we can move you from
We move help centers from platforms such as Zendesk, Intercom, Help Scout, Freshdesk, Zoho Desk, Document360, HelpJuice, HelpDocs, KnowledgeOwl, ProProfs, Confluence, Readme, Slite, Support Hero, Bloomfire, WordPress and Wix. If yours isn't on the list, choose **Something else** in the request form and we'll take a look.
## How it works
1. **You request it** on the free migration page. See [How do I get a free migration?](https://self.helpcenter.io/content/how-do-i-get-a-free-migration-of-my-existing-help-center)
2. **We review** your current help center and tell you how long the move will take.
3. **We move your content**, usually in under a week.
4. **You review and go live:** check the articles, [connect your domain](https://self.helpcenter.io/content/custom-domain) and [make your help center public](https://self.helpcenter.io/content/make-your-help-center-public).
## Prefer to move content yourself?
Paste articles from Google Docs, Word or Markdown into the editor, and the formatting comes with them. See [Paste content from Google Docs and Word](https://self.helpcenter.io/content/paste-content). Developers can also import articles in bulk through the API; start with [Create an API key](https://self.helpcenter.io/content/create-an-api-key) and [Import articles in bulk](https://developers.helpcenter.io/content/import-articles-in-bulk) on the developer portal. To send old addresses to new pages, see [Redirect old links to the right page](https://self.helpcenter.io/content/custom-redirects).
## Related articles
- [How do I get a free migration?](https://self.helpcenter.io/content/how-do-i-get-a-free-migration-of-my-existing-help-center)
- [Redirect old links to the right page](https://self.helpcenter.io/content/custom-redirects)
- [Plans and pricing](https://self.helpcenter.io/content/plans-and-pricing)
---
Source: https://self.helpcenter.io/content/write-your-first-article
# Write and publish your first article
_Category: Getting started_
Here's the quickest way from a blank page to a live help article: write it, save it as a draft, then publish it.
**Who can do this:** Owners, Admins and Editors · **Plans:** All plans
## Write your article
1. Sign in to HelpCenter.io and click **Articles** in the left menu. You can also go straight to [helpcenter.io/app/articles](https://helpcenter.io/app/articles).
2. Click **New article**.
3. Type a title your customers would search for, such as "How do I reset my password?"
4. Click below the title and start writing. To add headings, lists, images and more, type `/` on an empty line.
5. Click the category under the title and pick where the article belongs. If you had a category selected on the Articles page, it's already filled in.
6. Click **Save draft**.

Until you click Save draft, a new article is kept only in your browser.
Your draft is now saved in your library, where your team can find it. Readers can't see it yet.
## Publish it
1. When the article is ready, click **Publish**.

Once published, the article shows up in its category and in search.
**Is your help center still private?** New help centers start private, so only your team can read your articles for now. When you're ready for customers, [make your help center public](https://self.helpcenter.io/content/make-your-help-center-public).
## Tips for a great first article
- **One task per article.** "Change your password" and "Delete your account" are two articles, not one.
- **Steps as a numbered list.** Give each step one action, and name buttons exactly as they appear on screen.
- **Show it.** Add a screenshot or GIF where a step is hard to picture: type `/` and choose **Image**.
- **Preview before you publish.** Click the eye icon at the top of the editor to see the article the way readers will.
- **Keep going.** Use the **New** menu at the top of the editor to start your next article without going back to the list.
For more on writing articles people finish reading, see [How to write help articles people actually read](https://self.helpcenter.io/content/how-to-write-help-articles).
## Troubleshooting
**"Title is required. Please add a title before saving the article."** Add a title, then click **Save draft** again.
**Readers can't see the article.** Check that it's published, that your help center is public, and that its category isn't private. See [Someone can't see an article or the help center](https://self.helpcenter.io/content/cant-see-an-article).
## Related articles
- [Get to know the article editor](https://self.helpcenter.io/content/article-editor)
- [Add headings, lists and other blocks](https://self.helpcenter.io/content/add-blocks)
- [Publish an article](https://self.helpcenter.io/content/publish-an-article)
- [How to write help articles people actually read](https://self.helpcenter.io/content/how-to-write-help-articles)
---
Source: https://self.helpcenter.io/content/translate-design-texts
# Translate texts in your design
_Category: Languages_
The texts you type into your design, like your hero heading, search placeholder, navigation links, footer and custom HTML blocks, can have a version for each language. Translate them in the template editor so readers see your whole help center in their language.
**Who can do this:** Owners and Admins (Editors through **Customize** on your help center) · **Plans:** Growth and Catalyst (your help center needs more than one language)
## Translate a text in the template editor
1. In the left menu, click **Template editor**.
2. Open **Pages**, or **Navigation** for the links in your header and footer.
3. In the **Editing texts in** bar at the top of the panel, choose the language.
4. Select the component and type the translation into its text fields.
5. To check the result, choose the language in the preview's language menu.
6. Click **Publish**, then **Publish** again to confirm.
Each text field that can be translated also shows a language code with a globe icon. Switching the language there switches every field at once, the same as the **Editing texts in** bar.
A field you leave empty in a language shows your default-language text, both in the editor and on your help center. Your translations are part of your design draft, so readers see them only after you publish.
Translate in the settings panel, not in the preview. Text you edit directly in the preview is saved as your default-language text, even while the preview shows another language.
## What you can translate here
- **Headings and texts in components**: the hero heading and subheading, the search bar's placeholder and helper text, list headings, the FAQs heading and intro, and the prompt of **Was this helpful?**
- **Contact texts**: the **Contact form** heading, button label, success message and confirmation email, and the texts of the **Contact CTA**.
- **Rich text** and **Custom HTML** blocks: each language gets its own version of the whole block. Write it again in each language, for example for an announcement or a banner.
- **Navigation link labels** on the **Navigation** tab, and the texts in your footer columns.
Your site name and tagline on the **Brand** tab have one version for all languages.
## What is translated where
| What | Where you translate it |
| --- | --- |
| Articles | The language bar in the article editor. See [Translate an article](https://self.helpcenter.io/content/translate-an-article). |
| Category names and descriptions | **Articles** → select the category → **Edit category**. |
| Texts you typed into your design | The template editor, as described above. |
| Built-in buttons, labels and messages, like "On this page", "Skip to content", the page-not-found texts and "Powered by HelpCenter.io" | **Localization** → **Interface translations**. See [Translate buttons and labels](https://self.helpcenter.io/content/interface-translations). |
| The widget's buttons and messages | **Localization** → **Interface translations**, in the **Widget** group. |
Some component fields, like the search placeholder, use a built-in phrase when you leave them empty. For those, you can translate the built-in phrase once under **Interface translations** instead of filling in the field for every language.
## Related articles
- [Translate buttons and labels](https://self.helpcenter.io/content/interface-translations)
- [Edit text right in the preview](https://self.helpcenter.io/content/edit-in-preview)
- [Publish your design](https://self.helpcenter.io/content/publish-your-design)
- [How readers see other languages](https://self.helpcenter.io/content/languages-for-readers)
---
Source: https://self.helpcenter.io/content/what-payment-methods-do-you-support
# What payment methods do you accept?
_Category: Plans and billing_
We accept credit and debit cards, including Visa and Mastercard, and PayPal. Payments are processed by Braintree, a PayPal service, and charged in US dollars.
- **Cards:** your bank may ask you to confirm the payment (3-D Secure).
- **PayPal:** connect your PayPal account once, and renewals are charged to it.
You add a payment method when you [activate your subscription](https://self.helpcenter.io/content/activate-your-subscription). To change it later, open **Billing & Invoices**, pick or add a method under **Payment Method** and click **Save payment method**. Your active subscriptions move to the new method automatically.
## Related articles
- [Are my payment details secure?](https://self.helpcenter.io/content/are-my-payment-details-securely-stored)
- [Download invoices and update billing details](https://self.helpcenter.io/content/invoices)
---
Source: https://self.helpcenter.io/content/reorder-articles-and-categories
# Change the order of articles and categories
_Category: Organize and publish_
Put your most important categories first, and arrange the articles in each category in the order readers should read them, such as setup steps from first to last.
**Who can do this:** Owners, Admins and Editors · **Plans:** All plans
## Reorder categories
1. Click **Articles** in the left menu.
2. In the **Categories** panel, drag a category up or down and drop it at the top or bottom edge of another category.
Drop it at the edge, not on top: dropping a category onto another one makes it a subcategory. The new order is saved right away, and your help center lists your categories in this order, for example on the home page.
## Arrange the articles in a category
1. In the **Categories** panel, click the category.
2. Set **Sort by** to **Custom order**.
3. Drag the articles into the order you want.

Each drop saves the new order.
You'll see "Order saved" after each drop. Custom order works inside one category at a time, and you move one article at a time. It isn't available for **Any category** or **Uncategorized**.
## Show your order on the help center
Whether category pages follow your order depends on a setting of the Category page in the template editor. Compass, the theme new help centers start with, uses your order. The other themes list the most recently updated articles first. To check or change it:
1. Open **Template editor** from the left menu, click **Pages** and choose the **Category** page.
2. Find **Category articles** and set **Order articles by** to **Custom (drag to reorder)**, or pick another order.
3. If you pick **Alphabetically**, set the **Direction** to **A → Z**. It starts at Z → A.

One setting orders the articles on every category page.
1. Click **Publish** so readers see the new order. See [Publish your design](https://self.helpcenter.io/content/publish-your-design).
| Order articles by | Direction |
| --- | --- |
| **Last updated** | **Newest first** or **Oldest first** |
| **Create date** | **Newest first** or **Oldest first** |
| **Alphabetically** | **A → Z** or **Z → A** |
| **Custom (drag to reorder)** | Your order from the Articles page |
The same order applies wherever your help center lists a category's articles, such as a content tree. Article lists you add to other pages have their own sort setting. See [Customize category and article lists](https://self.helpcenter.io/content/category-and-article-lists).
Owners and Admins open **Template editor** from the left menu. Editors can open it with **Customize** in the team toolbar that shows on your help center while they're signed in. Opened from a category page, it goes straight to the Category page's settings.
## Related articles
- [Create and organize categories](https://self.helpcenter.io/content/organize-categories)
- [Customize category and article lists](https://self.helpcenter.io/content/category-and-article-lists)
- [Publish your design](https://self.helpcenter.io/content/publish-your-design)
---
Source: https://self.helpcenter.io/content/help-center-vs-knowledge-base
# Help center vs knowledge base: what's the difference?
_Category: Help center best practices_
A knowledge base is a collection of articles. A help center is the website your customers visit when they need help, built around that collection, with search, navigation and a way to reach your team. People often use the two words interchangeably, and in HelpCenter.io they mean the same thing.
Here's the difference in more detail, and how internal and external knowledge bases compare.
## What a knowledge base is
A knowledge base is an organized library of information: how-to articles, troubleshooting guides, FAQs, policies and reference material, grouped into categories so people can browse and search it.
The term describes the content and how it's organized, not who reads it. A knowledge base can serve your customers, your own team, or both.
## What a help center is
A help center is where people go when they need help. At its heart is a knowledge base, and around it are the things that turn content into support:
- **Search,** often with AI answers written from your articles.
- **Navigation:** a home page, categories and related articles.
- **A way to contact your team,** such as a contact form.
- **Your branding,** usually on your own domain.
- **Extras** such as a help widget inside your product, announcements or a community forum.
In short, the knowledge base is what you know, and the help center is where customers go to find it.
## Side by side
| Compare | Knowledge base | Help center |
| --- | --- | --- |
| What it is | An organized collection of articles | The website people visit for help |
| Made of | Articles, FAQs and categories | A knowledge base, plus search, contact options and more |
| The question it answers | "What do we know?" | "Where do I go for help?" |
| Readers | Customers, your team, or both | Mostly customers |
| Access | Public or private | Usually public, sometimes behind a login |
| Example | All your articles about billing | help.yourcompany.com, with a search bar, categories and a contact form |
## Internal vs external knowledge bases
The biggest difference between knowledge bases is who they're written for.
| Compare | External | Internal |
| --- | --- | --- |
| Readers | Customers, prospects and partners | Your employees |
| Typical content | How-tos, troubleshooting, FAQs, policies | Processes, support playbooks, HR policies, onboarding guides |
| Access | Public, or behind your customers' login | Private, with sign-in |
| Writing style | Plain words, no internal jargon | Can use internal terms and project names |
| Found by search engines | Yes, when public | No |
Many companies run both, and it's usually best to keep them apart. Customers shouldn't stumble on internal procedures, and your team shouldn't have to dig through customer articles to find a process. When only a few internal articles sit next to customer content, a private section inside your help center can be enough. See [Use a private help center as an internal knowledge base](https://self.helpcenter.io/content/internal-knowledge-base).
## How they work with your support team
A knowledge base, a help center and your support inbox each do one part of the job. Here's how a question moves through them:
1. A customer gets stuck and opens your help center, or the help widget inside your product.
2. They search, and the help center finds the right article in your knowledge base.
3. If the article doesn't solve it, they contact your team from the help center.
4. Your team answers, and links to an article where one exists.
5. When the same new question keeps arriving, someone writes an article for it, and the knowledge base grows.
The last step is what keeps the whole thing useful. Without it, the knowledge base stops matching what customers ask.
## Other terms you'll hear
- **FAQ page:** one page of short questions and answers. Handy for a handful of questions, and often one part of a help center.
- **Documentation, or docs:** detailed reference material, often for developers, such as API guides.
- **Self-service portal:** another name for a help center, sometimes with account features such as ticket status.
- **Wiki:** a knowledge base that anyone on the team can edit. Usually internal and loosely structured.
- **Help desk:** usually the software your support team uses to answer tickets, not the articles customers read.
## Which one do you need?
Three questions settle it:
1. **Who reads it?** If customers do, you need a help center, and its knowledge base is where you'll spend most of your time. If only your team does, you need an internal knowledge base.
2. **Does it need a sign-in?** Public content helps new customers and search engines find you. Content for paying customers or employees needs access control.
3. **Should search engines and AI assistants find it?** If yes, make it public and write it for people who don't know your product yet.
## How HelpCenter.io helps
In HelpCenter.io, "help center" and "knowledge base" mean the same thing. Each help center holds your knowledge base (articles, FAQs and categories) and publishes it as a website on your subdomain or your own domain, and inside the widget on your website or app. Make it public for customers, or private for your team, and keep team-only sections in private categories. See [Control who can see your help center](https://self.helpcenter.io/content/who-can-see-your-help-center) and [Make a category private](https://self.helpcenter.io/content/private-categories).
## Related articles
- [What is a help center?](https://self.helpcenter.io/content/what-is-a-help-center)
- [Use a private help center as an internal knowledge base](https://self.helpcenter.io/content/internal-knowledge-base)
- [Control who can see your help center](https://self.helpcenter.io/content/who-can-see-your-help-center)
---
Source: https://self.helpcenter.io/content/are-my-payment-details-securely-stored
# Are my payment details secure?
_Category: Plans and billing_
Yes. Your card details go straight from the payment form to our payment processor, Braintree, a PayPal service. HelpCenter.io never stores your card number.
- We keep only the card type and its last four digits, or your PayPal email address, so you can see which method you're billed with.
- Braintree follows PCI DSS, the security standard for handling card data.
- Card payments can be confirmed with your bank through 3-D Secure.
- Only the account owner can see or change billing details.
For how we protect the rest of your account and content, see [Security and privacy at HelpCenter.io](https://self.helpcenter.io/content/security-and-privacy).
## Related articles
- [What payment methods do you accept?](https://self.helpcenter.io/content/what-payment-methods-do-you-support)
- [Security and privacy at HelpCenter.io](https://self.helpcenter.io/content/security-and-privacy)
---
Source: https://self.helpcenter.io/content/will-i-get-immediately-charged-when-i-activate-my-subscription-plan
# Will I be charged as soon as I activate?
_Category: Plans and billing_
Not if you're still in your free trial. When you activate during the trial, you keep the days you have left, and your first payment is taken when the trial ends.
If your trial has already ended, you're charged as soon as you activate, and your help center comes back online right away.
- **Yearly plans** are paid for the whole year up front.
- **Monthly plans** are charged once a month.
- Both renew automatically for the same period, and you get an invoice for every payment in **Billing & Invoices**.
Ready to go? See [Choose a plan and start your subscription](https://self.helpcenter.io/content/activate-your-subscription).
## Related articles
- [Choose a plan and start your subscription](https://self.helpcenter.io/content/activate-your-subscription)
- [How the free trial works](https://self.helpcenter.io/content/free-trial)
---
Source: https://self.helpcenter.io/content/activate-your-subscription
# Choose a plan and start your subscription
_Category: Plans and billing_
Choose a plan and add a payment method to keep your help center online after the free trial. You can do it at any time during the trial without losing the days you have left.
**Who can do this:** The account owner · **Plans:** All plans
## Pick your plan
1. At the bottom of the left menu, click your avatar, then **Billing & Invoices**.
2. You see the plan you're trying and the days left in your trial. To pick a different plan or billing period, click **Change**.

Change shows every plan, so you can compare them before you choose.
1. Choose **Yearly** or **Monthly**, then click **Choose** on the plan you want.
## Add your details and activate
1. Under **Billing Details**, fill in **Company Name**, your country, **City**, **Address** and **Postal Code**. These are required. If you're not a company, use your own name. The country list starts on Australia, so check that it shows yours.
2. If your company is in the EU, enter your VAT number in **VAT Number/Company Id**. Without a valid one, 20% VAT is added.
3. Enter a **Billing Email**. Invoices are emailed to this address.
4. Under **Payment Method**, add a card or choose PayPal.
5. Have a discount code? Click **Apply a Discount**, enter the code and click **Apply**.
6. Check the **Total**, then click **Activate**. Keep the page open until the confirmation appears.

Your subscription is active as soon as the confirmation appears.
## What happens next
- **Still in your trial?** You keep the remaining trial days. Your first payment is taken when the trial ends.
- **Trial already over?** You're charged right away, and your help center is back online immediately.
- **Renewals:** monthly plans are charged every month and yearly plans once a year, up front. Your subscription renews automatically.
- **Invoices** appear under **Invoices** on the same page and are emailed to your Billing Email. See [Download invoices and update billing details](https://self.helpcenter.io/content/invoices).
Payments are processed by Braintree, a PayPal service. HelpCenter.io doesn't store your card number.
## Troubleshooting
**You see "Verify Your Email" instead of a payment form.** You need a verified email address before you can add a payment method. Click the link in the verification email we sent you, or click **resend it** on the page.
**"Only the account owner can manage the help center subscription and billing details."** Billing belongs to the person who created the account. Ask them to activate the plan.
**"Please correct the data above and try again."** A required billing field is empty. Fill in the fields marked in red.
**"3D Secure verification failed."** Your bank couldn't confirm the payment. Try again, or use another card or PayPal.
**"Your card was declined."** Check the card with your bank, or use another payment method.
**"Discount not available."** The code is wrong, has expired, has already been used, or doesn't apply to the plan and billing period you picked.
## Related articles
- [Plans and pricing](https://self.helpcenter.io/content/plans-and-pricing)
- [Will I be charged as soon as I activate?](https://self.helpcenter.io/content/will-i-get-immediately-charged-when-i-activate-my-subscription-plan)
- [What payment methods do you accept?](https://self.helpcenter.io/content/what-payment-methods-do-you-support)
- [Do you charge VAT?](https://self.helpcenter.io/content/vat)
---
Source: https://self.helpcenter.io/content/jwt-sso
# Sign readers in with your own login (JWT SSO)
_Category: Domain, access and SEO_
Let readers into your private help center with the account they already have in your product. Your app signs them in the way it always does and hands HelpCenter.io a signed token, so readers never see a second login or need a second password.
**Who can do this:** Owners and Admins · **Plans:** Catalyst
## Before you start
- **Your help center is on the Catalyst plan.** On other plans, the **Single sign-on** card says SSO isn't available and offers **View plans**. A setup you've already saved keeps working, and stays manageable, if your help center later moves to another plan. New setups need Catalyst.
- **Your help center is set to Private.** SSO is how readers get into a private help center. A public help center needs no sign-in, and a password-protected one shows its password page instead.
- **Your developers can add a sign-in endpoint to your app.** It signs JSON Web Tokens (JWT) with HS256, which most languages have a library for. See What your developers build, below.
## Turn on single sign-on
1. In the left menu, click the gear icon, then **Settings**.
2. In the **Single sign-on** card, switch on **Enable Single Sign-On**. The provider is **JWT (HS256)**.
3. In **Login URL**, enter the address of your sign-in endpoint, for example `https://app.yourcompany.com/auth/helpcenter`.
4. Next to **Shared secret**, click **Generate**. Copy the secret into your server's configuration. Keep it on the server: it must never reach a browser.
5. If you like, fill in **Issuer (iss claim)**, **Audience (aud claim)** and **Token TTL (seconds)**, and choose how long a sign-in lasts under **Reader sign-in lasts**. See the table below.
6. Click **Save JWT settings**.

Generate creates a 64-character secret for you.
You'll see "JWT settings successfully updated." If your help center isn't private yet, go to **General** → **Access & visibility**, choose **Private** and click **Save changes**.
## The settings
| Setting | What it does |
| --- | --- |
| **Login URL** (required) | Where HelpCenter.io sends readers who aren't signed in. Your endpoint signs them in and sends them back with a token. HelpCenter.io adds its own `?subdomain=` and `&key=` to this address, so use one without a `?` or `#` of its own. |
| **Shared secret** (required) | Signs every token. At least 64 characters. **Generate** creates one, or you can paste your own. Your server signs with it exactly as shown. |
| **Issuer (iss claim)** | Optional. When set, tokens whose `iss` claim doesn't match are rejected. |
| **Audience (aud claim)** | Optional. When set, tokens whose `aud` claim doesn't match are rejected. |
| **Token TTL (seconds)** | The oldest token the widget accepts, counted from `iat`, from 30 to 86,400 seconds. 300 is recommended. Sign-in through your Login URL or an iframe relies on the token's `exp` instead. |
| **Reader sign-in lasts** | How long a reader stays signed in to your help center: **1 hour**, **8 hours**, **24 hours** (the default), **7 days** or **30 days**. The time counts from the sign-in and visits don't extend it. After that, the reader goes through your Login URL again, so someone you've removed from your own login loses access to the help center too. |
| **Logout URL** | HelpCenter.io doesn't use this field, so you can leave it empty. |
**Regenerating the secret breaks sign-in until your server has the new one.** The new secret takes effect when you click **Save JWT settings**, and tokens signed with the old secret stop working at that moment. Changing the secret also signs out every reader, who then sign in again through your Login URL. See [Can I rotate the SSO shared secret without downtime?](https://self.helpcenter.io/content/can-i-rotate-the-shared-secret-without-downtime)
## What your developers build
When a reader who isn't signed in opens your help center, HelpCenter.io sends them to your Login URL with a one-time `key`. Your endpoint signs them in with your usual login, creates a token signed with the shared secret, with `jti` set to that key, and sends them to `https://
` tag of your website or web app. ## How it works Visitors see the widget first and can search your help center or read an article to solve the problem themselves. When they ask to contact you from the widget, for example by clicking **I can't find what I'm looking for**, the widget calls your `onContactsRequest` function instead of showing its own contact form, and Chatra opens. Pay attention to what people ask in the chat, and add an article whenever a new question comes up. Over time, fewer visitors need to reach out with the same question. ## Good to know - The widget stays open when the chat opens. To close it at the same time, add `window.hcWidget.hide();` inside your `onContactsRequest` function. See [Widget JavaScript API](https://developers.helpcenter.io/content/widget-javascript-api) on the developer portal. - Not comfortable editing your website's code? Ask a developer, or [contact us](https://self.helpcenter.io/content/contact-support): we may be able to help. ## Related articles - [Add the widget to your website](https://self.helpcenter.io/content/install-the-widget) - [Integrations overview](https://self.helpcenter.io/content/integrations) - [Handle contact requests yourself](https://developers.helpcenter.io/content/widget-custom-contact) on the developer portal - [Widget JavaScript API](https://developers.helpcenter.io/content/widget-javascript-api) on the developer portal --- Source: https://self.helpcenter.io/content/team-notes # Leave notes for your team _Category: Write articles_ Keep information for your team right inside an article: a script for your support agents, a reminder to update a screenshot, or a question for the writer. Readers never see any of it. **Who can do this:** Owners, Admins and Editors, and Translators in the languages they translate · **Plans:** All plans There are two ways to do it: - **Internal notes** are blocks of text inside the article, for information your team should always have at hand. - **Comments** are attached to a few selected words, for questions and feedback you resolve and move on from. ## Add an internal note 1. On an empty line, type `/internal note` and press Enter. 2. Type your note. It's marked **Internal note** and **Team only, never published**.  An internal note stays in the editor and never reaches readers. A note can hold lists, links and other blocks, like the rest of the article. To remove a note, delete its text, then press Backspace once more in the empty note. Picking **Internal note** in the menu again while your cursor is inside a note doesn't delete it. It turns the note back into normal text, which readers will see once you publish. ## Comment on a selection 1. Select the words you want to comment on. 2. In the toolbar, click **Comment on this selection (team only)** (the speech bubble). 3. Write your comment and click **Comment**, or press ⌘Enter (Ctrl+Enter on Windows). The words stay highlighted for your team. Click the highlight to read the thread, add a **Reply**, or **Resolve** it, which removes the highlight. The comment count in the top bar opens the **Comments** panel, where the **Team** tab lists every open thread in the article. Comments work once the article has been saved, and each comment can be up to 5,000 characters. Adding or resolving a comment saves the article. On a published article, that also publishes any edits you haven't published yet, unless your help center uses staged changes. If you're in the middle of an edit, finish it first. ## Where notes and comments stay hidden Internal notes and comments are removed from everything readers can reach: the published article, help center search, AI Answers and the widget. Article content you fetch through the API leaves them out too. Three things to know: - **Your team's view:** when you're signed in as a team member, the published article and its preview still show internal notes. Readers never see them. - **Helpdesk sidebars:** in apps like Front and Zendesk, your agents can read internal notes next to the article. Notes are left out when an agent inserts the article into a reply. - **PDF exports from the dashboard** are made for your team and include internal notes. Check them before you share one outside your team. ## Related articles - [Flag articles for review](https://self.helpcenter.io/content/flag-for-review) - [Get to know the article editor](https://self.helpcenter.io/content/article-editor) --- Source: https://self.helpcenter.io/content/integrate-the-helpcenter-io-widget-with-the-intercom-messenger # Integrate the widget with the Intercom Messenger _Category: Integrations and API_ Show the widget first and open the Intercom Messenger only when a visitor can't find what they need. Visitors get instant answers from your help center, and your team only hears the questions your articles don't cover yet. **Who can do this:** Owners and Admins, with access to your website's code · **Plans:** All plans Want your articles inside Intercom instead, with Messenger search and Fin trained on them? That's the Intercom integration. See [Connect Intercom](https://self.helpcenter.io/content/intercom). ## Step 1: Install the Intercom Messenger If the Intercom Messenger already runs on your website, skip to the next step. Otherwise, install it by following Intercom's instructions. ## Step 2: Hide the Intercom launcher Visitors should only see the Messenger once they've asked for help, so hide Intercom's launcher and let the widget open the Messenger when it's needed. If you use Intercom's JavaScript snippet, add `hide_default_launcher: true` to its `intercomSettings` object. If you haven't changed anything else, the first part of the snippet looks like this: ``` ``` If you added Intercom some other way, for example through an integration, hide the launcher in your Intercom settings. Intercom explains how in [Turn off, show or hide the Intercom Messenger](https://www.intercom.com/help/en/articles/189-turn-off-show-or-hide-the-intercom-messenger). ## Step 3: Add the widget and connect it to Intercom 1. In your HelpCenter.io dashboard, click the gear icon in the left menu, then **Embeddables**. 2. On the **Widget** tab, click **Copy** on the **Installation** card. The code you copied looks like this, with your own widget ID in place of `ab12c3`: ``` ``` Add a comma after `app_id: 'ab12c3'`, and on the next line add an `onContactsRequest` function that opens the Messenger: ``` onContactsRequest: function(){if(window.Intercom) Intercom('show'); else console.error('Unable to find Intercom widget.')} ``` The finished code looks like this: ``` ``` Paste it right before the closing `` tag of your website or web app. ## How it works Visitors see the widget first and can search your help center or read an article to solve the problem themselves. When they ask to contact you from the widget, for example by clicking **I can't find what I'm looking for**, the widget calls your `onContactsRequest` function instead of showing its own contact form, and the Intercom Messenger opens. Pay attention to what people ask in the Messenger, and add an article whenever a new question comes up. Over time, fewer visitors need to reach out with the same question. ## Good to know - The widget stays open when the Messenger opens. To close it at the same time, add `window.hcWidget.hide();` inside your `onContactsRequest` function. See [Widget JavaScript API](https://developers.helpcenter.io/content/widget-javascript-api) on the developer portal. - Not comfortable editing your website's code? Ask a developer, or [contact us](https://self.helpcenter.io/content/contact-support): we may be able to help. ## Related articles - [Connect Intercom](https://self.helpcenter.io/content/intercom) - [Add the widget to your website](https://self.helpcenter.io/content/install-the-widget) - [Handle contact requests yourself](https://developers.helpcenter.io/content/widget-custom-contact) on the developer portal - [Widget JavaScript API](https://developers.helpcenter.io/content/widget-javascript-api) on the developer portal --- Source: https://self.helpcenter.io/content/write-faqs # Write FAQs and add them to articles _Category: Write articles_ FAQs are short question-and-answer articles. They answer the quick questions your customers ask most, and you can write them right next to the article they belong to. **Who can do this:** Owners, Admins and Editors (only Owners and Admins can build new FAQ sections) · **Plans:** All plans (AI drafting: Catalyst plan, or the AI add-on on Bootstrap and Growth) ## Write an FAQ from an article 1. Open the article and save it, if it's new. 2. In the **Related FAQs** card on the right, click **New**. 3. Write the question the way a customer would ask it, then a short answer of up to 600 characters. 4. Click **Create FAQ**.  The new FAQ is attached to the article you're writing. The FAQ is published straight away, in the same category as the article. If the article is in several categories, or in none, the FAQ goes into your help center's oldest category instead; open it in the editor to move it. To attach an FAQ you already have instead, type in **Search your FAQs to attach one…** and click it. Each FAQ in the card has a **…** menu with **Publish** or **Unpublish**, **Edit**, **Open in editor** and **Detach**. Detaching only removes the FAQ from this article; the FAQ itself stays. When you edit an FAQ, the change shows everywhere it's attached. A circular-arrows icon next to an FAQ means the article changed after the FAQ was last updated. Check the answer, then click the icon to mark the FAQ as up to date. ## Let AI draft FAQs With AI writing help, click **Derive FAQs from this article** at the bottom of the card. AI reads the article and drafts FAQs, each marked with a wand icon. They're saved as drafts, so readers don't see them yet. Check each one, edit it if needed, and publish it from its menu. When several drafts are waiting, a button at the top of the card publishes them all at once. ## Turn an article into an FAQ Any article can be an FAQ. In the **Details** card, set **Type** to **FAQ**. The title becomes the question and the content becomes the answer. FAQs are capped at 600 characters, so shorten a longer article first. When you open an FAQ in the editor, its side panel shows **Attached to articles** instead of Related FAQs: every article it's attached to, each with **Open in editor** and **Detach**. ## Where readers find FAQs - **Category pages:** the FAQs in a category appear as expandable questions at the top of the category page. You can change this in the template editor (**Pages** → **Category** → **Separate FAQs**). See [Customize category and article lists](https://self.helpcenter.io/content/category-and-article-lists). - **The FAQs component:** add it to your home page, or to a category or search page, in the template editor. It lists every FAQ, or the FAQs of one section. See [Add, move and remove components](https://self.helpcenter.io/content/components). - **FAQ sections:** sets of FAQs that you place inside an article or embed on your own website. See [Embed FAQ sections on your website](https://self.helpcenter.io/content/faq-sections). - **Search:** FAQs show up in your help center's search results like any article. The **Related FAQs** card keeps track of which FAQs belong with an article, but your published article page doesn't list them today. To show FAQs inside an article, add an FAQ section to it. ## Add an FAQ section to an article 1. On an empty line, type `/faq` and pick **FAQ section**. 2. Under **Saved sections**, pick a section. Owners and Admins can also switch to **Build custom**, give the section a title and search for the FAQs and articles to put in it. 3. Click **Insert section**. ## Related articles - [Embed FAQ sections on your website](https://self.helpcenter.io/content/faq-sections) - [Customize category and article lists](https://self.helpcenter.io/content/category-and-article-lists) - [Write faster with AI writing help](https://self.helpcenter.io/content/ai-writing-help) --- Source: https://self.helpcenter.io/content/delete-and-restore-articles # Delete and restore articles _Category: Organize and publish_ Deleting an article moves it to Trash, so a slip is never final. Restore it with its history whenever you need it, or delete it for good. **Who can do this:** Owners, Admins and Editors (deleting permanently and redirects: Owners and Admins) · **Plans:** All plans ## Delete and restore an article 1. On **Articles**, open the **…** menu on the article and choose **Delete**. 2. Click **Delete** to confirm. The article moves to Trash. 3. To bring it back, click **Trash** in the left menu. 4. Open the **…** menu on the article and choose **Restore**.  Restored articles come back as they were when you deleted them. A restored article comes back with its content, category, settings and version history. If it was published when you deleted it, it's live again as soon as you restore it. A draft comes back as a draft. You can also delete an article from the editor (the arrow next to **Publish** or **Update**, then **Move to trash**), or tick several articles and click **Delete** in the bar. ## What happens to a deleted article - Readers get a not-found page at its address. - It drops out of your help center's search, the widget and AI Answers. - It stays in Trash, with its history, until an Owner or Admin deletes it permanently. ## Send visitors to another page 1. In **Trash**, open the **…** menu on the article and choose **Create redirect**. 2. Under **Redirect to**, enter the full address of the page that replaces it, starting with https://. 3. Click **Create**. Anyone who opens the deleted article's address now lands on that page. For other old addresses, see [Redirect old links to the right page](https://self.helpcenter.io/content/custom-redirects). ## Delete permanently - **One article:** in **Trash**, open the **…** menu, choose **Delete permanently** and confirm. - **Everything in Trash:** click **Empty trash**, type your password and click **Empty trash**. Permanently deleted articles can't be recovered, and neither can their version history. ## Troubleshooting **Delete permanently or Create redirect doesn't work for me.** These need an Owner or Admin. **Empty trash** only shows for them too. **A restored article went live straight away.** It was published when it was deleted. If it shouldn't be live, unpublish it. See [Unpublish an article](https://self.helpcenter.io/content/unpublish-an-article). ## Related articles - [Unpublish an article](https://self.helpcenter.io/content/unpublish-an-article) - [See and restore earlier versions of an article](https://self.helpcenter.io/content/article-versions) - [Redirect old links to the right page](https://self.helpcenter.io/content/custom-redirects) --- Source: https://self.helpcenter.io/content/article-editor # Get to know the article editor _Category: Write articles_ The article editor is where you write, format and publish your help articles. Here's what each part of the screen does, so you always know where to find a tool. **Who can do this:** Owners, Admins and Editors (Translators work in your other languages) · **Plans:** All plans ## Open the editor - **A new article:** go to **Articles** and click **New article**. - **An existing article:** open the **…** menu on its row and choose **Edit article**. Or click the row, then **Open in editor**. ## Write in the canvas The canvas in the middle of the screen is your article. 1. Type a title at the top. Use the words your customers would search for. 2. Pick a category from the pill under the title. 3. Click below the title and start writing. On an empty line, type `/` to insert a block, such as a heading, a list, an image or a table. 4. Select any text to format it or turn it into a link.  Type / on an empty line to add any block. Once the article is saved, the **Version History** pill next to the category shows earlier versions. The line under the canvas counts your words and estimates the reading time. ## The top bar - **Articles** (with the back arrow) returns to your article list. - **New** starts another article in a new tab: **Blank article**, **From a template** or **Duplicate this article**. It appears once the article is saved. - **Search articles…** finds and opens another article. Press ⌘K (Ctrl+K on Windows) to open it from anywhere in the editor. - The speech bubble with a number opens **Comments**: your team's comments and the ones readers left. - The eye icon (**Preview article**) opens the saved article in a new tab, the way readers will see it. - **Watch** notifies you when someone changes the article. - The status pill shows if your work is saved and live (see the table below). - **Save draft** saves your work without publishing it. On a published article, it only appears if your help center uses staged changes. - **Publish** makes a draft live. On a published article the button reads **Update**, or **Publish changes** when you have staged changes. The arrow next to it (**More publish actions**) holds **Insert template**, **Save as template**, the review options, **Unpublish (back to draft)** and **Move to trash**. ## What the status pill means | Status | What it means | | --- | --- | | **Not saved** | The article only exists in this browser. Click **Save draft** to keep it. | | **Unsaved changes** | You changed a saved draft. Click **Save draft** to keep the changes. | | **Draft saved** | Saved to your account, and not published. | | **Published** | Live on your help center. | | **Unpublished edits** | The article is live, but your latest edits aren't. Click **Update** to publish them. | | **Staged changes** | Only on help centers that use staged changes: your edits are saved, and readers still see the live version until you publish them. | A brand-new article stays in this browser until you save it, and a banner reminds you. If you switch devices or clear your browser first, the draft is lost, so save early. ## The right-hand panel | Card | What you do there | | --- | --- | | **Access** | Choose who can read the article: **Public**, **Anyone with the link** or **Private**. | | **Details** | Change the author, and set the type: **Article** or **FAQ**. | | **URL and search** | Copy the article's link, change its slug, and set the title and description search engines show. | | **Attachments** | See the files attached to the article and add more. | | **Related FAQs** | Write or attach short questions and answers that belong with the article. | | **AI writing help** | Draft the search title and description, suggest a slug, write alt text and check the structure. Catalyst plan, or the AI add-on on Bootstrap and Growth. | Drag a card by its grip to rearrange the panel. The editor remembers your layout. ## Work in your other languages If your help center has more than one language, a **Language** bar sits above the canvas. Click a language to write that version. The **Released** switch decides when readers can see a translation. See [Translate an article](https://self.helpcenter.io/content/translate-an-article). ## Related articles - [Add headings, lists and other blocks](https://self.helpcenter.io/content/add-blocks) - [Format text](https://self.helpcenter.io/content/format-text) - [Publish an article](https://self.helpcenter.io/content/publish-an-article) - [Keyboard shortcuts in the article editor](https://self.helpcenter.io/content/editor-shortcuts) - [Preview an article before you publish](https://self.helpcenter.io/content/preview-an-article) --- Source: https://self.helpcenter.io/content/publish-an-article # Publish an article _Category: Organize and publish_ Publish an article to put it on your help center, where readers can browse to it, search for it and get answers from it. Until you publish, it's a draft that only your team can see. **Who can do this:** Owners, Admins and Editors · **Plans:** All plans ## Publish from the editor 1. Open the draft from **Articles**, or write a new one. Once a draft is saved, the status pill in the top bar reads **Draft saved**: it's in your account, and readers can't see it. 2. When it's ready, click **Publish** in the top right corner.  The status pill switches to Published as soon as the article is live. You'll see "Published. Your customers can read this now." A new article doesn't need saving first: **Publish** saves and publishes it in one step. To check how it will look before you publish, save the draft and click the eye icon (**Preview article**) in the top bar. ## Publish from the Articles page - **One article:** open the **…** menu on its row and choose **Publish**, or click the article and then **Publish** in **Article details**. - **Several articles:** tick them and click **Publish** in the bar at the bottom. See [Change many articles at once](https://self.helpcenter.io/content/bulk-actions). ## What happens when you publish - The article goes live at its own address on your help center and appears in its category. - Readers can find it with your help center's search and in the widget, and AI Answers can use it if you have AI Answers turned on. - It's added to your help center's sitemap, so search engines can find it. - On a help center with more than one language, publishing puts your default language live. Each other language appears once its translation is released, and the confirmation names any language that has no translation yet. See [Translate an article](https://self.helpcenter.io/content/translate-an-article). The article's **Access** setting and its category decide who can see it. An article set to **Anyone with the link** stays out of navigation and search. An article set to **Private**, or filed in a category that isn't shared with everybody, only shows to the people allowed to see it. See [Choose who can read an article](https://self.helpcenter.io/content/article-access). ## More actions in the Publish menu The arrow next to **Publish** (or **Update**, once the article is live) opens more actions: | Action | What it does | | --- | --- | | **Preview article** | Opens the saved article in a new tab, the way readers will see it. Only your team can open the preview. | | **Insert template** | Adds one of your content templates to the end of the article. | | **Save as template** | Saves the article's content as a template you can start new articles from. | | **Schedule for review** | Sets a date to re-check the article. See [Flag articles for review](https://self.helpcenter.io/content/flag-for-review). | | **Flag for review** | Asks a teammate to check the article now. | | **Unpublish (back to draft)** | Takes a live article off your help center. See [Unpublish an article](https://self.helpcenter.io/content/unpublish-an-article). | | **Move to trash** | Deletes the article. You can restore it from Trash. See [Delete and restore articles](https://self.helpcenter.io/content/delete-and-restore-articles). | **Preview article**, the review actions and **Move to trash** appear once the article has been saved. ## Publish at a set time **Publish** puts an article live straight away. To publish at a chosen date and time, add the article to a change set and schedule the release. Change sets are in early preview on the Catalyst plan. See [Release many changes together with change sets](https://self.helpcenter.io/content/change-sets). ## Troubleshooting **"Title is required. Please add a title before saving the article."** Give the article a title, then click **Publish** again. **The article doesn't show on my help center.** Refresh the page after a moment. If it's still missing, check the article's **Access**, its category's **Share with** setting and, on a multilingual help center, whether the translation is released. See [Someone can't see an article or the help center](https://self.helpcenter.io/content/cant-see-an-article). ## Related articles - [Update a published article](https://self.helpcenter.io/content/update-a-published-article) - [Unpublish an article](https://self.helpcenter.io/content/unpublish-an-article) - [Preview an article before you publish](https://self.helpcenter.io/content/preview-an-article) - [Edit live articles safely with staged changes](https://self.helpcenter.io/content/staged-changes) --- Source: https://self.helpcenter.io/content/article-versions # See and restore earlier versions of an article _Category: Organize and publish_ Every article keeps a history of its changes: what changed, who changed it and when. Use it to see how an article evolved, or to undo a change that shouldn't have happened. **Who can do this:** Owners, Admins and Editors · **Plans:** All plans (how far back the history goes depends on your plan) ## See an article's history 1. Open the article from **Articles**. 2. Click **Version History** above the article, next to its category. 3. Each entry says what changed, who made the change and how long ago. To see the change itself, click the compare icon next to it: you get the added and removed text for content edits, and the old and new value for everything else.  The newest changes are at the top. ## What the history tracks | Entry | What changed | | --- | --- | | **Content edited** | The article's text, in the languages named in the entry. | | **Title changed** | The title. | | **Slug changed** | The article's URL. | | **Category changed** | The category the article is filed in. | | **Status changed** | The article was published or unpublished. | | **Translation released** | A language was released to readers, or hidden again. | Changes to other settings, such as the author or the article's access, aren't listed. The history shows 10 changes at a time: click **Load more** for older ones. ## Restore an earlier version 1. In **Version history**, find the change you want to undo and click **Restore** next to it. 2. Click **Restore** again to confirm. Restore puts that part of the article back the way it was right before the change. For example, restoring a **Title changed** entry brings back the previous title, and the rest of the article stays as it is. The restore is recorded as a new entry, so you can undo it the same way. **On a published article, Restore changes the live article right away.** The confirmation talks about a draft and the status pill then shows **Unpublished edits**, but readers see the restored version as soon as you confirm. Compare the change before you restore it. Restoring a **Status changed** entry also switches the article back to its earlier status, so it can publish or unpublish the article. Restoring a **Translation released** entry releases or hides that language again. ## How far back the history goes How much history you can see depends on your plan. When older changes fall outside it, a note at the bottom of the list tells you how many are hidden. See [Plans and pricing](https://self.helpcenter.io/content/plans-and-pricing). ## On help centers with staged changes If your help center uses staged changes (Catalyst, early preview), **Version history** also shows: - **Staged changes** at the top, marked **Not live**, with **Compare**, **Publish** and **Discard**. - **Live version**: what readers see right now. - **Previous live version** entries. Click **Restore**, then **Roll back**, to put that version live straight away. The version it replaces is archived first, so you can roll forward again. See [Edit live articles safely with staged changes](https://self.helpcenter.io/content/staged-changes). ## Related articles - [Update a published article](https://self.helpcenter.io/content/update-a-published-article) - [Delete and restore articles](https://self.helpcenter.io/content/delete-and-restore-articles) - [Edit live articles safely with staged changes](https://self.helpcenter.io/content/staged-changes) --- Source: https://self.helpcenter.io/content/add-images # Add images to an article _Category: Write articles_ Screenshots show readers exactly where to click, and they cut down on follow-up questions. Add images from your computer, paste them from the clipboard or drag them in, and HelpCenter.io uploads them for you. **Who can do this:** Owners, Admins and Editors · **Plans:** All plans ## Insert an image 1. On an empty line, type `/image` and press Enter. 2. Choose a file. It uploads straight into the article. 3. To add a caption, click under the image, where it says **Write a caption...**, and type.  Images upload as soon as you pick them. ## Paste or drag an image - **Paste:** copy a screenshot or an image and press ⌘V (Ctrl+V on Windows) in the article. - **Drag:** drag image files from your computer into the article. They land where you drop them. A small picture, such as an icon or a button, that you paste or drop into a line of text stays in that line. Anything larger becomes a block image with room for a caption. ## Images inside a line of text To show a button or an icon in the middle of a sentence ("Click the gear icon"), click in the sentence where the picture goes. Then click the **+** to the left of that line, pick **Inline image** and choose the file. To switch any image between the two layouts, click it and choose **Inline** or **Block** in its toolbar. Only block images can have a caption, an alignment and zoom. ## What you can upload JPEG, PNG, GIF and WebP images, up to 30 MB each. GIFs keep their animation, which makes them good for short screen recordings. ## Let readers zoom in Readers can't zoom into an image unless you turn it on. Click the image and click **Zoom on click** in its toolbar. On the published article, readers then click the image to see it full size. Turn it on for detailed screenshots. Instead of zoom, an image can link somewhere: click it, then **Link to**. An image can zoom or link, not both. ## Replace or remove an image - **Replace:** click the image, click **Replace image** and pick the new file. The caption, alt text, size and alignment stay as they were. - **Remove:** click the image and press Delete. For an image inside a line of text, click **Remove image** in its toolbar. To resize an image, align it or add alt text, see [Resize images and add alt text](https://self.helpcenter.io/content/resize-images-and-add-alt-text). ## Troubleshooting **"That file is not an image. Please choose a PNG, JPG, GIF or WebP."** The file isn't an image. Save it as one of those formats and try again. **"Unsupported image type. Upload a JPEG, PNG, GIF, or WebP image."** Formats such as SVG and BMP aren't accepted. Convert the file to PNG first. **"The maximum allowed image size is 30MB."** Make the image smaller, or crop it to the part readers need. For other upload problems, see [An image or file won't upload](https://self.helpcenter.io/content/upload-problems). ## Related articles - [Resize images and add alt text](https://self.helpcenter.io/content/resize-images-and-add-alt-text) - [Use screenshots and GIFs well](https://self.helpcenter.io/content/screenshots-and-gifs) - [An image or file won't upload](https://self.helpcenter.io/content/upload-problems) --- Source: https://self.helpcenter.io/content/callouts # Highlight tips and warnings with callouts _Category: Write articles_ Callouts are colored boxes that lift a tip, a confirmation or a warning out of the flow of an article. Use them sparingly and readers will notice every one. **Who can do this:** Owners, Admins and Editors · **Plans:** All plans ## Add a callout 1. On an empty line, type `/callout` and press Enter. 2. Under **Type**, pick a style: **Info**, **Success**, **Warning** or **Danger**. Each has its own icon, and you can pick a different one under **Icon**. 3. If you want a bold first line, add a **Title**. It's optional. 4. Write your text in **Message**. If you opened the menu by typing `/`, the message box starts with that slash, so delete it first. 5. Check the **Preview** and click **Add callout**.  Pick a style, write the message, add the callout. To turn a paragraph you've already written into a callout, click in it, click the **+** to the left of the line and pick **Callout**. Its text is already in the message box. ## The four styles Here's how each style looks to your readers. The colors adapt to your theme, in light and dark mode. **Info** adds helpful context, such as where a setting lives or what a term means. **Success** confirms a good result or shares a tip that saves readers time. **Warning** flags something that can trip readers up, such as a change that affects the whole team. **Danger** warns about losing data, access or money. Say what would happen and how to avoid it. ## Edit or remove a callout - **Change the text:** click in the callout and type. - **Change the style, icon or title:** point at the callout, click **Edit**, make your changes and click **Save changes**. - **Remove the box but keep the text:** click the **+** to the left of the callout and pick **Callout** again (it has a tick). The text stays as normal paragraphs. ## Use callouts well - One or two per article is plenty. When everything stands out, nothing does. - Keep each callout to one to three sentences. - Place it right before the step it's about, not at the end of the article. - Keep instructions in your numbered steps. A step hidden in a callout is easy to miss. ## Related articles - [Add headings, lists and other blocks](https://self.helpcenter.io/content/add-blocks) - [How to write help articles people actually read](https://self.helpcenter.io/content/how-to-write-help-articles) --- Source: https://self.helpcenter.io/content/find-articles # Find articles with search and filters _Category: Organize and publish_ As your help center grows, the Articles page helps you find any article in seconds. Search by words, narrow the list by status, category or author, and save the views you use every day. **Who can do this:** Owners, Admins, Editors and Translators · **Plans:** All plans ## Find an article 1. Click **Articles** in the left menu. 2. Type in the **Search titles and content…** box. The list updates as you type, and **Sort by** switches to **Best match**. 3. Click a status tab, such as **Published**, to narrow the list. 4. To keep this combination for later, click **Save view**.  Saved views sit above the list, one click away. Search also finds text in staged changes that aren't published yet, on help centers that use staged changes. ## Status tabs | Tab | Shows | | --- | --- | | **All** | Every article. | | **Published** | Articles that are live on your help center. | | **Drafts** | Articles that have never been published. | | **Unpublished** | Articles that were live and have been taken down. | | **In review** | Articles flagged for review, or past their scheduled review date. | | **Private** | Articles whose access is **Private** or **Anyone with the link**. | Each tab shows how many articles it holds. ## Narrow the list - **By category:** click a category in the **Categories** panel. **Any category** clears it. - **By author:** open **All authors** and pick a teammate. - **By type:** choose **Articles** or **FAQs**. This switch appears once your help center has FAQs. - **By language:** on a help center with more than one language, pick a language from the language menu to work on its translations. Then show **Translated** or **Missing** articles, and look for rows marked **Not translated** or **Outdated**. - **By staged changes:** on help centers that use staged changes, choose **Has staged changes** or **No staged changes**. You can also filter by change set. Every filter you use shows as a chip next to **Filtered by**. Click the × on a chip to remove that filter, or **Clear all** to start over. When filters hide some articles, a note says how many. ## Sort the list Use **Sort by** to order the list by **Last modified**, **Alphabetical**, **Most viewed** or **Most comments**. **Custom order** lets you drag articles into place inside a category. See [Change the order of articles and categories](https://self.helpcenter.io/content/reorder-articles-and-categories). ## Views The views above the list give you common lists in one click: **All articles**, **Needs review**, **Drafts**, **Pending changes** (articles with staged changes) and **Most viewed**. **Save view** saves your current search, tab, category, author and sort as a view of your own, named after what it filters. To remove a saved view, click the × next to its name. Your saved views, and the filters you used last, are kept in this browser. Teammates don't see them, and they don't follow you to another computer. ## Long lists More articles load as you scroll down. You can also click **Load more** at the bottom of the list. ## What next - Click an article to see its details, or click its pencil icon to make a quick edit. See [See article details and make quick edits](https://self.helpcenter.io/content/article-details). - Tick several articles to publish, move or delete them together. See [Change many articles at once](https://self.helpcenter.io/content/bulk-actions). ## Related articles - [Change many articles at once](https://self.helpcenter.io/content/bulk-actions) - [See article details and make quick edits](https://self.helpcenter.io/content/article-details) - [Find your way around the dashboard](https://self.helpcenter.io/content/dashboard-tour) --- Source: https://self.helpcenter.io/content/category-icons-and-images # Add a category icon, image and description _Category: Organize and publish_ A short description and an icon or image help readers see what's in a category before they click. You set both in the category's settings. **Who can do this:** Owners, Admins and Editors · **Plans:** All plans ## Add a description and an icon 1. Click **Articles** in the left menu and select the category in the **Categories** panel. 2. Click **Edit category**. The **Category settings** panel opens. 3. Under **Description**, write a sentence about what the category covers. It's shown on the category card in your help center. 4. Under **Category image**, keep **Icon** selected. Search for an icon and click the one you want. 5. Click **Update category**.  The description and icon appear on the category's card. ## Use an image instead 1. Under **Category image**, choose **Image**. 2. Click **Choose image** and pick a PNG or JPG file, at least 640×360 pixels. 3. Click **Update category**. A category shows either an icon or an image, not both. ## Find the right icon The picker opens with popular Font Awesome icons. Type a word such as "rocket" or "gear" to search the rest. If the icon you want isn't in the results, paste its Font Awesome class into the field below the icons, for example `fa-solid fa-map-signs`. ## Where they show - **Category cards:** wherever your help center lists categories, such as the home page. Which details a card shows depends on the category list settings in the template editor. See [Customize category and article lists](https://self.helpcenter.io/content/category-and-article-lists). - **The category page:** the icon or image can appear in front of the category's name. In the template editor, open **Pages**, choose the **Category** page and turn on **Category image**. ## Control how the category looks in search engines Open **Search engine listing** at the bottom of the panel to set a **Meta title** and a **Meta description** for the category page. If you leave them empty, the category's name and description are used. A meta description of around 155 characters works best. ## Other languages On a help center with more than one language, pick a language at the top of the panel to translate the name, description and search engine listing. The save button then saves that language. The icon or image, **Share with** and **Parent category** are shared by all languages. ## Troubleshooting **"Category name cannot be empty."** Add a name in your default language, then save again. **The image won't upload.** Use a PNG or JPG file. See [An image or file won't upload](https://self.helpcenter.io/content/upload-problems). ## Related articles - [Create and organize categories](https://self.helpcenter.io/content/organize-categories) - [Customize category and article lists](https://self.helpcenter.io/content/category-and-article-lists) - [Make a category private](https://self.helpcenter.io/content/private-categories) --- Source: https://self.helpcenter.io/content/attach-files # Attach files _Category: Write articles_ Attach a PDF, a spreadsheet or another file to an article so readers can download it right where they need it: a price list next to your pricing FAQ, or a template next to the steps that use it. **Who can do this:** Owners, Admins and Editors · **Plans:** All plans ## Attach a file 1. On an empty line, type `/file` and pick **File attachment**. The **Attachments** window opens. 2. Click **Upload new** and choose a file. You can also drag the file onto the box that says **Drag files here or browse**. 3. When the upload finishes, click **Insert** next to the file. It's added to the article as a download link.  Upload once, then insert the file wherever readers need it. You can also click **Add** on the **Attachments** card in the right-hand panel. The file goes where your cursor is in the article. Readers see the file's name, type and size. One click downloads it. The **Attachments** card lists every file in the article; click one to jump to it. ## Reuse a file you already uploaded The **Attachments** window lists every file uploaded to your help center, with its size and who uploaded it. Click **Insert** next to any of them to add it to the article you're writing. There's no need to upload the same file twice. ## What you can attach Files up to 25 MB each, in these formats: - **Documents:** PDF, Word, Excel, PowerPoint, OpenDocument, RTF, TXT and CSV - **Archives:** ZIP, GZ, TAR, RAR and 7Z - **Images:** JPEG, PNG, GIF, WebP, AVIF and HEIC - **Audio:** MP3, WAV, OGG, AAC and M4A - **Video:** MP4, MOV, WebM, AVI and OGV Web pages, SVG files and scripts can't be attached. Each file gets a long, random web address. Readers find it through your article, but anyone who has that address can download the file, even when the article is private. Keep confidential files out of attachments. ## Remove a file - **From this article:** in the **Attachments** card in the right-hand panel, click the trash icon next to the file. The file stays in your library for other articles. - **From your help center:** in the **Attachments** window, click the trash icon next to the file, then **Delete**. This deletes the file for good, and its download link stops working in every article that uses it. ## Troubleshooting **"Files up to 25MB work here."** The file is too big. Compress it, or split it into smaller files. **"Could not upload the file. Please try again."** Check that the file is in one of the formats above and under 25 MB, then try again. See [An image or file won't upload](https://self.helpcenter.io/content/upload-problems) for more fixes. ## Related articles - [Add images to an article](https://self.helpcenter.io/content/add-images) - [Get to know the article editor](https://self.helpcenter.io/content/article-editor) --- Source: https://self.helpcenter.io/content/change-your-password # Change or reset your password _Category: Team and account_ Change your password any time from Account Settings. If you've forgotten it, reset it from the sign-in page instead. **Who can do this:** Everyone, for their own account · **Plans:** All plans ## Change your password 1. At the bottom of the left menu, click your avatar, then **Account Settings**. You can also go to [helpcenter.io/app/account](https://helpcenter.io/app/account). 2. Under **Change Password**, enter your **Current Password**. 3. Enter a **New Password** of at least 6 characters, and type it again in **Confirm Password**. 4. Click **Change Password**. You see "Password successfully changed."  Use your new password the next time you sign in. ## If you signed up with Google An account created with Google has no password yet. Account Settings shows **Set a Password** instead of Change Password, and doesn't ask for a current password: enter a **New Password**, confirm it and click **Set Password**. After that you can sign in with Google or with your email and password. ## Connect or disconnect Google In **Account Settings**, **Sign-in Methods** lists Google. - Click **Connect** and pick your Google account to sign in with **Continue with Google** from then on. The Google account's address doesn't have to match your HelpCenter.io email address. The card then reads **Connected as** followed by that address. - Click **Disconnect** to go back to signing in with your email and password only. Google can't be disconnected while it's your only way to sign in. Set a password first. ## Reset a forgotten password 1. Click **Forgot password?** on the [sign-in page](https://helpcenter.io/app/signin). 2. Enter your **Email address** and click **Send Password Reset Link**. You see "If an account exists for that address, we've emailed a password reset link." 3. Open the email and click the reset link. It works for 60 minutes. 4. On **Reset your password**, enter your email address, then your new password in **New password** and **Confirm new password**. 5. Click **Reset Password**. A reset needs a password of at least 8 characters, while Account Settings accepts 6. Choose 8 or more and your password works in both places. ## Keep your account safe - Use a password you don't use anywhere else. A password manager makes that painless. - Add a second step to signing in with [two-factor authentication](https://self.helpcenter.io/content/two-factor-authentication). ## Troubleshooting **"The current password you've entered seems to be incorrect."** Type your current password again. If you don't remember it, reset it instead. **The reset email doesn't arrive.** Wait a few minutes and check your spam folder. The page shows the same confirmation for every address, so check that you entered the one on your account. If you asked for a link less than a minute ago, wait a minute before asking again. **"Set a password before disconnecting Google, or you would have no way to sign in."** Set a password under **Set a Password**, then disconnect Google. **"That Google account is already connected to a different HelpCenter.io account."** A Google account signs in to one HelpCenter.io account. Disconnect it from the other account first, or pick another Google account. **"This password reset token is invalid."** The link has expired or was already used. Request a new one. ## Related articles - [Sign in to HelpCenter.io](https://self.helpcenter.io/content/sign-in) - [Turn on two-factor authentication](https://self.helpcenter.io/content/two-factor-authentication) - [I can't sign in](https://self.helpcenter.io/content/cant-sign-in) --- Source: https://self.helpcenter.io/content/add-links # Link to another article or a website _Category: Write articles_ Link words in an article to another article in your help center, or to any website. You can find and link your own articles without leaving the editor, and those links keep working when you rename an article. **Who can do this:** Owners, Admins and Editors · **Plans:** All plans ## Link to another article 1. Select the words that should become the link. 2. Click **Link** in the toolbar that appears. 3. Click the magnifying glass (**Link to an article**). 4. Type part of the article's title, then click the article in the results.  Search your articles right from the toolbar. Drafts appear in the results with a **draft** label. You can link to a draft, but readers can't open it until you publish it. ## Link to a website 1. Select the words that should become the link. 2. Click **Link**. 3. Paste the full address, starting with `https://`, and press Enter. Faster: with the words selected, paste a web address and they become a link straight away. To link an email address, type `mailto:` in front of it, for example `mailto:support@example.com`. ## Change or remove a link - **Change it:** select the linked text and click **Link**. Edit the address and press Enter. - **Remove it:** select the linked text and click **Remove link**. The words stay, without the link. Links don't open when you click them in the editor. To test them, [preview the article](https://self.helpcenter.io/content/preview-an-article). ## Show a link as a card To point readers to another article more visibly, add an **Article link** block: type `/article` on an empty line, press Enter, then search for the article and pick it. Readers see a card with the article's title, a short summary, its category and the reading time. ## How links behave for readers - Links to other websites open in a new tab, and so do links you add with **Link to an article**. - When an article's address changes, for example because you renamed it, the old address redirects to the new one. Links you added before the change keep working, and article cards always show the current title. - Your help center adds `nofollow` to links to other websites, which tells search engines not to pass ranking credit to them. To change this, or to exempt your own sites, open the **Template editor** → **Brand** and use **Nofollow external links** and **Whitelisted domains**. ## Troubleshooting **A link opens a "page not found" page on my help center.** The address probably doesn't start with `https://`, so it's treated as a page on your help center. Edit the link and add `https://` at the start. **A link points to an article I deleted.** Readers get a "page not found" page. Restore the article from **Trash**, update the link, or send the old address somewhere useful with a redirect. See [Redirect old links to the right page](https://self.helpcenter.io/content/custom-redirects). ## Related articles - [Format text](https://self.helpcenter.io/content/format-text) - [Show an article in more than one category](https://self.helpcenter.io/content/multiple-categories) - [Redirect old links to the right page](https://self.helpcenter.io/content/custom-redirects) --- Source: https://self.helpcenter.io/content/install-the-widget # Add the widget to your website _Category: Widget and embeds_ Put your help center one click away on every page of your website or app. Visitors search your articles, read them and get answers without leaving the page they're on. You copy one snippet, paste it into your site and tell HelpCenter.io which website may show it. **Who can do this:** Anyone on your team can copy the snippet, and Owners and Admins approve your website · **Plans:** All plans ## Copy the snippet 1. In the left menu, click the gear icon, then **Embeddables**. Your widget is ready the first time you open this page; there's nothing to activate. 2. On the **Widget** tab, find **Installation** and click **Copy**. 3. Paste the snippet into your website's HTML, right before the closing `` tag, on every page where the widget should appear.  The snippet you copy already contains your widget's ID. The snippet looks like this, with your own widget ID in place of `YOUR_WIDGET_ID`: ``` ``` Put it before ``, not in the `
`: the snippet adds the widget to the page body, so the body has to exist when it runs. ### Using a website builder or tag manager You don't need a plugin. WordPress, Webflow, Shopify and any other builder or CMS that lets you add custom code to every page will work: use its setting for code in the footer or before ``. With Google Tag Manager, add the snippet as a Custom HTML tag that fires on all pages. ## Allow your website to show the widget The widget only loads on websites you approve. Until yours is on the list, the widget stays hidden there. 1. In the left menu, click the gear icon, then **Settings**. 2. In the **General** card, find **Embedding origins**. 3. Type your website's host name, such as `www.example.com`, and click **Add**. A leading dot, like `.example.com`, covers the domain and all its subdomains. 4. Click **Save changes**. This is the same list you see under **Embeddables** → **Widget** → **Configuration**. See [Choose which websites can show the widget](https://self.helpcenter.io/content/embedding-origins) for what to enter. ## Check that it works Reload a page of your website. A round button appears in the bottom-right corner. Click it to open the widget and try a search. Next, make it yours: [match the widget to your brand](https://self.helpcenter.io/content/widget-appearance), [change its greeting](https://self.helpcenter.io/content/widget-greeting) and [invite visitors with proactive messages](https://self.helpcenter.io/content/proactive-messages). Developers can do much more from code: see [Widget installation and options](https://developers.helpcenter.io/content/widget-options) and [Widget JavaScript API](https://developers.helpcenter.io/content/widget-javascript-api) on the developer portal. ## Troubleshooting **The widget doesn't appear.** Check that your website's host is under **Embedding origins** exactly as it shows in the address bar: `example.com` and `www.example.com` are different. Save, wait a couple of minutes, then reload. **Your browser console says "Parent domain is not in the allowed list."** Add the host it names to **Embedding origins**. **The snippet is in the `
`.** Move it to the end of the page body, right before ``. **Your site sends a Content Security Policy.** Allow the widget's hosts, and let the snippet itself run. The details are in [Content Security Policy and allowed origins](https://developers.helpcenter.io/content/content-security-policy) on the developer portal. Still stuck? See [The widget doesn't show up](https://self.helpcenter.io/content/widget-not-showing). ## Related articles - [Choose which websites can show the widget](https://self.helpcenter.io/content/embedding-origins) - [The widget doesn't show up](https://self.helpcenter.io/content/widget-not-showing) - [What visitors see in the widget](https://self.helpcenter.io/content/widget-for-visitors) - [Widget installation and options](https://developers.helpcenter.io/content/widget-options) on the developer portal --- Source: https://self.helpcenter.io/content/integrate-the-helpcenter-io-widget-with-gorgias-chat # Integrate the widget with Gorgias Chat _Category: Integrations and API_ Cut down on live chat requests by showing the widget first and opening Gorgias Chat only when a visitor can't find what they need. Visitors get instant answers from your help center, and your team only hears the questions your articles don't cover yet. **Who can do this:** Owners and Admins, with access to your website's code · **Plans:** All plans ## Step 1: Install Gorgias Chat If Gorgias Chat already runs on your website, skip to the next step. Otherwise, install it by following the [instructions in Gorgias's help center](https://docs.gorgias.com/en-US/chat-getting-started-81789). ## Step 2: Hide the Gorgias Chat launcher Visitors should only see the chat once they've asked for help, so hide the Gorgias chat bubble and let the widget open the chat when it's needed. Add this script right before the closing `` tag on every page where Gorgias Chat is installed: ``` ``` The chat bubble stays hidden, and because the widget shows the chat when it's needed, the script hides it again every time the chat is closed. That way you don't end up with two buttons on top of each other. ## Step 3: Add the widget and connect it to Gorgias Chat 1. In your HelpCenter.io dashboard, click the gear icon in the left menu, then **Embeddables**. 2. On the **Widget** tab, click **Copy** on the **Installation** card. The code you copied looks like this, with your own widget ID in place of `ab12c3`: ``` ``` Add a comma after `app_id: 'ab12c3'`, and on the next line add an `onContactsRequest` function that opens Gorgias Chat: ``` onContactsRequest: function(){GorgiasChat.open(); document.getElementById("gorgias-chat-container").style.display="";} ``` The finished code looks like this: ``` ``` Paste it right before the closing `` tag of your website or web app. ## How it works Visitors see the widget first and can search your help center or read an article to solve the problem themselves. When they ask to contact you from the widget, for example by clicking **I can't find what I'm looking for**, the widget calls your `onContactsRequest` function instead of showing its own contact form, and Gorgias Chat opens. Pay attention to what people ask in the chat, and add an article whenever a new question comes up. Over time, fewer visitors need to reach out with the same question. ## Good to know - The widget stays open when the chat opens. To close it at the same time, add `window.hcWidget.hide();` inside your `onContactsRequest` function. See [Widget JavaScript API](https://developers.helpcenter.io/content/widget-javascript-api) on the developer portal. - Gorgias documents more ways to control its chat from JavaScript in its guide to [advanced customization](https://docs.gorgias.com/en-US/advanced-customization-new-chat-81792). - Not comfortable editing your website's code? Ask a developer, or [contact us](https://self.helpcenter.io/content/contact-support): we may be able to help. ## Related articles - [Add the widget to your website](https://self.helpcenter.io/content/install-the-widget) - [Integrations overview](https://self.helpcenter.io/content/integrations) - [Handle contact requests yourself](https://developers.helpcenter.io/content/widget-custom-contact) on the developer portal - [Widget JavaScript API](https://developers.helpcenter.io/content/widget-javascript-api) on the developer portal --- Source: https://self.helpcenter.io/content/widget-not-showing # The widget doesn't show up _Category: Troubleshooting_ When the widget's button doesn't appear on your site, one of these causes is almost always behind it. Start at the top. Your browser's console often names the problem. In most browsers, right-click the page, choose **Inspect**, then open the **Console** tab and reload the page. ## Your website isn't in Embedding origins This is the most common cause. The widget runs only on websites you've approved, and while the list is empty it's blocked everywhere. The console shows **"Parent domain is not in the allowed list."** followed by the domain the widget found. 1. Click the gear icon, then **Settings**. 2. Under **Embedding origins**, type the domain of the page that shows the widget, for example `www.example.com`, and click **Add**. 3. Click **Save changes**, then reload the page with the widget.  Add every website that shows the widget, then save. - Enter the domain only, without `https://` or a page path. If you paste a full address, only the domain is kept. - `example.com` and `www.example.com` are different domains. Add both, or add `.example.com`: a leading dot covers the domain and all its subdomains. - Ports don't matter, so `localhost` also covers `localhost:9090` while you test on your own computer. - Add as many domains as you need. You'll find the same list under **Embeddables** → **Widget** → **Configuration**. ## The snippet isn't running on the page To check, type `hcOptions` in the console and press Enter. If you see your `app_id`, the snippet ran. If the console says `hcOptions` is not defined, it didn't. 1. Copy the snippet again: click the gear icon, then **Embeddables**, and under **Installation** click **Copy**. 2. Paste it right before the closing `` tag of the page. The snippet adds the widget to the page body, so placed in the `
` it runs before there's a body and fails.
3. Added it with a tag manager or a website builder? Check that the change is published and set to run on this page.
## The app_id doesn't match
Each widget has its own ID, shown in the snippet as `app_id`. With a typo, or a snippet copied from another help center, the widget loads nothing, and requests to embed.helpcenter.io in the browser's **Network** tab answer "Widget not found." Copy the snippet again from **Embeddables** and replace the old one.
## The button is hidden on purpose
- `showButton: false` in `hcOptions` hides the round button. The widget still loads and opens when your own button calls `hcWidget.show()`. See [Open the widget from your own UI](https://developers.helpcenter.io/content/open-the-widget-from-your-ui) on the developer portal.
- `widgetEnabled: false` stops the widget from loading at all. Remove it to bring the widget back.
## The widget opens, but visitors can't read anything
- **Your help center is Private or uses a password.** Visitors who aren't signed in can't read it through the widget, and requests answer "This help center requires authentication." Make the help center **Public**, or sign visitors in with JWT (Catalyst plan). See [Sign readers in with your own login (JWT SSO)](https://self.helpcenter.io/content/jwt-sso) and [Sign readers into the widget with a JWT](https://developers.helpcenter.io/content/widget-jwt) on the developer portal.
- **IP whitelisting is on.** Visitors outside the listed addresses see **Not available on this network** in the widget. Add their addresses or clear the list. See [Restrict access by IP address](https://self.helpcenter.io/content/ip-allowlist).
## Something on your website blocks it
- **Ad blockers and privacy extensions** can block the widget for some visitors. Test in a private window with extensions turned off.
- **A cookie consent tool** that holds back scripts until visitors agree also holds back the widget until then.
- **A Content Security Policy.** If your site sends one, allow `https://helpcenter.io` in `script-src`, and `https://embed.helpcenter.io` in `frame-src` and `connect-src`. The snippet itself is an inline script, so allow it too (with a nonce or a hash), or set `hcOptions` from a script file of your own. For widget statistics, also allow `https://metrics.helpcenter.io` in `connect-src`. The console names anything it blocked. See [Content Security Policy and allowed origins](https://developers.helpcenter.io/content/content-security-policy) on the developer portal.
## "Parent domain not found. Cannot render the widget."
The widget couldn't tell which website it's on. Some browsers show this when your site tells them not to share the page address (a `Referrer-Policy` of `no-referrer`). Use a referrer policy that shares at least the site's domain. Test on a real web address too: on a page opened as a file on your computer, the widget doesn't load at all.
## Still stuck?
Contact our support team and include the address of the page where the widget should appear. See [Contact HelpCenter.io support](https://self.helpcenter.io/content/contact-support).
## Related articles
- [Add the widget to your website](https://self.helpcenter.io/content/install-the-widget)
- [Choose which websites can show the widget](https://self.helpcenter.io/content/embedding-origins)
- [Widget JavaScript API](https://developers.helpcenter.io/content/widget-javascript-api) on the developer portal
---
Source: https://self.helpcenter.io/content/article-seo
# Set an article's search title, description and URL
_Category: Write articles_
Decide how an article shows up in Google and other search engines: the title in the results, the short description under it, and the article's address. A clear title and description help the right people click through.
**Who can do this:** Owners, Admins and Editors · **Plans:** All plans (AI drafting: Catalyst plan, or the AI add-on on Bootstrap and Growth)
## Set the search title and description
1. In the right-hand panel, go to **URL and search** and click **Search and social preview**.
2. In **Meta title**, write the title people see in search results. The counter helps you stay under about 60 characters.
3. In **Meta description**, write one or two sentences about what the reader will find. About 160 characters fit.
4. Check the **Search result preview**, then click **Save**.
5. Save the article with **Save draft**, **Publish** or **Update**. Your search settings go live with that save.

The preview updates as you type.
## If you leave them empty
- The search title is the article's title.
- The description is the first 150 characters of the article.
Either way, your help center adds its **Default page title** after the article's title in search results and browser tabs, for example `Reset your password - Acme Help Center`. You set it in the **Template editor** under **Brand**.
## Write a title and description that get clicks
- Lead with the task, in your customers' words: "Reset your password" beats "Password management overview".
- Give every article a different title, so search engines and readers can tell them apart.
- In the description, say what the reader will be able to do, and name the product or feature.
- Search engines may shorten a long title or description, so put the important words first.
## Let AI draft them
In **Search and social preview**, click **Draft the title and description from the article**. You can also click **Draft meta title and description** in the **AI writing help** card, which opens the same window with both fields filled in. Nothing is saved until you click **Save**.
## Change the article's address
The **Slug** is the last part of the article's address. It's locked so links stay stable, and it follows the title: rename the article and the slug changes with it.
1. In **URL and search**, click the pencil next to the slug.
2. Type the new slug. Spaces and symbols turn into hyphens as you type.
3. Press Enter or click the check mark.
A slug you edit by hand no longer follows title changes. When the slug of a saved article changes, the old address redirects to the new one, so existing links keep working. If another article already uses the slug, a few random characters are added to keep it unique.
The **Suggest a slug** action in the **AI writing help** card writes a short slug from the title and puts it in place. Edit it if it doesn't read well.
## Advanced options
Click **Advanced: canonical, robots, social cards** in the same window for more settings. Use **Canonical URL** only when the article was published somewhere else first: it tells search engines which address is the original.
The other advanced settings (**Let search engines index this page**, **Follow links** and the social title, description and image) are saved with the article, but your published help center doesn't apply them today. Social cards use your help center's Open Graph settings from the template editor when you've set them, and the article's search title and description otherwise.
## More than one language?
The slug, search title and description are separate for each language. Pick a language in the **Language** bar above the article, then set them for that language. The canonical URL is shared by every language.
## Related articles
- [SEO settings for your help center](https://self.helpcenter.io/content/seo-settings)
- [Help center SEO: get your articles found](https://self.helpcenter.io/content/help-center-seo)
- [Write faster with AI writing help](https://self.helpcenter.io/content/ai-writing-help)
---
Source: https://self.helpcenter.io/content/turn-on-comments
# How do I turn on reader comments?
_Category: Design and templates_
Add the **Comments** component to your Article page in the template editor, then publish. Every article then gets a comment form at the bottom.
1. In the left menu, click **Template editor**. Open **Pages**, pick **Article** in the page menu, then the **Main** region.
2. Under **After the article**, click **Add to "After the article"** and pick **Comments**.
3. Click **Publish**.

Add Comments to the Article page, then publish.
Readers leave their name, email and comment. While **Require approval** is on, which it is by default, new comments wait for your approval before other readers see them. Approve and answer them in **Comments** in the left menu, which appears once you publish the design with the Comments component.
Owners and Admins can add the component (Editors through **Customize** on your help center), and Owners, Admins and Editors can approve comments. It works on every plan.
## Related articles
- [Add ratings and comments to articles](https://self.helpcenter.io/content/ratings-and-comments)
- [Approve and answer reader comments](https://self.helpcenter.io/content/moderate-comments)
---
Source: https://self.helpcenter.io/content/zendesk
# Connect Zendesk
_Category: Integrations and API_
Give your Zendesk agents your help center inside every ticket. They can search your articles, see suggestions for the ticket and insert a link or the whole article into their reply, without leaving Zendesk.
**Who can do this:** Owners and Admins · **Plans:** All plans (Smart suggestions need the Catalyst plan, or the AI add-on on Bootstrap and Growth)
## Step 1: Switch on Zendesk in HelpCenter.io
1. In the left menu, click the gear icon, then **Settings**.
2. Under **Integrations**, switch on **Zendesk**. A **Token** appears.
3. Click **Copy** next to the token.

The token links your Zendesk account to this help center.
## Step 2: Install the HelpCenter.io app in Zendesk
1. Open the [HelpCenter.io app on the Zendesk Marketplace](https://www.zendesk.com/marketplace/apps/support/943718/helpcenterio/) and install it in your Zendesk account.
2. In **Subdomain**, enter your HelpCenter.io subdomain: the part before `.helpcenter.io` in your help center's address. For `acme.helpcenter.io`, enter `acme`. Use it even if your help center runs on your own domain.
3. Paste the token into **Integration token**.
4. Scroll down and click **Install**.
## What agents see in Zendesk
The HelpCenter.io app appears in the ticket sidebar. Agents can:
- **Search** your articles from the search field.
- Check **Smart suggestions**: articles that match the latest comment on the ticket.
- Browse your **Categories**.
- Pick the language of the articles, when your help center has more than one.
- Open an article and click **Insert Link** or **Insert Content** to add it to their reply. **Insert Content** adds the version readers see, without your team's internal notes.
## Turn it off
Switch off **Zendesk** under **Settings** → **Integrations**. The token stops working straight away. If you switch Zendesk on again later, you get a new token: paste it into the app's settings in Zendesk.
## Troubleshooting
**The app shows no categories or an error.** Open the app's settings in Zendesk and check that **Subdomain** matches your HelpCenter.io subdomain exactly and that the token matches the one under **Settings** → **Integrations**. If you changed your help center's subdomain, update it in the app too.
**No Smart suggestions.** They need the Catalyst plan or the AI add-on, and they only show when the ticket has a comment that matches your articles. If you added AI recently, switch on **AI Answers** once under **Settings** → **AI features**, so your existing articles are prepared for suggestions.
## Related articles
- [Integrations overview](https://self.helpcenter.io/content/integrations)
- [Connect Front](https://self.helpcenter.io/content/front)
- [Add AI Answers to your plan](https://self.helpcenter.io/content/ai-add-on)
---
Source: https://self.helpcenter.io/content/integrate-the-helpcenter-io-smart-widget-with-the-tawk-to-chat-widget
# Integrate the widget with tawk.to
_Category: Integrations and API_
Show the widget first and open your tawk.to live chat only when a visitor can't find what they need. Visitors get instant answers from your help center, and your team only hears the questions your articles don't cover yet.
**Who can do this:** Owners and Admins, with access to your website's code · **Plans:** All plans
## Step 1: Install tawk.to on your website
If tawk.to already runs on your website, skip to the next step.
1. Sign in to your tawk.to dashboard and go to **Administration** → **Channels** → **Chat Widget**.
2. Copy your JavaScript snippet and place it right before the closing `` tag on every page where you want the chat.
For more detail, see tawk.to's guide to [adding a widget to your website](https://help.tawk.to/article/adding-a-widget-to-your-website).
## Step 2: Hide tawk.to until it's needed
Visitors should only see the chat once they've asked for help, so tawk.to starts hidden. Paste this code right after your tawk.to snippet:
```
```
The widget shows the chat again when it's needed.
## Step 3: Add the widget and connect it to tawk.to
1. In your HelpCenter.io dashboard, click the gear icon in the left menu, then **Embeddables**.
2. On the **Widget** tab, click **Copy** on the **Installation** card.
The code you copied looks like this, with your own widget ID in place of `ab12c3`:
```
```
Add a comma after `app_id: 'ab12c3'`, and on the next line add an `onContactsRequest` function that opens tawk.to:
```
onContactsRequest: function(){if(window.Tawk_API){window.Tawk_API.showWidget();window.Tawk_API.maximize();window.hcWidget.hideAll();}else{console.error('Unable to find tawk.to widget.');}}
```
This shows and opens the tawk.to chat, and hides the widget so the two don't overlap. The finished code looks like this:
```
```
Paste it right before the closing `` tag of your website or web app.
## How it works
Visitors see the widget first and can search your help center or read an article to solve the problem themselves. When they ask to contact you from the widget, for example by clicking **I can't find what I'm looking for**, the widget calls your `onContactsRequest` function instead of showing its own contact form: tawk.to opens and the widget hides until the next page load.
Pay attention to what people ask in the chat, and add an article whenever a new question comes up. Over time, fewer visitors need to reach out with the same question.
Not comfortable editing your website's code? Ask a developer, or [contact us](https://self.helpcenter.io/content/contact-support): we may be able to help.
## Related articles
- [Add the widget to your website](https://self.helpcenter.io/content/install-the-widget)
- [Integrations overview](https://self.helpcenter.io/content/integrations)
- [Handle contact requests yourself](https://developers.helpcenter.io/content/widget-custom-contact) on the developer portal
- [Widget JavaScript API](https://developers.helpcenter.io/content/widget-javascript-api) on the developer portal
---
Source: https://self.helpcenter.io/content/custom-domain-godaddy
# Set up your custom domain with GoDaddy
_Category: Domain, access and SEO_
If your domain is managed at GoDaddy, add one CNAME record there to put your help center on your own address, like support.mywebsite.com. Once the record is live, HelpCenter.io verifies it and issues your SSL certificate automatically.
**Who can do this:** Owners and Admins, with access to your GoDaddy account · **Plans:** All plans
## Before you start
Add your domain in HelpCenter.io first. Go to **Settings** → **Custom domain**, type the address you want, for example `support.mywebsite.com`, and click **Apply**. The card then shows the value for your record: your help center's current address, like `myapp.helpcenter.io`. See [Use your own domain](https://self.helpcenter.io/content/custom-domain) for the full walkthrough.
## Add the CNAME record in GoDaddy
1. Sign in to your GoDaddy **Domain Portfolio**. If you can't remember your username or password, the sign-in page helps you recover them.
2. Select the domain you want to use. Its **Domain Settings** page opens.
3. Select **DNS** to see the domain's DNS records.
4. Select **Add New Record**, then choose **CNAME** from the **Type** menu.
5. Fill in the record:
- **Name:** the subdomain for your help center, without your domain. Usually `support`, `help` or `faqs`.
- **Value:** your help center's address from HelpCenter.io, for example `myapp.helpcenter.io`.
- **TTL:** how long other servers cache the record before checking again. The default of 1 hour is fine.
6. Select **Save** to add the record. If you change your mind before saving, use **Delete** to discard the unsaved record.
GoDaddy's rules for the **Name**:
- Periods (.) are allowed, but not as the first or last character, and never two in a row.
- It can be up to 63 characters long.
- It can't be the @ symbol, which stands for your bare domain.
- It can't already be used by another record, such as an A, TXT or MX record.
If your domain has **Domain Protection**, GoDaddy asks you to verify your identity before saving. If you've had 2-step verification turned on for at least 24 hours, enter the code from your text message or authenticator app. Otherwise, use the one-time password GoDaddy sends to your registrant email address.
Most DNS changes take effect within an hour, but they can take up to 48 hours to update everywhere. For more detail, see GoDaddy's own guide, [Add a CNAME record](https://ie.godaddy.com/help/add-a-cname-record-19236).
## Verify the domain in HelpCenter.io
1. Go back to **Settings** → **Custom domain**.
2. Click **Verify DNS** and follow **Domain status** until **DNS verification**, **SSL certificate issued** and **Domain connected** are all checked.
If the record hasn't spread yet, you don't need to wait on the page. HelpCenter.io keeps checking your domain on its own.
## Troubleshooting
**"The DNS record seems to be incorrect."** Check that **Name** holds only the subdomain part and **Value** is your helpcenter.io address with no `https://`. Then give the change time to spread. See [My custom domain isn't working](https://self.helpcenter.io/content/custom-domain-not-working).
## Related articles
- [Use your own domain](https://self.helpcenter.io/content/custom-domain)
- [My custom domain isn't working](https://self.helpcenter.io/content/custom-domain-not-working)
---
Source: https://self.helpcenter.io/content/custom-domain-namebright
# Set up your custom domain with NameBright
_Category: Domain, access and SEO_
If your domain is registered with NameBright, add one CNAME record there to put your help center on your own address, like support.mydomain.com. Once the record is live, HelpCenter.io verifies it and issues your SSL certificate automatically.
**Who can do this:** Owners and Admins, with access to your NameBright account · **Plans:** All plans
## Before you start
Add your domain in HelpCenter.io first. Go to **Settings** → **Custom domain**, type the address you want, for example `support.mydomain.com`, and click **Apply**. The card then shows the value for your record: your help center's current address, like `mykb.helpcenter.io`. See [Use your own domain](https://self.helpcenter.io/content/custom-domain) for the full walkthrough.
NameBright has two versions of its dashboard: the new NameBright experience and the older one. Follow the steps that match what you see after you sign in.
In the steps below, `mykb.helpcenter.io` is only an example. Enter your own help center's address, exactly as the **Custom domain** card shows it.
## In the new NameBright experience
1. Sign in to your NameBright account.
2. Click **My Domains** in the main menu.
3. Find the domain you want to use for your help center and select it.
4. Click the options menu in the top right corner of the domains table and choose **DNS Records**.
5. Click **Add New DNS Record** and choose **CNAME** from the menu.
6. Fill in the dialog:
- **Subdomain:** the subdomain for your help center, for example `help` or `support`.
- **Canonical Name:** your help center's address, for example `mykb.helpcenter.io`.
- **TTL:** leave it as it is.
7. Click **Add Record**.
8. When the record appears in the table, click **Save Changes** below the table. If you're taken back to your domains list with a notice like "Bulk Update Started", the change went through.
## In the older NameBright dashboard
1. Go to [namebright.com](https://www.namebright.com) and sign in.
2. Click **My Account** in the main menu. Your domains are listed there.
3. Find the domain you want to use and click **DNS Records** in its tab menu. The DNS management screen for that domain opens.
4. Scroll to the bottom of the page and click the orange **Add a New DNS Record** button.
5. Fill in the form:
- **Add a New DNS Record:** choose **CNAME Canonical name**.
- **Subdomain:** choose **Custom Host Name** and type the subdomain for your help center. For support.mydomain.com, type `support`.
- **Redirect Domain:** your help center's address, for example `mykb.helpcenter.io`.
6. Click **Add** and wait for the update to finish.
## Verify the domain in HelpCenter.io
1. Go back to **Settings** → **Custom domain**.
2. Click **Verify DNS** and follow **Domain status** until **DNS verification**, **SSL certificate issued** and **Domain connected** are all checked.
DNS changes can take a while to spread. You don't need to wait on the page: HelpCenter.io keeps checking your domain and sets up the SSL certificate for a secure connection as soon as the record is visible.
## Troubleshooting
**"The DNS record seems to be incorrect."** Check that the subdomain holds only the first part of your address (`support`) and that the address field has your helpcenter.io address with no `https://`. Then give the change time to spread. See [My custom domain isn't working](https://self.helpcenter.io/content/custom-domain-not-working).
## Related articles
- [Use your own domain](https://self.helpcenter.io/content/custom-domain)
- [My custom domain isn't working](https://self.helpcenter.io/content/custom-domain-not-working)
---
Source: https://self.helpcenter.io/content/js-only-access
# Show your help center only inside your app
_Category: Widget and embeds_
Keep your help center off the open web and show it only inside your own website or app, for example behind your product's login. With JS-only access on, your help center loads only inside the widget and embeds on the websites you approve.
**Who can do this:** Owners and Admins
## Turn on JS-only access
1. In the left menu, click the gear icon, then **Settings**.
2. In the **General** card, under **Access & visibility**, switch on **JS-only access**.
3. Check that **Embedding origins**, further down the same card, lists every website that shows your widget or your embedded help center. See [Choose which websites can show the widget](https://self.helpcenter.io/content/embedding-origins).
4. Click **Save changes**.
## What changes
- Anyone who opens your help center's pages directly sees "Help center not available." That includes its search, shared FAQ pages and search engines. Your sitemap and llms.txt stop listing your articles.
- The widget keeps working, and so does your embedded help center on the websites in your **Embedding origins**. On any other website, the browser refuses to show the embed, and following a link from another website to one of your pages shows "Embedding not allowed."
- Your public MCP server turns off, so readers can't connect AI assistants to your help center. The **Public MCP server** card in **Settings** then says "This help center only opens inside the page that embeds it (JS-only access)."
To show your full help center inside your app, add the embed code to the page: see [Embed your help center in your app](https://developers.helpcenter.io/content/embed-your-help-center) on the developer portal. For the widget, see [Add the widget to your website](https://self.helpcenter.io/content/install-the-widget).
## How it decides who gets in
JS-only access checks where each request comes from, using the address the browser sends along (the referrer). It keeps your help center from being browsed as a normal website, but it isn't access control. To limit who can read your articles, make your help center **Private** and sign readers in with single sign-on (part of the Catalyst plan). See [Control who can see your help center](https://self.helpcenter.io/content/who-can-see-your-help-center) and [Sign readers in with your own login (JWT SSO)](https://self.helpcenter.io/content/jwt-sso).
Because it relies on the referrer, a page that tells browsers not to send one, with a strict referrer policy such as `no-referrer`, can't show the embed. Allow at least the origin to be sent.
Your embedded help center also needs a browser that tells HelpCenter.io the page is loading inside a frame. Current browsers do. Safari older than version 16.4 doesn't, so the embedded help center doesn't open there. The widget isn't affected.
## Turn it off
Switch off **JS-only access** and click **Save changes**. Your help center opens at its own address again.
## Related articles
- [Add the widget to your website](https://self.helpcenter.io/content/install-the-widget)
- [Choose which websites can show the widget](https://self.helpcenter.io/content/embedding-origins)
- [Control who can see your help center](https://self.helpcenter.io/content/who-can-see-your-help-center)
- [Let readers use your help center in their AI assistant](https://self.helpcenter.io/content/public-mcp-server)
- [Embed your help center in your app](https://developers.helpcenter.io/content/embed-your-help-center) on the developer portal
---
Source: https://self.helpcenter.io/content/what-makes-helpcenter-io-unique
# What makes HelpCenter.io different?
_Category: Why HelpCenter.io_
HelpCenter.io focuses on one thing, the knowledge base your customers, your website and your AI tools all answer from, and charges a flat price per help center instead of per agent. There's no ticketing system or CRM to pay for.
- **Straightforward pricing:** from $29/month per help center, billed yearly, with AI included on Catalyst and no per-answer fees.
- **Your design, no code needed:** pick one of 16 themes in the template editor and make it yours, with custom CSS when you want it.
- **AI answers you can check:** AI Answers writes only from your published articles and links to its sources.
- **Ready for AI:** readers can add your public help center to their own AI assistant, and on Growth and Catalyst your team can connect Claude or ChatGPT to write and organize articles.
- **Help inside your product:** the widget brings your articles into your website or app, and proactive messages invite visitors in when they need help.
- **Safer releases:** staged changes and change sets let you prepare updates and publish them together (Catalyst, in early preview).
- **Many languages:** Growth and Catalyst serve your help center in several languages, and Catalyst drafts translations with AI.
- **Accessible themes:** keyboard navigation, screen reader landmarks and automatic color contrast are built in.
- **Free migration** on Growth and Catalyst: we move your existing help center for you.
Try it free for 14 days, no credit card needed, or compare the plans in [Plans and pricing](https://self.helpcenter.io/content/plans-and-pricing).
## Related articles
- [Is HelpCenter.io right for my company?](https://self.helpcenter.io/content/is-helpcenter-io-right-for-my-company)
- [AI features in HelpCenter.io](https://self.helpcenter.io/content/ai-features)
- [Plans and pricing](https://self.helpcenter.io/content/plans-and-pricing)
---
Source: https://self.helpcenter.io/content/create-an-api-key
# Create an API key
_Category: Integrations and API_
Create an API key to connect your help center to your own code, scripts and tools through the HelpCenter.io API. Sync articles with other systems, power your own search, automate content updates or pull your statistics into internal dashboards.
**Who can do this:** Owners and Admins · **Plans:** All plans
## Create a key
1. In the left menu, click the gear icon, then **Settings**.
2. Under **API keys**, click **New key**.
3. In **Name**, say where the key will be used, for example "Docs sync script". A clear name tells you later which key to delete.
4. Pick a **Scope**: **Read only** or **Read & write**.
5. Leave **Team notes** off unless the integration needs your team's editorial notes, and **Design** off unless it changes how your help center looks.
6. Click **Create key**.
7. Click **Copy** next to the new key and store it somewhere safe, such as a password manager or your server's secret settings.

New keys appear in the list, masked, with their scope.
The list shows each key masked, with its scope, a **Team notes** tag if it has notes access and a **Design** tag if it has design access. **Copy** always copies the full key.
## Choose a scope
| Option | What the key can do |
| --- | --- |
| **Read only** | Read your articles, categories, comments and statistics, without changing anything. |
| **Read & write** | Everything a read-only key can do, plus create, update and delete articles and categories, upload images, moderate comments and manage webhooks. |
| **Team notes** (optional) | Read the private notes your team leaves on articles. With **Read & write**, also answer and resolve them. Readers never see these notes. |
| **Design** (optional) | Read your help center's design. With **Read & write**, also change and publish the theme, pages, components, custom CSS and scripts. |
You choose the scope, **Team notes** access and **Design** access when you create a key, and you can't change them later. To give an integration more access, create a new key, switch the integration to it and delete the old one.
## Give a key access to your design
Tick **Allow access to the help center design** when an integration should work on your design: the theme, pages, components, navigation, custom CSS and scripts. Design access includes custom CSS and scripts, which run on every page of your help center, so give it only to tools you trust.
1. Under **API keys**, click **New key** and name the key.
2. Pick **Read & write** if the key should change and publish your design. A **Read only** key can read the design but not change it.
3. Under **Design**, tick **Allow access to the help center design**.
4. Click **Create key**. The key appears in the list with a **Design** tag.

A key with design access carries a Design tag.
A key with design access edits the same draft you see in the template editor. You can review its changes there with the live preview, and visitors see nothing until the draft is published, either by you in the editor or by the integration with a **Read & write** key. The [Design API](https://developers.helpcenter.io/content/design-api) article on the developer portal explains each request.
## Use your key
Whoever builds the integration sends the key in the `apikey` header of each request to `https://api.helpcenter.io/v1`. A key works only with the help center it was created in. For a first request, follow [Quickstart: your first API request](https://developers.helpcenter.io/content/quickstart-your-first-request) on the developer portal. [API keys](https://developers.helpcenter.io/content/api-keys) there explains how keys work in detail.
A key can also connect an AI agent you build to your help center, on the Growth and Catalyst plans. See [Connect Claude, ChatGPT and other AI agents](https://self.helpcenter.io/content/connect-ai-agents).
## Limits and errors
Each key can make up to 300 requests a minute, with lower limits for changes and for statistics. A key that goes over a limit gets `429` responses until it may try again. [Rate limits](https://developers.helpcenter.io/content/rate-limits) on the developer portal has the numbers and how to handle them, and [Errors](https://developers.helpcenter.io/content/errors) explains every error response.
## Keep your keys safe
- Use **Read only** keys whenever you don't need to change content.
- Leave **Team notes** and **Design** off for integrations that only work with articles.
- Create a separate key for each integration, so you can delete one without breaking the others.
- Never put a key in code that runs in the browser or in a public repository. The widget doesn't need an API key.
- To replace a key, create a new one, switch your integration to it, then delete the old one.
- Delete keys you no longer use.
## Delete a key
1. Under **Settings** → **API keys**, click the trash icon next to the key.
2. Click **Delete key** to confirm.
Requests using that key stop working immediately.
## Who can see a key
Keys are personal: you see and delete only the keys you created, and other admins see only theirs. Before you remove someone from the team, ask them to delete the keys they created. If that's no longer possible, [contact support](https://self.helpcenter.io/content/contact-support).
## Related articles
- [The HelpCenter.io API](https://self.helpcenter.io/content/using-the-helpcenter-io-api)
- [Connect Claude, ChatGPT and other AI agents](https://self.helpcenter.io/content/connect-ai-agents)
- [API keys](https://developers.helpcenter.io/content/api-keys) on the developer portal
- [Quickstart: your first API request](https://developers.helpcenter.io/content/quickstart-your-first-request) on the developer portal
---
Source: https://self.helpcenter.io/content/can-i-have-multiple-sso-configurations-on-one-help-center
# Can I have more than one SSO configuration on a help center?
_Category: Domain, access and SEO_
No. Each help center has one JWT configuration: one Login URL and one shared secret, plus an optional Issuer and Audience.
Several of your own apps can still sign readers in to the same help center, as long as they all sign with that shared secret and match the Issuer and Audience if you set them. Readers who open the help center directly always go to the one Login URL, so that endpoint has to handle all of them.
If two audiences sign in through different systems, such as customers and partners, give each its own help center with its own SSO setup. Each help center needs a plan that includes SSO. See [Create another help center](https://self.helpcenter.io/content/create-another-help-center).
[How JWT single sign-on works](https://developers.helpcenter.io/content/how-jwt-sso-works) on the developer portal shows how the pieces fit together.
## Related articles
- [Sign readers in with your own login (JWT SSO)](https://self.helpcenter.io/content/jwt-sso)
- [Create another help center](https://self.helpcenter.io/content/create-another-help-center)
---
Source: https://self.helpcenter.io/content/can-different-users-get-different-roles
# Can different readers get different access?
_Category: Domain, access and SEO_
Not through SSO. Everyone who signs in with SSO gets the same reader access, and a `role` claim in the token is ignored.
SSO readers see everything that's open to all readers of your help center. Categories shared with team members only, and categories or articles shared with selected team members, stay hidden from them. So you can keep internal content out of reach, but you can't show one group of SSO readers something the others can't see: private categories are shared with team members, not with SSO readers. See [Make a category private](https://self.helpcenter.io/content/private-categories).
If groups of readers need different content, give each group its own help center with its own SSO setup. See [Create another help center](https://self.helpcenter.io/content/create-another-help-center). SSO never gives access to the dashboard: to add a colleague to your team, invite them under **Users**.
What SSO does and doesn't do is in [How JWT single sign-on works](https://developers.helpcenter.io/content/how-jwt-sso-works) on the developer portal.
## Related articles
- [Sign readers in with your own login (JWT SSO)](https://self.helpcenter.io/content/jwt-sso)
- [Make a category private](https://self.helpcenter.io/content/private-categories)
- [Roles and permissions](https://self.helpcenter.io/content/roles-and-permissions)
---
Source: https://self.helpcenter.io/content/what-if-a-user-s-email-changes-on-my-side
# What if a reader's email changes on our side?
_Category: Domain, access and SEO_
Send an `external_id` claim in every token, from the first sign-in, and the reader keeps the same account in your help center when their email changes.
HelpCenter.io recognizes an SSO reader by their email address or by their `external_id`. Use your own stable user ID, the one that never changes, as the `external_id`. When a token arrives with a new email but a known `external_id`, HelpCenter.io signs in the reader it already knows.
```
{
"jti": "the key HelpCenter.io sent",
"iat": 1767225600,
"exp": 1767225900,
"email": "new.address@example.com",
"name": "Jane Doe",
"external_id": "4815"
}
```
- **Add it from the start.** A reader created without an `external_id` stays matched by email only, even if later tokens include one. A changed email then creates a new reader.
- **Details stay as they were.** HelpCenter.io keeps the email, name and other details a reader was created with, so their comments keep showing the name from their first sign-in.
See [JWT claims and validation rules](https://developers.helpcenter.io/content/jwt-claims) on the developer portal.
## Related articles
- [Sign readers in with your own login (JWT SSO)](https://self.helpcenter.io/content/jwt-sso)
---
Source: https://self.helpcenter.io/content/how-long-should-my-tokens-live
# How long should my SSO tokens live?
_Category: Domain, access and SEO_
Short: 300 seconds (5 minutes) is a good default, and it's what the **Token TTL** setting recommends.
A token only has to live long enough to reach HelpCenter.io. Your Login URL redirects the reader straight to `/sso/jwt`, so a few minutes leaves plenty of room, and once the reader is signed in the token isn't needed again.
- **Sign-in keys work once.** The `key` HelpCenter.io sends to your Login URL is good for one sign-in, so a longer token life gives readers nothing extra. It only widens the window in which a leaked token could be used.
- **Token TTL caps widget tokens only.** The widget rejects tokens older than your Token TTL (30 to 86,400 seconds), even if their `exp` is later. For sign-in through your Login URL or an iframe, `exp` is the only limit, so keep it short on your side.
- **The widget gets fresh tokens on its own.** It asks your `onAuthExpired` function for a new one when it needs it, so short tokens don't bother your readers.
- **The token's life isn't the sign-in's life.** Once a reader is signed in to your help center, **Reader sign-in lasts** decides how long they stay signed in: from 1 hour to 30 days, 24 hours by default. See [Sign readers in with your own login (JWT SSO)](https://self.helpcenter.io/content/jwt-sso).
- **Clocks matter.** `exp` is required, and HelpCenter.io allows 30 seconds of difference on `iat` and `exp`. Keep your server's clock in sync, for example with NTP.
The full rules are in [JWT claims and validation rules](https://developers.helpcenter.io/content/jwt-claims) on the developer portal.
## Related articles
- [Sign readers in with your own login (JWT SSO)](https://self.helpcenter.io/content/jwt-sso)
- [Sign readers into the widget with a JWT](https://developers.helpcenter.io/content/widget-jwt) on the developer portal
---
Source: https://self.helpcenter.io/content/can-i-rotate-the-shared-secret-without-downtime
# Can I rotate the SSO shared secret without downtime?
_Category: Domain, access and SEO_
Not completely. A help center has one shared secret at a time, so the moment you save a new one, tokens signed with the old secret stop working.
You can keep the gap to a few moments:
1. Pick a quiet time for your readers.
2. Prepare the new secret. Either click **Regenerate** in **Settings** → **Single sign-on**, confirm the warning and copy the value, or create your own of at least 64 characters. The new secret doesn't take effect until you save.
3. Put the new secret in your server's configuration, ready to deploy.
4. Click **Save JWT settings** and deploy the new secret at the same time.
Saving a new secret signs out every reader who is signed in to the help center. On their next visit they go through your Login URL again, which is also how you end every open reader sign-in at once if a secret leaks. Sign-ins and widget requests during the gap fail, and work again as soon as your server signs with the new secret. A reader caught in the middle only needs to try again. See [Troubleshoot single sign-on](https://developers.helpcenter.io/content/troubleshoot-sso) on the developer portal.
## Related articles
- [Sign readers in with your own login (JWT SSO)](https://self.helpcenter.io/content/jwt-sso)
---
Source: https://self.helpcenter.io/content/template-editor
# Get started with the template editor
_Category: Design and templates_
The template editor is where you design your help center: pick a theme, add your logo and colors, arrange every page and check the result on any screen size. Everything you change stays in a private draft until you publish it, so you can try ideas without visitors noticing.
**Who can do this:** Owners and Admins (Editors through **Customize** on your help center) · **Plans:** All plans
## Open the template editor
1. In the left menu, click **Template editor**.

Your draft on the left, the settings on the right.
You can also start from your live help center. While you're signed in, it shows a small team toolbar in the bottom right corner:
1. Open the page you want to change, for example an article.
2. In the team toolbar, click **Customize**. The template editor opens on the settings for that page.

Customize opens the editor on the page you were looking at.
## Find your way around
- **The preview** on the left shows your draft the way visitors will see it. Above it, switch between **Desktop**, **Tablet** and **Mobile**, set **Appearance** to **Auto**, **Light** or **Dark**, and turn on **Select to edit** to change text right in the page. **Open in new tab** shows the preview at full size.
- **The top bar** holds **Exit** (back to your articles), the save status, the undo and redo arrows, **Reset draft** (the clock icon), **Publish** and a button that hides the settings panel.
- **The settings panel** on the right has seven tabs.
| Tab | Shortcut | What you do there |
| --- | --- | --- |
| **Brand** | ⌘1 | Site name, tagline, logo, dark-mode logo and favicon, plus SEO and social sharing settings. |
| **Theme** | ⌘2 | Colors for light and dark mode, fonts, density and corner radius. |
| **Theme gallery** | ⌘3 | Switch to one of 16 ready-made themes. |
| **Pages** | ⌘4 | The layout of each page and the components in it. |
| **Navigation** | ⌘5 | The links in your header and footer. |
| **Advanced** | ⌘6 | Custom CSS and scripts. |
| **Version history** | ⌘7 | Your earlier published designs, ready to restore. |
## Drafts and publishing
Every change saves to your draft automatically a moment after you make it. The top bar shows **Saving…** and then **All changes saved**.
- Visitors keep seeing your current design until you click **Publish**. Each publish becomes a restore point in **Version history**.
- Undo and redo step through your last 50 changes. The history starts fresh when you publish or reload the editor.
- **Reset draft** discards every unpublished change and takes your draft back to the live design. It can't be undone.
- An integration that uses an API key with design access works on this same draft. Its changes appear here for you to review, and they reach visitors only when the draft is published. See [Create an API key](https://self.helpcenter.io/content/create-an-api-key).
Your articles and categories aren't part of the design, so publishing a new design never changes them.
## Keyboard shortcuts
| Shortcut | What it does |
| --- | --- |
| ⌘S | Save the draft now |
| ⌘Z | Undo |
| ⌘⇧Z or ⌘Y | Redo |
| ⌘Enter | Open the publish dialog |
| ⌘\ | Hide or show the settings panel |
| ⌘1 to ⌘7 | Jump to a tab |
On Windows and Linux, use Ctrl instead of ⌘. While your cursor is in a text field, only ⌘S acts on the editor; ⌘Z undoes your typing in that field instead.
## A good first setup
1. Pick a starting design in **Theme gallery**. See [Choose a theme](https://self.helpcenter.io/content/choose-a-theme).
2. Add your name, logo and favicon in **Brand**. See [Add your logo, favicon and brand name](https://self.helpcenter.io/content/logo-and-brand).
3. Set your colors and fonts in **Theme**. See [Change colors, fonts and spacing](https://self.helpcenter.io/content/colors-and-fonts).
4. Arrange your pages in **Pages**. See [Add, move and remove components](https://self.helpcenter.io/content/components).
5. Add header and footer links in **Navigation**. See [Add links to your header and footer](https://self.helpcenter.io/content/navigation-links).
6. Check the result on a phone, a tablet and in dark mode. See [Preview on phones, tablets and in dark mode](https://self.helpcenter.io/content/preview-your-design).
7. Click **Publish**. See [Publish your design](https://self.helpcenter.io/content/publish-your-design).
## Troubleshooting
**Visitors don't see my changes.** Saved isn't the same as published. Click **Publish**, then refresh your help center. See [My changes don't show on my help center](https://self.helpcenter.io/content/changes-not-showing).
**"Save failed."** Click **Retry save**. If it keeps failing, check that **Site name** under **Brand** isn't empty: the draft can't save without a name.
**"This draft was changed elsewhere."** Someone else, or another browser tab, saved the same draft. Click **Reload** to load the latest version, or **Overwrite** to keep what you have in front of you.
**"Recover unsaved changes?"** Your last session ended before everything reached the server. Click **Recover changes** to bring those edits back, or **Discard** to keep the saved draft.
**I can't find Template editor in the menu.** It shows for Owners and Admins. Editors can use **Customize** on the help center. Translators and Viewers can't change the design.
## Related articles
- [Choose a theme](https://self.helpcenter.io/content/choose-a-theme)
- [Add, move and remove components](https://self.helpcenter.io/content/components)
- [Publish your design](https://self.helpcenter.io/content/publish-your-design)
- [Pages, regions and shared headers explained](https://self.helpcenter.io/content/pages-and-regions)
---
Source: https://self.helpcenter.io/content/logo-and-brand
# Add your logo, favicon and brand name
_Category: Design and templates_
Put your name and logo on your help center. Set the site name and tagline, upload your logo (plus a light version for dark mode) and add a favicon for browser tabs, all in the **Brand** tab of the template editor.
**Who can do this:** Owners and Admins (Editors through **Customize** on your help center) · **Plans:** All plans
## Add your name, logo and favicon
1. In the template editor, open the **Brand** tab (⌘1).
2. Enter your **Site name**. When you publish, this name is used everywhere your help center is named: on its pages, in the widget, in contact form emails and in the API.
3. Add a **Tagline** if you like. Your footer can show it next to your name.
4. Enter **Your main website**, for example https://example.com. Your logo can link there.
5. Under **Logo**, click **Upload** and choose your logo. A PNG or SVG works best.
6. Under **Dark-mode logo**, click **Upload** and choose a light version of your logo. Switch the preview's **Appearance** to **Dark** to check it.

Check your dark-mode logo with the Dark appearance.
1. Under **Favicon**, upload a 32×32 PNG or ICO file. It shows in browser tabs and bookmarks.
2. Click **Publish**.
## Image files
- You can upload JPEG, PNG, GIF, WebP, SVG and ICO files up to 10 MB.
- Click **Replace** to swap an image, or **Remove** to clear it.
- If you leave **Dark-mode logo** empty, your main logo shows in both light and dark mode.
- If you don't upload a logo, your site name shows as text in its place.
## Logo size
Your logo shows 32 pixels tall in the header, and its width follows its proportions. A file 32 to 48 pixels tall works well.
To show it bigger, add this custom CSS under **Advanced** → **Custom CSS**, then publish:
```
.hc-logo-img { height: 48px; }
```
See [Add custom CSS](https://self.helpcenter.io/content/custom-css) for how custom CSS works.
## Where your logo links
By default, your logo links to your help center's home page. To send visitors to your main website instead:
1. Make sure **Your main website** is filled in under **Brand**.
2. Open **Pages**, click the **Header** region and click **Logo**.
3. Set **Link target** to **Your main website**.
4. Click **Publish**.
In the same place, **Variant** switches between **Logo image** and **Brand name (text)**. If your header is synced across all pages, this changes the logo on every page. The label next to the component's name tells you: **All pages**, or one page, such as **Home only**. See [Pages, regions and shared headers explained](https://self.helpcenter.io/content/pages-and-regions).
## Search engines and social sharing
Further down the **Brand** tab you'll find the **SEO** and **Open Graph (social sharing)** settings: your default page title, meta description, the image shown when someone shares a link, and more. See [SEO settings for your help center](https://self.helpcenter.io/content/seo-settings).
## Troubleshooting
**"Unsupported image type. Upload a JPEG, PNG, GIF, WebP, SVG, or ICO image."** Save your logo in one of those formats and upload it again.
**"The image is too large. The maximum upload size is 10 MB."** Make the file smaller, for example by exporting it at a smaller size, and upload it again.
**"The SVG could not be sanitized safely."** Export the logo as a simple SVG or as a PNG, and upload that.
**My logo disappears in dark mode.** A dark logo on a dark background is hard to see. Upload a light version under **Dark-mode logo**.
**The logo still links to my help center.** Check both steps above: **Your main website** must be filled in, and the Logo's **Link target** set to **Your main website**.
**"Save failed" after I cleared the Site name.** Your help center needs a name. Enter one and the draft saves again.
## Related articles
- [Change colors, fonts and spacing](https://self.helpcenter.io/content/colors-and-fonts)
- [SEO settings for your help center](https://self.helpcenter.io/content/seo-settings)
- [Light and dark mode](https://self.helpcenter.io/content/dark-mode)
---
Source: https://self.helpcenter.io/content/choose-a-theme
# Choose a theme
_Category: Design and templates_
A theme restyles your whole help center in one step: colors, fonts, spacing and the layout of every page. You choose which parts to take from it, and nothing changes for visitors until you publish.
**Who can do this:** Owners and Admins (Editors through **Customize** on your help center) · **Plans:** All plans, with every theme included
## Apply a theme
1. In the template editor, open the **Theme gallery** tab (⌘3). The theme you use now is marked **Active**.
2. Click **Compare & apply…** on the theme you want.
3. In the dialog, untick every part you want to keep as it is now. The dialog lists only the parts that differ from your current design.

Untick the parts of your design you want to keep.
1. Click **Apply theme**. The preview switches to the new theme and shows your Home page.
2. Look through your pages. When you're happy, click **Publish**.

The new theme stays a draft until you publish.
Not sure which theme to pick? See [Which theme is right for you?](https://self.helpcenter.io/content/theme-gallery) or see screenshots of every theme at [helpcenter.io/knowledge-base-templates](https://helpcenter.io/knowledge-base-templates).
## Choose what to keep
Every part in the dialog starts ticked except **Brand**. A ticked part is replaced by the theme's version. Anything you untick stays exactly as you have it.
| Part | What applying it replaces |
| --- | --- |
| **Brand** | Your site name, tagline, logo, dark-mode logo and favicon. Themes come with a sample name and no logo, so leave this unticked unless you're starting from scratch. |
| **Colors (light)**, **Colors (dark)** | Your light and dark color palettes. |
| **Fonts**, **Corner radius**, **Density** | Your fonts, the roundness of corners and the spacing. |
| **Home page layout**, **Category page layout**, **Article page layout**, **Search page layout**, **Contact page layout**, **404 page layout** | That page's layout and every component on it, including its header, hero, footer and their texts. |
| **Navigation** | Your header and footer links. Some themes bring sample links, others none. |
| **Script injections** | Your scripts, such as analytics, chat and site verification tags. Most themes have none, so this removes yours. |
| **Meta** | Your SEO and social sharing settings from the **Brand** tab: default page title, meta description, keywords, **Hide from search engines (no-index)**, **Nofollow external links** and the Open Graph fields. |
| **Custom CSS** | Your custom CSS snippets, replaced by the theme's own CSS (or by none). |
**Keep what already works.** Untick **Script injections** to keep your analytics and chat, **Navigation** to keep your links and **Custom CSS** to keep your styling. Untick **Meta** to keep your SEO settings: applying it also turns off **Hide from search engines (no-index)** if you use it. Untick **Contact page layout** to keep your contact form: themes come with an empty recipient address, so applying it hides your contact page and any "Ask us" buttons until you add the address again.
Switching to Compass? Its light and dark switch and its search shortcut run as two scripts that come with the theme. They're added only if you leave **Script injections** ticked, which also replaces your own scripts, so add yours back under **Advanced** afterwards.
## Changed your mind?
Applying a theme isn't added to the undo history, so don't rely on ⌘Z to take it back. To return to your published design, click **Reset draft** (the clock icon in the top bar) and confirm. That also discards every other unpublished change, so publish the work you want to keep before you try a new theme.
If you already published the new theme, open **Version history** and restore an earlier version. See [Restore an earlier design](https://self.helpcenter.io/content/restore-a-design).
## Good to know
- Themes never touch your articles, categories or languages.
- Everything a theme sets stays editable afterwards: colors, fonts, pages and components.
- On a help center with one language, themes leave out their language switcher. Add it to your header once you add a second language.
- When your draft already has everything a theme would change, the dialog says "Your draft already matches this theme." and there's nothing to apply.
## Troubleshooting
**"Your latest edits could not be saved" when you click Apply theme.** The editor saves your draft before it applies a theme. Fix the save problem first (click **Retry save** in the banner at the top), then apply the theme again.
**My contact page disappeared.** You applied **Contact page layout**. Add your recipient email to the Contact form again. See [Set up your contact page and form](https://self.helpcenter.io/content/contact-form).
**My analytics stopped working.** You applied **Script injections**. Add your scripts again under **Advanced**. See [Add analytics and other scripts](https://self.helpcenter.io/content/scripts).
**My page title in search results changed.** You applied **Meta**. Set your title and description again under **Brand**. See [SEO settings for your help center](https://self.helpcenter.io/content/seo-settings).
## Related articles
- [Which theme is right for you?](https://self.helpcenter.io/content/theme-gallery)
- [Change colors, fonts and spacing](https://self.helpcenter.io/content/colors-and-fonts)
- [Publish your design](https://self.helpcenter.io/content/publish-your-design)
---
Source: https://self.helpcenter.io/content/components
# Add, move and remove components
_Category: Design and templates_
Components are the building blocks of your pages: the hero, the search bar, category grids, article lists, the contact form and more. Add them to any page, put them in the order you want and fine-tune each one.
**Who can do this:** Owners and Admins (Editors through **Customize** on your help center) · **Plans:** All plans
## Add a component
1. In the template editor, open the **Pages** tab (⌘4).
2. At the top, pick the page: **Home**, **Category**, **Article**, **Search**, **Contact** or **Not found**.
3. Under **Regions**, click where the component should go: **Header**, **Hero**, **Sidebar**, **Main**, **Footer** or **Utility**. The number on each region shows how many components it holds.
4. Click **Add component**.
5. In **Add a component**, search or browse the groups, then click the component you want. It's added at the end of the region and its settings open.
6. To get back to the region's list, click the region name at the top of the settings, for example **Main**.

Add a component, then move it into place.
The list only offers components that fit the page and region you picked. Some components can appear only once per region, such as the Search bar, Category grid, Logo and Footer. When the region already has one, it's dimmed and marked **Already added.**
On the Article page, the Main region is split into zones around the article, each with its own add button. See [Customize the article page](https://self.helpcenter.io/content/article-page).
## Move a component
- Click the up or down arrow on its row.
- Or drag it by the handle (⋮⋮) at the left of the row. With a keyboard, focus the handle, press Space to pick the component up, use the arrow keys to move it and press Space to drop it.
- A Hero or Container can hold other components. Drag components into or out of it, or click **Add inside Hero** (or **Add inside Container**) under its list.
If a component snaps back, the editor tells you why, for example "Only one of those is allowed per area" or "That component can't go inside this container."
## Edit, duplicate or delete
- Click a component's name to open its settings. They're grouped into cards such as **Content**, **Layout**, **Appearance**, **What to show** and **Behaviour**. The **Advanced** card starts closed.
- You can also turn on **Select to edit** above the preview and click the component there. See [Edit text right in the preview](https://self.helpcenter.io/content/edit-in-preview).
- The **⋯** menu on each row has **Edit options**, **Duplicate** and **Delete**. **Duplicate** puts a copy right below the original.
- When you delete, confirm with **Remove**. Changed your mind? Press ⌘Z.
## Width and position
- In the **Main** region, each component has a **Width**: **Full width** or **Half width**. Two half-width components next to each other share a row.
- **Logo**, **Navigation**, **Search bar** and **Language switcher** have a **Position**: **Own row (block)**, or inline on the left, in the center or on the right. Inline components next to each other share one row, which is how a header puts your logo on the left and your menu on the right.
## What you can add
| Group | Components | Learn more |
| --- | --- | --- |
| **Header & brand** | Logo, Navigation, Language switcher, Search bar | [Customize the header and footer](https://self.helpcenter.io/content/header-and-footer) |
| **Hero & layout** | Hero, Container, Spacer, Divider | [Customize the hero and search bar](https://self.helpcenter.io/content/hero-and-search) |
| **Categories & articles** | Category grid, Article list, Featured articles, FAQs, Content tree | [Customize category and article lists](https://self.helpcenter.io/content/category-and-article-lists) |
| **Article page** | Breadcrumbs, Table of contents, Article metadata, Export menu, Was this helpful?, Comments, Related articles, Recently viewed, Share buttons | [Customize the article page](https://self.helpcenter.io/content/article-page) |
| **Content & forms** | Rich text, Custom HTML, Contact form | [Set up your contact page and form](https://self.helpcenter.io/content/contact-form) |
| **Footer & social** | Footer, Social links | [Customize the header and footer](https://self.helpcenter.io/content/header-and-footer) |
| **Utility** | Custom script | [Add analytics and other scripts](https://self.helpcenter.io/content/scripts) |
| **Other** | Contact CTA | [Set up your contact page and form](https://self.helpcenter.io/content/contact-form) |
**Rich text** takes Markdown. **Custom HTML** takes your own HTML, but any scripts and styles in it are removed: add scripts under **Advanced** → **Script injections** and styles under **Advanced** → **Custom CSS**.
A header or footer that is synced across all pages shows a change on every page. While you edit a component there, the label next to its name says **All pages**, or names the one page your change reaches, such as **Home only**. See [Pages, regions and shared headers explained](https://self.helpcenter.io/content/pages-and-regions).
## Troubleshooting
**A component isn't in the list.** It doesn't fit the page or region you picked, or it's a one-per-region component that's already there. The Table of contents, for example, goes in the Article page's Sidebar or Utility region.
**A component shows in the preview but not on my help center.** Publish your design. Some components also stay empty until they have something to show: Navigation needs links in the **Navigation** tab, and the Contact form, plus any Contact CTA that points to your contact page, stays hidden until the form has a recipient email.
**I deleted the wrong component.** Press ⌘Z right away. Undo covers your last 50 changes until you publish or reload the editor.
## Related articles
- [Pages, regions and shared headers explained](https://self.helpcenter.io/content/pages-and-regions)
- [Edit text right in the preview](https://self.helpcenter.io/content/edit-in-preview)
- [Customize the article page](https://self.helpcenter.io/content/article-page)
- [Customize the hero and search bar](https://self.helpcenter.io/content/hero-and-search)
---
Source: https://self.helpcenter.io/content/pages-and-regions
# Pages, regions and shared headers explained
_Category: Design and templates_
Every page of your help center is built the same way: a layout, six regions, and the components inside them. Once you know which of these you're changing, you know exactly where the change will show.
**Who can do this:** Owners and Admins (Editors through **Customize** on your help center) · **Plans:** All plans
## Six pages
In the **Pages** tab, the page picker at the top switches between the six kinds of pages in your help center. Each has its own layout and components.
| Page | What visitors see there |
| --- | --- |
| **Home** | Your landing page. |
| **Category** | A category with its articles and subcategories. |
| **Article** | A single article. |
| **Search** | Search results. |
| **Contact** | Your contact form. |
| **Not found** | The page shown for a link that doesn't exist. |
## Six regions
Each page is divided into regions, and each region holds components in order. Click a region under **Regions** to see and change its components.
| Region | Where it appears |
| --- | --- |
| **Header** | The top of the page: logo, menu, search. Can be synced across all pages. |
| **Hero** | The banner under the header, usually with a heading and a search bar. |
| **Sidebar** | A column beside the main content, when the layout has one. |
| **Main** | The page's own content. On the Article page, this is where the article sits. Main is never shared between pages. |
| **Footer** | The bottom of the page. Can be synced across all pages, and usually is. |
| **Utility** | A narrow rail on the right in the Rail and Docked layouts. In the other layouts, it shows below the main content. |

Pick a region to see, add and arrange its components.
## Page layouts
Under **Page setup**, the **Layout** you choose applies to the current page only (it's marked **Affects this page**). It decides how the Sidebar, Main and Utility regions sit on a computer screen:
- **One column**: everything in a single column. Sidebar components stack above the main content.
- **Sidebar**: a sidebar column next to the main content.
- **Rail**: the sidebar, the main content and a Utility rail on the right.
- **Docked**: the sidebar is pinned to the edge of the screen and the content is centered beside it. On smaller screens, the sidebar opens from a **Browse** button.
For layouts with a sidebar, **Sidebar width** makes the column wider or narrower. On smaller screens, the columns stack so everything stays readable.
## Region settings
Open a region and expand its settings card (for example **Hero settings**, marked **Whole region**) to style the region as a whole:
- **Background**: a background color for the region.
- **Padding**: **None**, **Compact**, **Standard** or **Tall**.
- **Border below**: a divider line under the region.
- **Content alignment** (Hero only): **Left** or **Center**.
## Shared headers and footers
A header or footer can be synced: one version for the whole help center. Open the region, and the note at the top tells you how yours is set up:
- **Synced across all pages**: every page has the same version. Change it on any page, and every page gets the change.
- **Not the same on every page**: the region is set to sync, but some pages hold a different version. Until you choose what to do, an edit changes only the page you make it on.
- **Apply this header to other pages** (or footer): each page has its own version, and you edit each page separately.
A theme keeps a region synced only where its pages start out the same. Compass, for example, puts a search bar in the header of category and article pages only, so with Compass each page starts with its own header, while the footer is synced.
While you edit a component in one of these regions, a label next to its name shows how far your change reaches: **All pages**, or the name of the page, such as **Home only**.
### When pages differ
If the note says **Not the same on every page**, click **Choose**. The dialog marks each page as the same or **Different** (or **Different translations**) and gives you two choices:
- **Keep separate headers**: syncing stops. Every page keeps the header it has now, and you edit them one page at a time.
- **Use this header everywhere**: the header of the page you're on replaces the header on the other pages, translations included, and every page stays in sync from then on. You can undo it with ⌘Z.
**Decide later** closes the dialog and changes nothing. For a footer, the buttons name the footer instead.
### Stop syncing
To give each page its own header or footer, open a region that is synced, click **Manage** and choose **Give each page its own setup**. Each page keeps its current version, and from then on you edit each page separately.
## Use a region on other pages
The Hero, Sidebar and Utility regions belong to one page, and so does a header or footer that isn't synced. To reuse one elsewhere, open it and click **Apply this hero to other pages** (the name changes with the region). You get two choices:
- **Copy to other pages · one-time**: tick the pages you want and click the **Copy to** button, which counts the pages you picked. Each page gets its own copy, and later edits don't travel.
- **Keep in sync · live link**: click **Keep in sync everywhere**. The region becomes identical on every page, and later edits apply everywhere.
Both replace the region on the other pages, components and settings included, which is why the dialog warns **Will overwrite**. You can undo with ⌘Z. The Main region can't be shared, because it holds each page's own content.
## What changes where
| You change | Where it shows |
| --- | --- |
| **Brand**, **Theme**, **Navigation** or **Advanced** | Every page |
| A page's **Layout** | That page only |
| A region's settings or components | That page only, or every page if the region is synced |
| **Copy to other pages** | The pages you pick, once, as separate copies |
| **Keep in sync** | Every page, now and for later edits |
As always, nothing reaches visitors until you click **Publish**.
## Troubleshooting
**I changed the header on one page and it changed everywhere.** The header is synced. That's usually what you want. If a page needs its own header, use **Manage** → **Give each page its own setup**.
**I changed the header and the other pages didn't change.** The header isn't synced, or its pages differ. The label next to the component's name shows the page your change reached, such as **Home only**. To have one header everywhere, open the **Header** region on the page whose header you want and click **Choose** → **Use this header everywhere**, or **Apply this header to other pages** → **Keep in sync everywhere**.
**The search bar disappeared from my other pages' headers.** You synced the header from a page without a search bar, and that page's header replaced the others. Press ⌘Z, or add the search bar back on any page: the change syncs to all of them.
**My sidebar components show above the content.** The page uses the **One column** layout. Pick **Sidebar**, **Rail** or **Docked** to put them in a column.
## Related articles
- [Add, move and remove components](https://self.helpcenter.io/content/components)
- [Customize the header and footer](https://self.helpcenter.io/content/header-and-footer)
---
Source: https://self.helpcenter.io/content/hero-and-search
# Customize the hero and search bar
_Category: Design and templates_
The hero is the banner at the top of your home page, usually with a big question and a search bar. Change its words, background and height, and decide how its search bar behaves.
**Who can do this:** Owners and Admins (Editors through **Customize** on your help center) · **Plans:** All plans. The **Ask AI** button needs AI Answers (Catalyst plan, or the AI add-on on Bootstrap and Growth).
## Change the hero text
1. In the template editor, click **Select to edit** above the preview.
2. Click the hero's heading or subheading and type your new text.
3. Press Enter to keep it.

Click the heading in the preview and type.
1. For the other hero settings, click an empty part of the hero, away from the text. Its settings open in the panel on the right.
2. Click **Publish**.
You can also get there from **Pages** → **Home** → the **Hero** region → **Hero**. In **Heading** and **Subheading**, you can use a little HTML: `
` for a line break, `` for bold and `` for italic.
## Hero options
| Option | Choices |
| --- | --- |
| **Align** | **Left**, **Center** or **Right**. |
| **Height variant** | **Compact**, **Standard** or **Tall**. |
| **Background** | **Gradient**, **Solid** or **Image**. See below. |
| **Text color** | **Auto** picks light or dark text that reads well on the hero's background, separately for light and dark mode. **Light text** and **Dark text** force one color in both modes. |
### Backgrounds
- **Gradient** blends two colors. Choose a **Gradient style** (a two-color blend or a radial glow from a corner), set **Gradient from** and **Gradient to**, and pick a **Gradient angle**. Leave the colors empty to use your theme's Primary and Accent colors.
- **Solid** fills the hero with your theme's Primary color.
- **Image** shows a photo. Under **Background image**, click **Upload** for your own, or **Unsplash** to search free photos (the photographer's credit shows on the hero). **Cover enabled** darkens the image so text stays readable, and **Cover opacity** sets how much. **Background color** shows while the image loads and through transparent parts.
An image can't be measured for contrast, so with an image background set **Text color** to **Light text** or **Dark text** yourself, and check it with the preview's **Appearance** set to both **Light** and **Dark**.
To change the space around the hero or center everything in it, open the Hero region's settings card: **Background**, **Padding**, **Border below** and **Content alignment**.
## What goes inside the hero
A new Hero comes with a Search bar inside it. Click **Add inside Hero** to add more, such as a Rich text line, a Category grid, FAQs, a Container, a Spacer or a Divider. A Logo, Navigation or Language switcher placed inside the hero sits in a row across its top, over the background.
## Search bar options
Click the Search bar (inside the hero, or in your header) to open its settings:
| Option | What it does |
| --- | --- |
| **Placeholder** | The hint inside the empty field, such as "Search the help center…". |
| **Helper text** | A line under the field, for example a few popular topics. |
| **Size** | **Compact**, **Large** or **Custom**. With Custom, set **Field width (%)** and **Field height (px)**. |
| **Position** | **Own row (block)**, or inline so it shares a row with a logo or menu. |
| **Background mode** | **Solid**, **Translucent** (frosted over the hero) or **Transparent** (blends into the region with a thin outline). |
| **Corner radius (px)** | From square to fully rounded. |
| **Instant search** | Shows matching articles in a dropdown as visitors type. |
| **Results variant** | **Simple** shows article titles. **Detailed** adds a short snippet of each article. |
| **Show button** | Shows a search button. Visitors can always press Enter. |
| **Show "Ask AI" button** | Shows the Ask AI button for instant AI answers. It appears only when AI Answers is on. Turn it off to keep AI out of this search bar. |
See [How search works in your help center](https://self.helpcenter.io/content/how-search-works) for what search finds, and [Turn on AI Answers](https://self.helpcenter.io/content/ai-answers) to add AI.
## Container, Spacer and Divider
- **Container** is a box that holds other components, stacked or side by side. Set its **Box background** (none, surface, muted or your brand color), **Padding**, **Max width**, **Align** and **Direction**, then use **Add inside Container**.
- **Spacer** adds empty space. Pick a **Size** from Extra small to Extra large, or **Custom** for an exact **Height (px)** up to 400.
- **Divider** draws a line between two sections. It has no options of its own.
## Troubleshooting
**The hero text is hard to read on my photo.** Set **Text color** to **Light text** or **Dark text**, or turn on **Cover enabled** and raise **Cover opacity**.
**There's no Ask AI button.** AI Answers has to be on for your help center, and **Show "Ask AI" button** on in the Search bar. See [Turn on AI Answers](https://self.helpcenter.io/content/ai-answers).
**My changes aren't on my help center.** Click **Publish**. Changes stay in your draft until you do.
## Related articles
- [Edit text right in the preview](https://self.helpcenter.io/content/edit-in-preview)
- [Turn on AI Answers](https://self.helpcenter.io/content/ai-answers)
- [How search works in your help center](https://self.helpcenter.io/content/how-search-works)
---
Source: https://self.helpcenter.io/content/category-and-article-lists
# Customize category and article lists
_Category: Design and templates_
Decide how visitors browse your content: the grid of categories on your home page, lists of recent or hand-picked articles, your FAQs, and the list of articles on every category page.
**Who can do this:** Owners and Admins (Editors through **Customize** on your help center) · **Plans:** All plans
## Order the articles on category pages
1. In the template editor, open **Pages** and pick the **Category** page.
2. Find **Category articles** (marked **Built in**).
3. Under **Order articles by**, pick **Last updated**, **Create date**, **Alphabetically** or **Custom (drag to reorder)**.
4. Set the **Direction**: **Newest first** or **Oldest first**, or for Alphabetically, **A → Z** or **Z → A**. Alphabetically starts on Z → A, so switch it to A → Z if you want A first.
5. Click **Publish**.

Sort alphabetically, or follow your own order with Custom.
With **Custom (drag to reorder)**, the page follows the order you set by dragging articles on your Articles dashboard. See [Change the order of articles and categories](https://self.helpcenter.io/content/reorder-articles-and-categories).
## The rest of the category page
Every category page lists its own articles automatically. The **Category articles** settings style that list; it isn't a component, so you can't remove or move it.
- **Category image** (under **Category header**) shows the category's image or icon in front of its name.
- **List style**: **List** or **Block** cards, with **Columns** for Block.
- **What each item shows**: **Excerpt**, **Author**, **Last updated**, **Reading time** and **Leading icon**.
- **Card background** wraps the list in a card.
- **Separate FAQs** lifts FAQ-type articles into an accordion at the top of the page. With it off, **Expand FAQs** shows their answers right under their titles.
- **Show subcategories** lists each subcategory with its articles below the category's own. Set their **Layout** (**Stacked** or **Grid**), how many articles to **Show first** (3, 5, 8 or 10), whether "Show all" opens them in place (**Expand inline**), and whether to **Hide empty subcategories**. **Subcategory-only cards** decides how a subcategory that only holds other subcategories is shown: **Title only**, **Rows**, **Chips** or **Tree**.
## Category grid
The grid of categories you usually see on the home page. Add it to the Main or Sidebar region of the Home, Category, Search or Not found page.
- **Variant**: **Vertical cards**, **Horizontal (image beside text)**, **List**, **Minimal**, **Cards + top articles** or **Sections (grouped by parent)**.
- **Limit**: **All**, **3**, **6**, **9** or **Custom**.
- **Hide empty categories** leaves out categories with no published articles anywhere inside them.
- **What each item shows**: **Article count**, **Subcategories count**, **Description**, **Authors**, **Author avatars**, **Last updated** and **Browse link**.
- Depending on the variant: **Columns**, **Show image**, **Image size**, **Spacing**, **Full-width image**, **Centered**, **Articles per category** (Cards + top articles) and the section options (Sections).
Categories appear in the order of your category tree. Icons, images and descriptions come from each category's settings. See [Add a category icon, image and description](https://self.helpcenter.io/content/category-icons-and-images).
## Article list
A list of articles across categories, such as "Recent articles" or "Recently updated". Available on the Home, Category, Search and Not found pages.
- **Variant**: **List** or **Block** (cards, with 1 to 3 **Columns**).
- **Sort by**: **Most recently updated**, **Most recently added**, **Manual order (position)**, **Alphabetical (A → Z)** or **Reverse alphabetical (Z → A)**.
- **Limit**, **Heading**, **Heading icon** and **What each item shows**.
- For the List variant: **Show background**, and an option to show FAQ answers right under their titles.
## Featured articles
A short, hand-picked set of important articles. Available on the Home, Category and Search pages.
- Under **Featured articles**, search for articles and add them in the order you want. Leave it empty to show your most-viewed articles instead.
- **Variant**: **Cards grid** or **List**. Also **Heading**, **Heading icon** and **Limit**.
## FAQs
A list of questions and answers. Available on the Home, Category, Search and Not found pages.
- **FAQ section**: keep **Every FAQ article** to list all your published FAQ articles, or pick one of your FAQ sections. Owners and Admins can create one here with **New FAQ section**, then add questions by searching for articles.
- **Heading**, **Intro**, **Heading icon**, **Limit**, **Show background** and a leading icon for each question.
Adding or removing questions in an FAQ section takes effect right away, everywhere that section is used, without **Publish**.
To write FAQ articles, see [Write FAQs and add them to articles](https://self.helpcenter.io/content/write-faqs).
## Content tree
Your categories and articles as a tree readers can open and close, often placed in a sidebar. Available on every page except Contact.
- **Variant**: **Plain list** or **Icon tiles**. **Container**: **Card** or **Minimal**. **Density**: **Comfortable** or **Compact**.
- **What each item shows**: **Articles**, **Article count**, **Category icons** and **Highlight current**.
- **Max depth**, **Collapsible** and **Sticky** (keeps it in view as readers scroll).
## Search results
The Search page lists results by relevance. Its **Search results** settings (marked **Built in**) set their look:
- **Result style**: **List** or **Block** cards, with 1 to 3 **Columns** for Block.
- **What each result shows**: **Excerpt**, **Author**, **Last updated**, **Reading time** and **Leading icon**. With **Leading icon** on, pick the **Result icon** shown before each title.
- When you show the excerpt, **Excerpt text** picks either the **Matching text**, with up to 3 **Passages** per result, or the **Article opening**.
- **Card background** (List style only) wraps the results in a card.
## Troubleshooting
**My custom article order doesn't show.** Set **Order articles by** to **Custom (drag to reorder)** and publish. The order itself comes from your Articles dashboard.
**A category is missing from the grid.** Check the **Limit**, and whether **Hide empty categories** is on. Private categories show only to readers who have access to them.
**My changes don't show on my help center.** Click **Publish**. Your design changes stay in the draft until you do.
## Related articles
- [Change the order of articles and categories](https://self.helpcenter.io/content/reorder-articles-and-categories)
- [Add a category icon, image and description](https://self.helpcenter.io/content/category-icons-and-images)
- [Write FAQs and add them to articles](https://self.helpcenter.io/content/write-faqs)
---
Source: https://self.helpcenter.io/content/article-page
# Customize the article page
_Category: Design and templates_
The article page is where readers spend most of their time. Surround the article with what helps them: a table of contents, the author and date, ratings, related articles and more, placed exactly where you want them.
**Who can do this:** Owners and Admins (Editors through **Customize** on your help center) · **Plans:** All plans
## Add a component to the article page
1. In the template editor, open **Pages** and pick the **Article** page.
2. Under **Regions**, click **Main**. It's split into three zones: **Before the title**, **After the title** and **After the article**.
3. Under the zone you want, click its add button, for example **Add to "After the article"**.
4. Pick a component, for example **Was this helpful?** for ratings. It's added to that zone and its settings open.
5. Add any others the same way, then click **Publish**.

Add Was this helpful? and Comments, then publish.
To move a component within a zone or to another zone, drag it by its handle (⋮⋮). With a keyboard, focus the handle, press Space to pick it up, move it with the arrow keys and press Space to drop it.
The Sidebar and Utility regions work like any other region: click one and use **Add component**.
## Article page components
| Component | What readers get | Where it can go |
| --- | --- | --- |
| **Breadcrumbs** | A trail of links from your home page through the article's categories. It has no options of its own. Article and category pages already show this trail above the title, so adding the component there shows it twice. | Main, Header |
| **Table of contents** | Links to the article's headings. **Heading levels** sets how deep it goes (H2 only, down to H5), and **Sticky** keeps it in view as readers scroll. Sticky holds the whole column it sits in, so components beside it stay in view too, and the column stays put while any component in it keeps **Sticky** on. Components without a Sticky setting, such as the Export menu, always count as on. | Sidebar, Utility |
| **Article metadata** | The author, the last-updated date and the reading time, usually right after the title. See [Show or hide the author, date and reading time](https://self.helpcenter.io/content/article-metadata). | Main, Sidebar |
| **Export menu** | A **Copy page** button that copies the article as Markdown, with a menu of more ways to take the article away. See What the export menu offers, below. | Main, Sidebar |
| **Was this helpful?** | Rating buttons: thumbs up, heart and thumbs down, or thumbs only. Turn on **Ask for feedback** to ask for a comment after a thumbs down. | Main |
| **Comments** | A comment form under the article. Turn off **Show comments below the article** to collect comments without showing them. | Main |
| **Related articles** | Similar articles, chosen by **Default** (similar content), **Same category** or **Most recent**. | Main, Sidebar |
| **Recently viewed** | The articles this reader opened recently. | Main, Sidebar |
| **Share buttons** | Twitter, LinkedIn, Facebook, Email and Copy link, laid out **Horizontal** or **Vertical**. | Main, Sidebar |
In Main, you can also add general components such as Rich text, Custom HTML or a Divider. Set a component's **Width** to **Half width** to put two side by side, for example the article metadata next to the export menu.
For ratings and comments, including where you approve comments, see [Add ratings and comments to articles](https://self.helpcenter.io/content/ratings-and-comments).
## What the export menu offers
Readers click **Copy page** to copy the article as Markdown, ready to paste into an AI assistant or a document. The button reads **Copied!** when it's done. The arrow beside it opens the rest:
| Readers see | What it does | Its setting |
| --- | --- | --- |
| **Copy page** | Copies the article as Markdown. | **Copy page** |
| **View as Markdown** | Opens the article as plain text in the browser. | **View as Markdown** |
| **LLMs full** | Opens your whole help center as one Markdown file. It shows only while search engines are allowed to index your help center. | **LLMs full** |
| **Open in Claude**, **Open in ChatGPT** | Starts a chat that asks the assistant to read the article, so the reader can ask questions about it. Both show only on articles anyone can open without signing in. | **Open in Claude**, **Open in ChatGPT** |
| **Print article** | Opens the browser's print dialog. | **Print** |
| **Download PDF**, **Download Markdown** | Saves the article as a file. | **PDF**, **Markdown** |
| **Use with AI** | Opens the setup page of your public MCP server. It shows only while your help center has one. | **Use with AI** |
To choose what readers get, select the Export menu in the template editor and untick the actions you don't want. With **Copy page** unticked, readers see a single **Export** button that opens the menu. **Alignment** places the button on the left, in the center or on the right of its space.
The Markdown versions follow the same access rules as the page itself: a reader who can't open an article can't copy, view or download it either.
## Choose a layout
Under **Page setup**, pick the article page's **Layout**:
- **One column** keeps readers focused on the text.
- **Sidebar** adds a column beside the article, for example for a Content tree of all your categories.
- **Rail** adds a sidebar on one side and a Utility rail on the other, a good home for the table of contents.
- **Docked** pins the sidebar to the edge of the screen, like a documentation site. On smaller screens it opens from a **Browse** button.
On phones, the columns stack. A Content tree in the Sidebar and a Table of contents in the Utility rail each fold into a one-line bar (**Browse**, or the tree's heading, and **On this page**) that readers tap to open, so the article starts near the top of the screen. The table of contents bar sits above the article when the Utility rail holds only article navigation: the table of contents, the export menu, article metadata, share buttons, dividers or spacers. Add anything else to that rail, for example Related articles, and the whole rail stays below the article.
## A proven setup
Every article page already shows the breadcrumb trail and the article's category above the title. Build on that:
1. Article metadata after the title, with the Export menu beside it at half width.
2. A Content tree in the Sidebar and the Table of contents in the Utility rail, with the **Rail** layout.
3. Was this helpful? after the article, followed by Related articles.
4. Comments only if your team will read and answer them.
Check the result on a short article and a long one before you publish.
## Troubleshooting
**The table of contents doesn't show.** It's built from the article's headings, so articles without headings don't get one. It also needs to be in the Sidebar or Utility region. See [When does an article show a table of contents?](https://self.helpcenter.io/content/table-of-contents)
**All my share buttons disappeared.** Editing the **Channels** field can remove every share button today. Delete the Share buttons component and add it again to get all five back.
**Use with AI is missing from the export menu.** It shows only while your help center has a public MCP server. See [Let readers use your help center in their AI assistant](https://self.helpcenter.io/content/public-mcp-server).
**Open in Claude, Open in ChatGPT or LLMs full is missing.** The two assistant links show only on articles that anyone can open without signing in, on a help center that search engines may index. LLMs full needs the same indexing setting. Check also that the action is still ticked on the Export menu component.
## Related articles
- [Show or hide the author, date and reading time](https://self.helpcenter.io/content/article-metadata)
- [Add ratings and comments to articles](https://self.helpcenter.io/content/ratings-and-comments)
- [When does an article show a table of contents?](https://self.helpcenter.io/content/table-of-contents)
---
Source: https://self.helpcenter.io/content/header-and-footer
# Customize the header and footer
_Category: Design and templates_
Your header and footer frame every page: your logo, menu, search and language picker at the top, and your links, social icons and credits at the bottom. Set them up once and they show across your whole help center.
**Who can do this:** Owners and Admins (Editors through **Customize** on your help center) · **Plans:** All plans. The language switcher needs more than one language (Growth and Catalyst plans).
## Edit the header
1. In the template editor, open **Pages**, pick a page, and click the **Header** region. The note at the top of the region says whether your changes show on every page or on this page only (see "One header and footer for every page" below).
2. Click the component you want to change: **Logo**, **Navigation**, **Search bar** or **Language switcher**. Use **Add component** to add one that's missing.
3. Change its settings. Use **Position** to arrange the row (see below).
4. Click **Publish**.
### Header components
- **Logo** shows the logo or site name from the **Brand** tab. **Variant** picks **Logo image** or **Brand name (text)**, and **Link target** sends clicks to your **Help center home** or **Your main website**. See [Add your logo, favicon and brand name](https://self.helpcenter.io/content/logo-and-brand).
- **Navigation** shows the links you add in the **Navigation** tab. **Variant**: **Horizontal**, **Vertical (sidebar)** or **Pills**. See [Add links to your header and footer](https://self.helpcenter.io/content/navigation-links).
- **Search bar** lets visitors search from every page. See [Customize the hero and search bar](https://self.helpcenter.io/content/hero-and-search).
- **Language switcher** lets readers change language. **Variant**: **Dropdown** or **Inline list**. **Label style** shows the language's name, its name plus the native name, or its code. It lists your default language and every language with at least one published translation.
### Arrange the header row
Logo, Navigation, Search bar and Language switcher each have a **Position**: **Own row (block)**, or inline on the left, in the center or on the right. Inline components next to each other share one row, such as a logo on the left with the menu and language switcher on the right. In the region's list, they're grouped as **Inline row 1**, **Inline row 2** and so on.
## Edit the footer
1. In **Pages**, click the **Footer** region, then the **Footer** component.
2. Under **Footer columns**, click **Brand**, **Links**, **Text**, **Social** or **HTML** to add a column. Until you add one, the footer shows your site name, tagline and navigation links.
3. Click a column to fill it in. Reorder columns with the arrows, or remove one with the trash icon.
4. Set **Columns** to how many columns sit side by side on larger screens (1 to 4).
5. To hide "Powered by HelpCenter.io", open **Advanced** and turn off **Show attribution**.
6. Scroll the preview to the bottom to check your footer, then click **Publish**.

Edit the footer and turn off the attribution line.
| Column | What it holds |
| --- | --- |
| **Brand** | Your site name and tagline from the **Brand** tab. |
| **Links** | A **Column title** and a list of links. Each link goes to the **Home page**, a **Category**, an **Article** or an **External URL**. Click **Add link** for more. |
| **Text** | A **Column title** and a paragraph of text. |
| **Social** | Icons that link to your social profiles. Paste each profile's full link, and leave a field empty to hide its icon. |
| **HTML** | Your own HTML for the column. |
Removing the attribution works on every plan. See [Remove "Powered by HelpCenter.io"](https://self.helpcenter.io/content/remove-powered-by).
## Social links
For a row of social icons outside the footer columns, add the **Social links** component to your footer, header or Utility region. Fill in the networks you use (Twitter, LinkedIn, GitHub, Facebook, Instagram and YouTube) with your handle, such as company/acme for LinkedIn, or paste your profile link. Each icon always links to that network's own site, and empty fields don't show.
## One header and footer for every page
A region marked **Synced across all pages** is the same everywhere: a change you make on one page shows on every page. Footers usually start synced. Headers start synced only where the theme gives every page the same header. Compass, for example, adds a search bar to the header of category and article pages, so each page starts with its own header.
While you edit a component, the label next to its name shows how far the change reaches: **All pages**, or one page, such as **Home only**.
- To sync a region whose pages are separate, open it on the page whose version you want, click **Apply this header to other pages** and then **Keep in sync everywhere**.
- If the region says **Not the same on every page**, click **Choose**, then **Keep separate headers** or **Use this header everywhere**. Until you choose, an edit changes only the page you make it on.
- To stop syncing, click **Manage** and choose **Give each page its own setup**.
Syncing replaces the region on the other pages with the one you're looking at. You can undo it with ⌘Z. See [Pages, regions and shared headers explained](https://self.helpcenter.io/content/pages-and-regions).
## Troubleshooting
**The menu in my header is empty.** The Navigation component shows the links from the **Navigation** tab. Add your links there.
**The language switcher is missing.** It needs a second language with at least one published translation. On a help center with one language, themes leave it out: add it with **Add component** once you have a second language.
**My header change shows on one page only.** The header isn't synced, or its pages differ. Make the change on each page, or sync the header first (see "One header and footer for every page" above).
**Syncing the header removed something from my other pages.** The page you synced from had a different header, and it replaced the others. Press ⌘Z, or add the missing component back: the change syncs to every page.
**A block I added to the Compass header is squeezed in beside the logo.** Compass now gives each block you add to the header a line of its own: above the logo row when you place it before the Logo, below it when you place it after the search and other tools. Help centers that applied Compass before this change keep the theme's earlier Custom CSS. To get the new behavior, open **Theme gallery**, click **Compare & apply…** on Compass, untick everything except **Custom CSS** and click **Apply theme**, then publish. This replaces the CSS under **Advanced** → **Custom CSS** with the theme's, so copy any CSS you added yourself first and paste it back afterwards.
**My logo links to the help center, not my website.** Fill in **Your main website** under **Brand**, and set the Logo's **Link target** to **Your main website**.
## Related articles
- [Add links to your header and footer](https://self.helpcenter.io/content/navigation-links)
- [Remove "Powered by HelpCenter.io"](https://self.helpcenter.io/content/remove-powered-by)
- [Pages, regions and shared headers explained](https://self.helpcenter.io/content/pages-and-regions)
---
Source: https://self.helpcenter.io/content/navigation-links
# Add links to your header and footer
_Category: Design and templates_
Add links to your header and footer so readers can reach your main website, your status page or your contact page from anywhere in your help center. You keep them in one list, and your header menu and footer share it.
**Who can do this:** Owners and Admins (Editors through **Customize** on your help center) · **Plans:** All plans
## Add a link
1. In the left menu, click **Template editor**, then open the **Navigation** tab.
2. Click **Add link**. A link called "New link" appears at the end of the list.
3. Type a **Label**: the text readers see.
4. Enter the **URL**: a path on your help center that starts with `/`, such as `/categories`, or a full address that starts with `https://`.
5. Pick a **Kind**: **Internal link**, **Category** or **External link**.

The new link appears in the preview's header as you type.
1. Check the link in the preview, then click **Publish**. Readers see it once you publish.
## Which kind to pick
| Kind | Use it for |
| --- | --- |
| **Internal link** | A page of your help center, such as `/categories` (all topics) or `/contacts` (your contact page). |
| **Category** | One of your categories. Open the category on your help center and copy the part of its address after your domain, for example `/category/12-billing`. |
| **External link** | Another website, such as your product or your status page. In your header menu it opens in a new tab. |
The easiest way to get an internal path right is to open the page on your live help center and copy what comes after the domain in the address bar. On a help center with several languages, paths that start with `/` keep the reader's language automatically.
## Reorder, edit or remove links
- Use the up and down arrows on a link to change its place in the list. Your menu shows the links in this order.
- Edit any field in place. Changes show in the preview right away.
- Click the trash icon to remove a link. Changed your mind? Press ⌘Z (Ctrl+Z on Windows).
## Translate link labels
On a help center with more than one language, the Navigation tab shows an **Editing texts in** bar. Pick a language, then type the translated **Label** for each link. The URL is shared by every language.
## Style one link with a CSS class
Want your "Contact support" link to look like a button? Type a class name in **CSS class (advanced)**, such as `support-cta`, without a leading period. The class is added to that link in your header menu, so you can target it from **Advanced** → **Custom CSS**. The [Custom CSS reference](https://self.helpcenter.io/content/custom-css-reference) has a ready-made example.
## Where your links appear
- **In the header:** wherever a page has a **Navigation** component. Most themes include one in the header. Its settings let you show the links as **Horizontal**, **Vertical (sidebar)** or **Pills**.
- **In the footer:** the **Footer** component lists them in a "Links" column until you give the footer columns of your own. After that, add links to a Links column in the Footer instead.
- **Contact links** (anything that points to `/contacts`) stay hidden while your contact page is off. The page switches on when your contact form has a recipient email.
A link to a private category doesn't make it public: readers who can't see the category still can't open it.
## Troubleshooting
**Your link doesn't show in the header.** Your header has no Navigation component. Compass, the theme new help centers start with, doesn't include one. Open **Pages**, pick the **Header** region, click **Add component** and pick **Navigation**, then publish. The label next to the component's name shows how far the change reaches. If it names one page, such as **Home only**, the header isn't shared between pages: add Navigation on each page where you want the menu. In Compass, each page starts with its own header, because the Category and Article pages also have a search bar there. See [Pages, regions and shared headers explained](https://self.helpcenter.io/content/pages-and-regions).
**Your link doesn't show in the footer.** Your Footer uses its own columns (Compass's does). Add the link to a Links column in the Footer. See [Customize the header and footer](https://self.helpcenter.io/content/header-and-footer).
**The Contact link disappeared.** Your contact page is off. Add a recipient email to your contact form and publish. See [Set up your contact page and form](https://self.helpcenter.io/content/contact-form).
**The link leads to a "not found" page.** Check the URL. Internal paths start with `/` and must match an address on your help center; copy it from your browser's address bar.
**The preview is right but your help center isn't.** Click **Publish**. Saved changes stay in your draft until you do.
## Related articles
- [Customize the header and footer](https://self.helpcenter.io/content/header-and-footer)
- [Set up your contact page and form](https://self.helpcenter.io/content/contact-form)
- [Add, move and remove components](https://self.helpcenter.io/content/components)
- [Custom CSS reference: selectors and examples](https://self.helpcenter.io/content/custom-css-reference)
---
Source: https://self.helpcenter.io/content/preview-your-design
# Preview on phones, tablets and in dark mode
_Category: Design and templates_
See how your design looks on a phone, on a tablet and in dark mode before readers do. The preview shows your draft, updates as you edit, and changes nothing on your live help center.
**Who can do this:** Owners and Admins (Editors through **Customize** on your help center) · **Plans:** All plans
## Switch the device and the appearance
1. In the left menu, click **Template editor**.
2. In the bar above the preview, click **Mobile** for a phone-sized screen (390 × 844), or **Tablet** (820 × 1180). **Desktop** takes you back to full width.
3. Click **Dark** to see dark mode, or **Light** for light mode. **Auto** follows your own device's setting.

These switches change only the preview, never your design.
Layouts adapt to smaller screens by themselves: a sidebar moves above the main content, the right-hand rail moves below it, and a docked sidebar turns into a **Browse** button that opens it as a drawer.
## Preview other pages
- The label **Previewing:** at the right end of the bar above the preview names the page you're looking at.
- To switch pages, pick one in the **Pages** tab, or click a link in the preview, such as a category card.
- The preview uses your real content. The Article page shows your most recently updated published article, the Category page shows one of your categories, and the Search page lists your most recently updated articles. Type a search into the preview's search box to see real results.
- On a help center with several languages, pick a language in the menu next to **Select to edit** to see your translations. The language you edit texts in switches with it.
## Open the preview in a new tab
Click **Open in new tab** to see the current page at full size, without the editor around it. It shows your last saved draft, so wait until the top bar says **All changes saved** first.
The link works for team members who can edit your help center, while they're signed in. It isn't a way to share a draft with customers: they see your design once you publish.
## What to check
- Long names: your site name, category names and article titles.
- The header menu wrapping on narrow screens.
- Cards that get too narrow, and images wider than the page.
- Tables and code blocks: they should scroll sideways inside their box, not push the page.
- Buttons and links that are big enough to tap.
- In dark mode: text you can read, visible borders, your logo, images with transparent backgrounds, and custom CSS with fixed colors. See [Light and dark mode](https://self.helpcenter.io/content/dark-mode).
- Your longest translation, if you have more than one language.
## Edit straight from the preview
Click **Select to edit**, then click any part of the preview to open its settings. You can also change headings and other texts right where they are. See [Edit text right in the preview](https://self.helpcenter.io/content/edit-in-preview).
## Troubleshooting
**The new tab shows an older version.** It shows the last saved draft. Wait for **All changes saved**, then reload the tab.
**Your change shows in the preview but not on your help center.** Previews show your draft. Click **Publish** to put it live. See [Publish your design](https://self.helpcenter.io/content/publish-your-design).
**The contact form's button does nothing.** Forms don't send from the preview. Test them on your live help center after you publish.
## Related articles
- [Light and dark mode](https://self.helpcenter.io/content/dark-mode)
- [Publish your design](https://self.helpcenter.io/content/publish-your-design)
- [Edit text right in the preview](https://self.helpcenter.io/content/edit-in-preview)
---
Source: https://self.helpcenter.io/content/publish-your-design
# Publish your design
_Category: Design and templates_
Everything you change in the template editor saves to a draft as you work, and only your team can see it. Readers keep seeing your current design until you publish, and then all your changes go live together.
**Who can do this:** Owners and Admins (Editors through **Customize** on your help center) · **Plans:** All plans
## Publish your changes
1. Make your changes in the template editor. The top bar shows **Saving…** and then **All changes saved**.
2. Click **Publish**, or press ⌘Enter (Ctrl+Enter on Windows).
3. In the **Publish changes** dialog, check the list of what changed, such as **Colors (light)**, **Page: Article** or **Custom CSS**.
4. Optionally, write a **Version note** (up to 300 characters) that says what changed. Your team sees it in **Version history**.
5. Click **Publish**.

A short version note makes the history easy to scan later.
Your live help center switches to the new design right away, and a message confirms it.
## What publishing does
- **It publishes the whole draft.** Every unpublished change goes live, including changes your teammates made in the same draft. Check the list in the dialog before you confirm.
- **It creates a restore point.** Each publish is saved in **Version history**, so you can go back later. See [Restore an earlier design](https://self.helpcenter.io/content/restore-a-design).
- **It updates your brand name everywhere.** The **Site name** under Brand also names your help center in the widget, contact form emails and the API, and those follow the published design.
- **It starts a fresh draft.** You can keep editing straight away. Nothing you change reaches readers until your next publish.
## Save status
| Top bar says | What it means |
| --- | --- |
| **All changes saved** | Your draft is stored. Safe to close the editor. |
| **Unsaved changes** | You made an edit. It saves a moment later, or right away if you press ⌘S (Ctrl+S). |
| **Saving…** | Your draft is being stored. **Publish** waits until it's done. |
| **Draft conflict** | Someone else changed the same draft. See Troubleshooting below. |
| **Save failed** | Your last change couldn't be stored. See Troubleshooting below. |
## Undo, redo or start over
- **Undo** and **Redo** in the top bar step through your last 50 changes: ⌘Z to undo, ⌘⇧Z or ⌘Y to redo (Ctrl on Windows). The history clears when you publish or reload the editor.
- Applying a theme can't be undone step by step. Use Reset draft instead.
- **Reset draft** (the clock icon in the top bar) throws away every unpublished change and takes your draft back to the published design. Click it, then confirm **Reset draft**. This can't be undone.
Keyboard shortcuts pause while you're typing in a field, so ⌘Z there undoes your typing instead.
## Troubleshooting
**"This draft was changed elsewhere."** A teammate, or you in another tab, saved the same draft. Click **Reload** to pick up their changes, or **Overwrite** to keep yours and replace theirs.
**"Save failed."** The message says what went wrong, for example an empty **Site name**. Fix it, then click **Retry save**. Publishing is blocked until the save works, so you never publish an outdated draft.
**"Recover unsaved changes?"** Last time, you left before some changes reached the server. Click **Recover changes** to add them to your draft, or **Discard** to keep the saved copy.
**Your help center still shows the old design.** Check that you clicked **Publish** in the dialog, not only saved. Then wait a moment and reload the page. See [My changes don't show on my help center](https://self.helpcenter.io/content/changes-not-showing).
## Related articles
- [Restore an earlier design](https://self.helpcenter.io/content/restore-a-design)
- [Preview on phones, tablets and in dark mode](https://self.helpcenter.io/content/preview-your-design)
- [My changes don't show on my help center](https://self.helpcenter.io/content/changes-not-showing)
---
Source: https://self.helpcenter.io/content/scripts
# Add analytics and other scripts
_Category: Design and templates_
Add analytics, chat and verification code to every page of your help center, or only to the pages that need it. You add scripts in the template editor, and they go live when you publish.
**Who can do this:** Owners and Admins (Editors through **Customize** on your help center) · **Plans:** All plans
## Add a script
1. In the left menu, click **Template editor**. Open the **Advanced** tab and scroll to **Script injections**.
2. Click **External script**. (For code you paste in, or a whole HTML tag, see the types below.)
3. In **Source URL**, replace the `https://` that's already there with the script's full address.
4. Choose where it loads: **Start of **, **End of **, **Start of