Getting Started
Managing Users
Logging In To Your HelpDocs
Setting the URL Style for your Articles
Understanding Smart 404 Pages
Setting Up a Custom Domain
The HelpDocs Trial
Adding or Changing Your Profile Image
Switching Between Multiple Accounts
Understanding Top Articles
Writing and Editing Articles
Stale Articles
Text Editor
Content Blocks
Using Quote Blocks
Inserting Videos
Using Markdown Blocks
Embedding Audio Files
Using Code Blocks
Adding an HTML Block
Getting Started with Content Blocks
Adding Note, Tip, and Warning Callouts
Switching the Editor Mode
Adding Tags to Articles
Using Ordered Lists
Managing Clips
Adding GIFs to Articles
Unassigned Articles Category
Understanding Article Statuses
Moving an Article to a Different Category
Text Editor Shortcuts
Article Backups, Revisions, and Versioning
Inserting Images into Ordered Lists
Previewing Articles
Linking to a Part of an Article
Hiding Articles from Public Search Engines
Editing Images
Understanding Search Results
Delete a Category
Hidden Categories
Creating a Subcategory
Adding a Table of Contents
Exporting & Backing Up Your Articles
Filtering Articles
Downloading Articles to PDF
Featuring an Article
Restoring Deleted Articles
Creating Draft Versions of Published Articles with Working Copy
Bulk Select & Edit Multiple Articles
What is Readability?
Incompatible Browser Extensions
Collaborating on Articles with Presence
Editing Category Metadata
Setting Up Integrations
Front Integration
Slack Integration
Available Commands in Your Slack Workspace
Get Feedback, Activity, and Contact Form Notifications in Slack
Sharing Articles From HelpDocs to Slack
Configuring Your Slack Integration
Installing the Slack Integration
Intercom Integration
Drift Integration
Chrome Extension
Connecting Kommunicate
Connecting Hyperping
Using HelpDocs with Ticketing Systems
Adding Hotjar
Connecting Lucidchart
Adding a Feedier Carrier
Connecting Google Analytics
Connecting Segment
Connecting Chatra
Connecting Smooch
Connecting Statuspage
Connecting Gorgias
Connecting Crisp
Connecting Belco
Syncing Content to elevio
Connecting GoSquared
Connecting Gainsight PX
Connecting LiveChat
Adding FullStory
Enabling Comments with Disqus
Connecting Doorbell
Customizing your HelpDocs
Code Snippets
Disabling Authorship and Updated Times
Overriding the Font on Your Knowledge Base
Customizing Feedback Icons
Getting Help with Code Snippets
How to Change the Logo Link
Add HTML Before the Closing Body Tag
Using Different List Styles
Using HelpDocs with RTL Languages
Disabling Related Articles
Making Your Printed HelpDocs Look Nicer
Making Video Embeds Responsive
Adding Lightboxes to Images
Disabling Top Articles
Making Tables Scroll When They're Too Wide for the Page
Using a Background Image in the Header
How to Add Extra Spacing
Custom HTML Templates
Adding Cookie Consent
Adding Custom Navigation Links
Setting a Custom Favicon
Hiding the Contact Button
Changing the Language in Common Phrases
Setting Article Display Order
Setting Category Display Order
Adding Custom JavaScript
Adding Custom CSS
Uploading Your Brand Logo
Featuring a Category
Customizing an Article Slug, Meta Description & Short Version
Adding Icons to Categories
Understanding the Contact Form
Hosting HelpDocs at a Subfolder of Your Site
Adding an Open Graph Fallback Image
Adding URL Redirects
Choosing a Template
Multilingual Translation
Automatically Translate Articles with Machine Translations
Setting Up Multilingual Docs
Translating Your Docs
Permissioning
Removing Permission Groups from Articles
Assigning Permission Groups to Articles
Assigning Default Permission Groups to Categories
Creating and Managing Permission Groups
Getting Started with Permissioning
Authentication
Restricting Your Docs to Logged In Users
Shared Password Protection
Restricting Your Docs by IP
Configuring Slack Single Sign On
Accessing User Data in HelpDocs
Using OpenID Connect for Single Sign On
Setting Up and Using SAML Single Sign-On
Restricting your HelpDocs with Custom JWT SSO
Data & Analytics
Getting Team Event History with Audit Trail
Search Click Analytics
What is the Happiness Score?
Exporting Your Stats
Filtering Analytics
What are Tickets Avoided?
Lighthouse
Lighthouse Widget API
Adding Lighthouse Trigger Buttons to Webflow
Installing Lighthouse
Understanding Lighthouse
Billing
Changing Your Plan
Invoices and Email Receipts
Updating Your Billing Information
Subscribing to a Plan for the First Time
Cancelling Your Account
Tax Residency Certificates and Forms
European Union VAT Charges
FAQs
Can I migrate or import my data from another service?
Can I embed files into HelpDocs?
My article has a blank space to the left of it. What's wrong?
Can I use multiple HelpDocs accounts together?
Can I change the HelpDocs branding?
One of my headings isn't showing in the table of contents
I’m seeing a blank screen when I load my knowledge base
I've added a script but it isn't working
Who counts towards the user limit on plans?
Is my data secure and protected?
How do I reset my password?
Help! My app's not loading 😭
Help! No articles are appearing on my knowledge base
I can't log into my HelpDocs account
What is an account slug?
Can I host my API docs in HelpDocs?
How do related articles work?
Can I host my internal docs in HelpDocs?
Is HelpDocs GDPR compliant?
How do I change my email?
Will translated articles be deleted if I remove that language?
Guides
Finding CSS Selectors in Your Browser
Optimizing Your Knowledge Base for Search
Clearing the Cache in Your Browser
Creating a Knowledge Base from Scratch
Writing Clear and Digestible Knowledge Base Articles
Resources
Table of Contents
- Knowledge Base
- Writing and Editing Articles
- Exporting & Backing Up Your Articles
Exporting & Backing Up Your Articles
At HelpDocs we take regular backups of all your data, so you don't need to worry.
That said, if you need a copy of your data for any reason, it's super easy to grab it from our API.
Exporting as JSON
The HelpDocs API is the most flexible way to export data. You can query articles by category, and even select which fields you'd like to view. You can learn more about the API in our API docs.
Downloading a CSV File
If you want to grab a quick copy of all your articles to use as a spreadsheet, or import to another piece of software, a CSV is the answer.
- Head to Settings > Migrations
- Under Export, click Download CSV
The CSV will contain the following columns:
article_id | category_id | title | description | text | body | tags | is_published | is_private | show_toc | editor_type | user_id | author_name | url | relative_url | is_stale | stale_reason | stale_source | stale_triggered_at | updated_at | created_at |
Downloading a ZIP File
You can export your categories and articles to a .zip file and it'll sort them out into folders for you, with metadata included as .yaml files.
- Head to Settings > Migrations
- Under Export, click Download ZIP
Exporting to Google Sheets
Creating a Google Sheet of your articles is just as simple.
- Head to Settings > API Keys and create an API key
- Create a new Google Sheet
- In the top left cell, type =IMPORTDATA("https://api.helpdocs.io/v1/article?format=csv&key=your_api_key")Don't forget to replace your_api_key in the link above with the API key you just created.
- Hit Return
- Save your new sheet
Google will pull all your articles from the HelpDocs API and display them in your sheet.