Skip to content
Docs Template

Use this template

Setting up takes a site to deploy to, a token for CI, and two settings on the repository.

1. Copy the repository

Section titled “1. Copy the repository”

Press Use this template on GitHub and create your repository. It starts with this site in it.

2. Create a site and a token

Section titled “2. Create a site and a token”

Install the One9x CLI and sign in, if you haven’t:

Terminal window
curl -fsSL https://get.one9x.com | sh
one9x login

Then create the site the docs will live on, and a token for GitHub Actions:

Terminal window
one9x pages create mydocs
one9x tokens create "github actions"

The site name becomes your address, mydocs.one9x.app. The token is printed once — copy it now. You can do both from the dashboard at portal.one9x.com instead, if you prefer.

3. Add two settings to the repository

Section titled “3. Add two settings to the repository”

In your new repository, open Settings → Secrets and variables → Actions:

Kind Name Value
Variable ONE9X_SITE mydocs — the site you just created
Secret ONE9X_TOKEN the token from step 2

Until ONE9X_SITE exists the deploy job is skipped, not failed, so a fresh copy does not start with a red X.

4. Push

Section titled “4. Push”

Any push to main builds the site and publishes it at https://mydocs.one9x.app/. Open a pull request and the workflow stages a release instead, and comments its preview URL on the pull request.

Work on it locally

Section titled “Work on it locally”
Terminal window
npm install
npm run dev

The site is at http://localhost:4321/ and reloads as you edit.

Deployed on One9x Pages