GUIDE · 01

Getting Started

A typical subpage demonstrating the layout, typography, navigation, and page index.

Start with the content

Write the page as if it were a well-edited note. Begin with the answer or central idea, then add supporting details. Avoid decorative elements that compete with the text.

Use clear headings

Break longer pages into meaningful sections. Each h2 automatically appears in the right-hand page index when you add the matching link.

Short sections work well

A heading should help the reader scan the page. If a section becomes very long, consider giving it a more specific heading or splitting it into two sections.

Use lists when appropriate

  1. State the goal.
  2. Explain the important steps.
  3. Show an example.
  4. End with the next useful action.
  • Keep list items concise.
  • Use parallel wording.
  • Do not turn every paragraph into a list.

Add a note when something deserves attention

Tip

Keep important advice visually distinct, but use callouts sparingly. If everything is highlighted, nothing is highlighted.

Code and technical details

Inline code looks like search-index.json. Longer examples can use a simple code block:

const pages = await fetch("search-index.json");
const index = await pages.json();

What's next?

Use this page as the template for additional content. Copy the sidebar and page shell, change the content and title, then add the new page to search-index.json.