Content structure

Table of Content

Each space can contain as many pages as you need to write your documentation. All these pages are visible on the left side of your screen in what we call the Table of Content.

From the Table of Content you can manage your pages: create new pages, group of pages, add external links, add a variant, import external docs like websites or files that are Markdown (.md or .markdown), HTML (.html), Microsoft Word (.docx).

Structuring your content

There are 3 different types of entries for the Table of Content.

Initial Page

The initial page is the homepage or the root of your documentation and basically works as the master of all the pages of your documentation.

Note: Because it is the main entry of your documentation and of your space, this page can't be moved, deleted, have children or be under a group.

Pages

A page has a title, an optional description on the top of the editor. You can then write and add any kind of content to it.‌

You can nest pages by dragging and dropping a page below an other. The children of a page will be hidden but can be collapsed.

Tips: There is no theoretical limit to page nesting. But we advise to avoid adding more than 3 levels of nesting.

You can change the title and the slug of a page anytime just by clicking on the ... button next to the page title in the Table of Content.

Groups

Groups are created to bring pages together and for you to create "sections" of pages dealing with the same subject.

Note: Groups can only live at the top level of the Table of Content. You cannot nest groups inside groups.

You can change the title and the slug of a group page anytime just by clicking on the... button next to the group title in the Table of Content.

Tips: You can also drag and drop groups to move them in the Table of Content.

These entries are external links and do not have any content in the editor. Their main function is to link to external websites.

Variants

You can create an alternative content to your documentation by creating a variant. This can be useful to document multiple versions of an API, a library, or translations. You can read more about it in here.