Authoring

Everything ShellDocs asks of you as an author lives here : the frontmatter fields, the fenced-code conventions, how to drop a live component demo mid-page, how the sidebar decides where things go.

The one-minute overview

A ShellDocs page is a .md file under content/. Drop one in, it appears in the sidebar automatically : no registration, no import, no meta.json edit required.

---
title: My Page
description: What this page is about.
order: 3
---

# My Page

Regular markdown. Fenced code blocks:

```csharp
var x = 1;
```

Inline components mid-prose:

<Callout Variant="tip">Something worth calling out.</Callout>

Live component demos:

```razor:preview
<Button Variant="primary">Click me</Button>
```

That's the whole surface area for authoring.

Anatomy of a page

Where pages live

Every .md under content/docs/** becomes a page. The URL is derived from the folder path:

Seeing your edits

Run the site with shelldocs dev (or dotnet watch run).

• Editing an existing page shows on the next browser refresh. Pages are rendered from disk on each request.
• Adding, renaming or deleting a page, or editing a meta.json, changes the navigation graph, which is built when the app starts. Restart the dev server to pick those up.
• Editing .razor or .cs files goes through hot reload as in any Blazor app.

Where to go next