Any Markdown file can become documentation. There are three ways in:
- New docs site → Markdown files makes a new site from the files.
- Upload (the arrow at the top of the page list) adds pages to an existing site.
- Drop
.mdfiles on the page list, or anywhere on the Studio's home page.
You can choose files or a whole folder. .md, .mdx, .markdown and .txt files up to 400 KB are read; anything else is skipped.
How files become pages
| In the file | On the site |
|---|---|
The first # Heading |
The page title (and removed from the text, so it is not shown twice). Without one, the file name is used. |
| The first paragraph | The description, unless the front matter has one. |
README.md or index.md |
The home page, when README.md replaces the home page is on. |
A file in a sub-folder, such as guides/install.md |
A page in the Guides section. |
The file name, such as install.md |
The page address, install. |
Front matter
Front matter at the top of a file sets the details exactly:
---
title: Install the CLI
description: One line under the title
section: Get started
slug: install
---
The page text starts here.One page per heading
Turn on One page per “##” heading to split long files. Every ## section becomes its own page in a section named after the file (or the front matter's section), and ### headings move up one level.
Tip
This is the quickest way to turn a long README into tidy docs: import it with splitting on, then reorder or rename the pages.
Export and import back
Settings → Download .md saves every page in one file, each with its front matter. Importing that file again recreates the pages (the home page too, if README.md replaces the home page is on), so it also works as a backup or to move pages between sites.