Pages & Structure

Organize your documentation with a clear, hierarchical structure.

Creating Pages

Each page in AlgoQuill is a Markdown or MDX file. You can create pages via the web editor or locally with the CLI.

Page Properties

Every page has the following properties:

• Title - The page title shown in navigation
• Slug - The URL path (e.g., /getting-started)
• Content - Markdown/MDX content
• Status - Draft or Published
• Position - Order in navigation

Navigation Structure

Pages are organized in a tree structure. The sidebar navigation is automatically generated from your page hierarchy.

docs/
├── introduction.mdx        → /docs
├── quickstart.mdx         → /docs/quickstart
├── guides/
│   ├── getting-started.mdx → /docs/guides/getting-started
│   ├── authentication.mdx  → /docs/guides/authentication
│   └── deployment.mdx      → /docs/guides/deployment
└── api/
    ├── overview.mdx        → /docs/api/overview
    └── endpoints.mdx       → /docs/api/endpoints

Page Frontmatter

Add metadata to your pages using YAML frontmatter:

---
title: Getting Started
description: Learn how to get started with our API
icon: rocket
---

# Getting Started

Welcome to the getting started guide!

Available Frontmatter Options

Reusable Snippets

Create reusable content snippets that can be included across multiple pages.

<Tabs>
  <Tab title="npm">
    ```bash
    npm install @company/sdk
    ```
  </Tab>
  <Tab title="yarn">
    ```bash
    yarn add @company/sdk
    ```
  </Tab>
</Tabs>

## Installation

<Snippet file="install.mdx" />