Appearance
Naming Conventions
Files and folders
- Use lowercase kebab case for Markdown files.
- Keep folder names short and semantic.
- Use
index.mdfor section landing pages. - Put reusable examples in
templates.
Page titles
- Use sentence case for page titles.
- Keep titles specific.
- Match the title to the page's intent.
Headings
- Use one
h1per page. - Use
h2for major sections. - Use
h3for subtopics only when needed.