Docs Introduction

Hoss docs feature lets users document product or API using Markdown files.

For API & tech companies, docs is one of the first touch point for their developers. Therefore docs is essential in building an amazing developer experience. Hoss docs make it easy to build best in class docs experience quickly

It supports

• Extends with custom react components
• Versioning
• I18N
• Statically compiled for blazing fast site
• Developer satisfaction embedded to collect feedbacks

Install

Docs module is enabled by default when running @hoss/init with the default template

Document ID

Every document has a unique id. By default, a document id is the name of the document (without the extension) relative to the root docs directory.

For example, greeting.md id is greeting and guide/hello.md id is guide/hello.

website # Root directory of your site
└── docs
├── greeting.md
└── guide
└── hello.md

However, the last part of the id can be defined by user in the front matter. For example, if guide/hello.md's content is defined as below, its final id is guide/part1.

---
id: part1
---
Lorem ipsum

If you want more control over the last part of the document URL, it is possible to add a slug (defaults to the id).

---
id: part1
slug: part1.html
---
Lorem ipsum