Writing Docs

Pagemark uses standard GitHub Flavored Markdown with optional frontmatter.

Frontmatter

Add YAML frontmatter at the top of any .md file to control metadata:

---
title: My Page Title
description: A brief description for search
order: 3
---

Markdown Features

Everything you'd expect from GitHub Flavored Markdown:

Text Formatting

Bold, italic, strikethrough, inline code, and links.

Code Blocks

// Syntax highlighting works automatically
function greet(name) {
  console.log(`Hello, ${name}!`);
}

greet("world");

# Python works too
def fibonacci(n):
    a, b = 0, 1
    for _ in range(n):
        yield a
        a, b = b, a + b

list(fibonacci(10))

Tables

Task Lists

• Write documentation
• Push to GitHub
• Take over the world

Blockquotes

Note: Blockquotes are great for callouts and tips.

Warning: You can nest them and use bold for labels.

Images

Reference images from your repo or use external URLs:

![Alt text](./images/screenshot.png)
![Logo](https://example.com/logo.png)

File Organization

Your folder structure becomes your navigation:

docs/
├── index.md           → /
├── getting-started.md → /getting-started
├── guide/
│   ├── writing-docs.md → /guide/writing-docs
│   └── themes.md       → /guide/themes
└── api/
    ├── overview.md     → /api/overview
    └── endpoints.md    → /api/endpoints

Folders become sections in the sidebar. Files become pages. The order frontmatter field controls sort order within each section.