Skip to content

Organize Markdown pages and create useful examples.

Writing content

Create .md files in content/. Use frontmatter for page metadata and nested folders to keep guides, tutorials, and reference material organized.

text
content/
├── guide/
│   ├── getting-started.md
│   └── writing-content.md
└── reference/
    └── api.md

Page metadata

md
---
title: API authentication
description: Configure a token for your first request.
---

# API authentication

The title appears in the page navigation and search results, while the description provides a short summary. The homepage lives in app/pages/index.vue; the guide and reference pages remain Markdown under content/.

Add helpful context

Use callouts to make important context easy to scan:

Keep secrets out of Markdown

Use environment variables for credentials. Content files are versioned with your source code and may be published with the site.

Use fenced code blocks for commands and examples. Group alternatives with ::SCodeGroup and add a filename or language label to each fence:

const client = createClient({ token: process.env.API_TOKEN })

Markdown tables, lists, links, and headings work as usual. The docs shell builds a contents outline from page headings and handles navigation. The examples below show a few reusable ways to present documentation content. For the landing page, see the homepage hero patterns.

Link cards

Guides

Organize instructions into short, task-focused pages.

Read the getting started guide →

Reference

Use structured pages for endpoint details and response examples.

Browse the API reference →

Guided steps

Add a Markdown file

Create a page under the content directory.

Write the page

Add frontmatter, headings, examples, and links.

Publish your docs

Build the site and deploy it to your preferred host.

Step 1 of 3

File tree

# Welcome

Start here.