Customizing your HelpDocs

Code Snippets

We get asked about customizing HelpDocs a lot, and our Engineers love to help. Here's some of the common CSS and JavaScript snippets we get requests for.

author avatar author avatar
17 docs by 2 team members

Custom HTML Templates

Wanna go crazy and customize everything? Use HTML and Handlebars to create a custom template for your docs.

author avatar
2 docs by 1 team member

​Changing the Language in Common Phrases

If you're looking to support non-English and international customers with HelpDocs, you can change the contents of strings to match the language. 🌍

River Sloane
Updated 1 month ago by River Sloane

​Setting Article Display Order

There's a few different ways to set the order that articles appear on your HelpDocs: Alphabetical, Created Dated, Last Updated, Random, or Custom.

Taylor Sloane
Updated 2 years ago by Taylor Sloane

​Hosting HelpDocs at a Subfolder of Your Site

By default HelpDocs comes with a subdomain and a custom domain. If you need to, it's possible to host your HelpDocs at a subfolder of your own domain, and there's a couple ways to do that.

Taylor Sloane
Updated 2 years ago by Taylor Sloane

​Choosing a Template

HelpDocs ships with a bunch of different layouts so you're bound to find something you love. 💖

Taylor Sloane
Updated 2 years ago by Taylor Sloane

​Testing Customizations with .dev

Customize the look and feel of your docs without breaking anything in production with .dev.

River Sloane
Updated 2 years ago by River Sloane

Understanding the Contact Form

You can't cover every question your customers might have in your HelpDocs. That's where the Contact Form comes in. 📮

Taylor Sloane
Updated 2 weeks ago by Taylor Sloane

Hiding the Contact Button

When you sign up to HelpDocs, you'll automatically be given a contact button in the upper-right-hand side of the header. If you don't need it, you can remove it in a jiffy.

River Sloane
Updated 2 years ago by River Sloane

Customizing an Article Slug, Meta Description & Short Version

When you first get started writing your articles, you'll notice a lot of the advanced stuff is automatically done for you. However, if you're a whizz and want to customize the way things are displayed on your knowledge base, you can!

Taylor Sloane
Updated 2 years ago by Taylor Sloane

Adding Custom CSS

When you set up your HelpDocs account, you'll have the option to choose your layout and customize things like the logo and brand color. If you're looking to customize the layout even further, you can add custom CSS.

Taylor Sloane
Updated 2 years ago by Taylor Sloane

Adding Custom Navigation Links

Your help documentation is an important part of your site, but sometimes you'll want to add links to other places. HelpDocs makes it easy to add custom navigation links to the header.

Taylor Sloane
Updated 2 years ago by Taylor Sloane

Setting a Custom Favicon

Favicons let your users easily identify your website from the URL bar. It's like a teeny little version of your logo that browsers show you occasionally. HelpDocs lets you add a custom one. ✨

Taylor Sloane
Updated 2 years ago by Taylor Sloane

Setting Category Display Order

There's a few different ways to set the order that categories appear on your HelpDocs: Alphabetical, Created Dated, Last Updated, Random, or Custom.

Taylor Sloane
Updated 2 years ago by Taylor Sloane

Uploading Your Brand Logo

You'll want to make your help documentation look like part of your own site. Adding your brand logo to your HelpDocs is super easy. ✨

River Sloane
Updated 2 years ago by River Sloane

Adding URL Redirects

Over time, it's normal for links to change. But sending a customer to a 404 error page isn't the best experience (although ours are pretty cool!). With HelpDocs, you can redirect your customers to a new URL so they find what they're looking for right away.

Taylor Sloane
Updated 2 years ago by Taylor Sloane

Featuring a Category

Featuring is a great way to promote your best and most important categories in HelpDocs. Here's how to feature them.

Taylor Sloane
Updated 2 years ago by Taylor Sloane

Adding Icons to Categories

HelpDocs ships with the ability to choose from a library of icons and easily add them to your categories.

River Sloane
Updated 2 years ago by River Sloane

Adding an Open Graph Fallback Image

Open Graph protocol makes links on social look great. HelpDocs automatically pulls the first image from an article and uses it as the Open Graph image. You can add a Fallback Image for when there are no images in the article.

River Sloane
Updated 2 years ago by River Sloane

Adding Custom JavaScript

Brand settings just not enough and wanna go even further to make it your own? Know a little JavaScript? With HelpDocs you can add as many custom scripts as you like.

Taylor Sloane
Updated 2 years ago by Taylor Sloane

Adding Cookie Consent

No doubt you've seen Cookie Consent banners around the web in the last few years. They give visitors a heads up users about being tracked. HelpDocs comes with the ability to enable a cookie consent b…

River Sloane
Updated 2 years ago by River Sloane

Get in touch

This site is protected by hCaptcha and its Privacy Policy and Terms of Service apply.