Docs

Getting Started

Quickstart

Get a docs site live in a few minutes.

1. Create a project

Sign in to the console and create a docs project. Your site gets a yourdocs.stipple.wiki address immediately.

2. Connect your repository

Under Git, install the Stipple GitHub App and pick the repository your docs live in. Point Stipple at the folder that holds your markdown — docs/ by default.

3. Add a docs.json

A single file in your docs folder names the site and defines navigation:

{
  "name": "Acme",
  "nav": [
    { "group": "Getting Started", "pages": ["introduction", "quickstart"] }
  ]
}

4. Push

Commit and push to your default branch. Stipple builds the site, the full-text search index, the sitemap, and llms.txt from that commit. The build typically completes in well under a minute.

5. Visit your site

Open https://yourdocs.stipple.wiki. Every future push updates it automatically — there is no publish button to remember.

Next: serve the site from your own domain.