Quickstart

Go from zero to a running documentation site in under five minutes.

1. Install Oxidoc

curl -fsSL https://oxidoc.dev/install.sh | sh

See Installation for other options.

2. Create a Project

oxidoc init my-docs
cd my-docs

This creates a directory with a starter oxidoc.toml, a home.rdx landing page, and a docs/ directory with sample content.

3. Start the Dev Server

oxidoc dev

Open http://localhost:3000 in your browser. You'll see the starter site with a landing page and sample documentation.

The dev server watches for changes and rebuilds automatically:

• .rdx files in all content directories
• oxidoc.toml configuration
• assets/ directory (custom CSS, images, JS)
• Root-level .rdx files (home.rdx, etc.)

4. Edit Content

Open docs/quickstart.rdx in your editor and make a change. Save the file — the browser refreshes automatically.

RDX files are Markdown with embedded components. For example:

---
title: Introduction
---

# Introduction

Welcome to my docs. Here's a tip:

<Callout kind="tip" title="Hot reload">
Edit any `.rdx` file and the browser refreshes automatically.
</Callout>

See Writing Content for the full guide on RDX syntax.

5. Add a New Page

Create a new file docs/guide.rdx:

---
title: Guide
---

# Guide

Your content here.

Then add it to the navigation in oxidoc.toml:

navigation = [
  { path = "/docs", dir = "docs", groups = [
    { group = "Getting Started", pages = ["quickstart", "guide"] },
  ] },
]

Save the file and the dev server rebuilds automatically — the new page appears in the sidebar.

6. Build for Production

oxidoc build

The output is a fully static site in dist/. Deploy it to any static host — see Deployment for guides on GitHub Pages, Vercel, and Netlify.

Next Steps