Your folder structure becomes your site structure. No configuration required.
Note
Do I need this? Yes when planning site structure, menus, or content types. Skip if you only write single pages in an existing scaffold — see Writer Quickstart instead.
The Three Content Types
A single.mdfile → a single HTML page.
content/
└── about.md → /about/
Use for: standalone pages like About, Contact, Privacy Policy.
A folder with_index.md→ a list page with children.
content/
└── blog/
├── _index.md → /blog/ (list page)
├── post-1.md → /blog/post-1/
└── post-2.md → /blog/post-2/
Use for: blog posts, documentation chapters, any collection.
A folder withindex.md→ a page with co-located assets.
content/
└── gallery/
├── index.md → /gallery/
├── photo-1.jpg (co-located asset)
└── photo-2.jpg (co-located asset)
Use for: pages with images, data files, or other assets that belong together.
Quick Reference
| Pattern | File | Creates | Assets |
|---|---|---|---|
| Page | name.md |
Single page | Usestatic/ |
| Section | name/_index.md |
List + children | Usestatic/ |
| Bundle | name/index.md |
Single page | Co-located |
Tip
Key difference:_index.md creates a section (with children). index.mdcreates a bundle (with assets). The underscore matters!
Advanced: Nesting and Cascades
Sections can nest to any depth:
docs/
├── _index.md
├── getting-started/
│ ├── _index.md
│ └── installation.md
└── advanced/
├── _index.md
└── plugins.md
Configuration cascades from parent to children:
---
title: Docs
cascade:
type: doc
toc: true
---
All pages under docs/ inherit type: doc and toc: trueunless they override it.
Seealso
- Component Model — Understanding type, variant, and props
- Frontmatter Reference — All frontmatter fields
- Menu Configuration — Navigation menus