Introducing Docs

How to create a knowledge base

By Stefan
April 2, 2020

In today's digital age, every project requires some form of documentation, blog, or help center to provide customers or visitors with the information they need. HelpSpace Docs allows you to create a help center and a blog for your product, offering various site styles to meet your needs.

Site Styles Offered

We provide three modern site styles that suit every requirement:

  1. Help-Center: The classic knowledge base, e.g.,
    https://supportcenter.helpspace.com/

  2. Documentation: Perfect for a structured page or API documentation, e.g.,
    https://documentation.helpspace.com/

  3. Blog: Ideal for keeping your audience up to date.
    https://blog.helpspace.com/

Each style can be customized to match your corporate identity.

Accessing Your Site

Each site has its subdomain. You can choose a subdomain like your-product.helpspace-docs.io or use a custom domain such as docs.your-domain.com.

For each Docs site, you can set up a custom domain:

Site Visibility

To make a site visible to your customers, toggle the visibility switch in the settings. By default, new sites are not visible and are behind a login screen.

Bildschirmfoto-2020-03-03-um-01.45.29.png

Branding Your Site

Customizing your site to fit your brand identity is simple. You can easily change the logo and colors within the site settings.

Writing Experience

Our primary focus is to provide a distraction-free writing experience to enhance productivity and content quality. The editor is clean and minimalistic, with a “focus mode” Bildschirmfoto-2020-03-03-um-00.23.16.png that highlights the editor above everything else.

The toolbar offers numerous options for formatting and styling your article, including:

  • Style text

  • Adding images

  • Embed video, iFrame, or HTML

  • Create a table

  • Link to other Docs Articles

toolbar

Add tags to articles

You can add tags to your articles and your users can filter categories by tags.

Sorting Content

Clicking the 'sort mode' button enables drag handles behind each article and category, allowing you to organize your content easily. The button is on the underneath of the articles.

docs-sort-mode.png

Mobile Performance

We prioritize fast performance on both desktop and mobile devices, ensuring a seamless experience.

docs-page-speed-optimized.png

Browser Reader Mode

HelpSpace Docs fully supports reader mode for all major browsers.

Was this article helpful?

Thanks for your feedback!