Skip to content
These are the docs for Clay 3.x. Go to the latest version (5.x)
More ways to use this page

Organizing

How pages and folders become navigation, how folders get their pages, and how clay edit keeps it all in order.

Clay builds the sidebar from your files: every folder in docs/ is a section, every Markdown file a page. You decide names, icons and order in front matter, or let clay edit do it for you.

If you want to … Read
Understand the sidebar, breadcrumbs and previous/next links Navigation
Name a folder, give it an icon or put it in order Folders
Write an introduction for a folder, or the start page Index Pages
Create, reorder, rename or move pages without touching files by hand Editing with clay edit

#Key ideas

  • The file tree is the navigation. Move a file, and it moves in the sidebar.
  • order puts entries in order. Entries without it follow alphabetically.
  • A folder’s index.md describes the folder. Its front matter names it; its text, if any, is the folder’s page.

In this section