Categories
To create and manage categories:
Click the New Category button.
Enter a name and description (both are required, especially for public sites).
The category will appear in the left menu. Hover over its title to reveal a three-dot icon for additional options.
Once added, the category will appear in the left menu. Hovering over its title will reveal a three-dot icon on the right .
Fields / Functions | Description |
---|---|
Edit | Edit the name and description of the category |
Move | Move the category and the articles to another Docs site |
Delete | Deletes the category |
Create Article | Creates an article for the selected category |
Articles
Each article is tied to a category and contains:
Title & Subtitle: Displayed prominently at the top.
Body: The main content, placed beneath the title and subtitle.
You can style and format your content using various tools.
Toolbar
The toolbar can either be pinned to the top of the article or displayed inline, providing a range of formatting options:
Pinned Toolbar: Displays all available functions. It is white and located at the top of the article.
Inline Toolbar: Shows only essential options. It is black and appears within the text.
Pinned Toolbar (white)
The toolbar remains fixed at the top of the article.
Pinned toolbar at the top
Functions | Description |
---|---|
Style | Change the text format to HeadingSubheadingNormal Small |
Bold | Change the text format to bold (and backward) |
Italic | Change the text format to italic (and backward) |
Underline | Change the text format to underline (and backward) |
Font Color | Change the color of the font |
Bullet List |
|
Ordered List |
|
Text Alignment | Align the text Align Left Align Center Align Right |
Code Block | Enter some code as block or inline |
Quote |
|
Add Link | Add a link |
Horizontal Rule | Add a dividing line |
Add Image | Upload an image by file or URL |
Add Embed | Embed different things
|
Table | |
Search Docs | |
orPin / Unpin Menu to top | Shows the toolbar on the top or inline |
If you create or edit a table, you get an additional row of table tools.
Functions | Description |
---|---|
Delete Table | Deletes the marked table |
Add Column Before | Adds a column before the marked column |
Add Column After | Adds a column after the marked column |
Delete Column | Deletes the marked column |
Add Row Before | Adds a row before the marked row |
Add Row After | Adds a row after the marked row |
Delete Row | Deletes the marked row |
Toggle Cell Merge | Merges the marked cells |
Background Color | Changes the background of the marked cell(s) |
Inline Toolbar (black)
The toolbar is displayed within the article where the cursor is. It also appears when the text in the article is highlighted.
Undo and Redo
You may want to undo or redo while you write an article. Therefore, we have two keyboard shortcuts:
Undo:
⌘ Z
Redo:
⌘ ⇧ Z
Focus Mode
Focus mode presents just the article content, removing menus and extra details. Its purpose is to ensure users concentrate solely on the text.
To activate focus mode, click the icon at the article's top right
Click on the X to exit the mode
Sort mode
To arrange articles:
Click the 'Sort Mode' button found at the bottom of the Doc menu.
Icons with three lines will appear next to categorize and articles.
Drag and drop them to reorder.
Click the 'Sort Mode' button again to exit.
Visibility
To publish or unpublish articles, click the Visibility button on the top right.
If the site is public (see settings), the article will appear online. A green toggle indicates a published article.
To unpublish, click the toggle until it turns red.
When editing a published article, a note with a yellow background reading “This document contains unpublished changes” will appear at the top.
To make edits public, click Publish Changes.
To discard changes, click the dropdown arrow on the button and choose Discard Changes.
Custom Slug
Standard URL:
When you create an article, HelpSpace automatically generates a standard URL. This URL includes the article ID, a forward slash (“/“), and the title.
Example:https://supportcenter.helpspace.com/en/article/560/create-categories-and-edit-articles
Customize Your URL:
You can personalize the URL with a custom slug to better match your needs. Simply enter your desired URL.
Example:https://supportcenter.helpspace.com/en/categories-articles
The original standard URL will automatically redirect to the custom URL.
Redirects
You can add additional URLs to redirect to the article. This is useful for scenarios such as:
Redirecting older articles to this one.
Updating URLs after changes like switching to multiple languages.
How to set up redirects:
Click the edit icon on the right.
Add new URLs or remove outdated ones.
Votes
Enable article ratings in the settings to allow readers to provide feedback. This feature is available exclusively in the Help Center style. Rating results can be viewed for each article.
Tags
Tags help categorize articles and improve navigation. They appear on the frontend, allowing visitors to click on them to find related articles.