Quickstart

Sambadocs turns a GitHub repository of Markdown into a hosted documentation site. Point it at a repo, and every push publishes — no build config, no CI to wire up, no separate hosting to manage.

This guide takes you from zero to a live docs site.

1. Connect your repository

Sign in, then connect a repo through the GitHub App. You choose exactly which repositories Sambadocs can see — it never gets blanket access to your account. The full walkthrough lives in Connect your GitHub repo.

2. Add a docs.json

docs.json at the root of your repo tells Sambadocs what your site is called and how the pages are organized into the sidebar:

{
  "name": "Acme Docs",
  "navigation": [
    {
      "group": "Getting started",
      "pages": ["introduction", "quickstart"]
    }
  ]
}

Each entry in pages is the path to an .mdx file (without the extension), relative to the repo root. That's the whole config for a basic site — you add groups and pages as your docs grow.

3. Write a page

Pages are plain MDX: Markdown, plus a small set of components for callouts, tabs, and code. Frontmatter sets the page title and description:

---
title: Introduction
description: What Acme is and why you'd use it.
---
 
Welcome to Acme. This guide walks you through the basics.

4. Push, and you're live

Commit and push to your default branch. Sambadocs builds the site and publishes it — typically within seconds — at your project's URL (your-project.sambadocs.com, or a custom domain on Pro).

Where to next

• Connect your GitHub repo — the connection flow in detail, including how builds trigger on each push.
• Prefer not to write everything by hand? The built-in AI editor can draft whole pages from your repo and keep them current.