Docs Site Playground

Publish your first site

Last updated

On this page

Put it all together. This page tests an include of another page's section, links into other pages at a heading, and a doc card for a page in the site.

Step 1: sign in#

The steps below come straight from the Installation page, included rather than copied, so they stay in step with it:

Sign in#

Shell
acme login --workspace my-team

Note

The login opens your browser. If it can't, the CLI prints a link to open by hand.

Tip

Run acme doctor at any time to check your setup.

Important

You need the Publish docs sites permission to publish. Ask a workspace admin if you don't have it.

Warning

Signing in on a shared computer leaves a token in your home folder. Run acme logout when you're done.

Caution

Never commit .acme/credentials.json to Git. It grants full access to your workspace.

Step 2: check your settings#

Go back over the config file and the full list of settings. If you skipped installing, start at Install the CLI.

The Configuration page as a card:

Configuration

Step 3: publish#

Shell
acme publish

The site builds the release and waits. Open the preview, check it, then make it live:

Shell
acme preview --open
acme publish --make-live

What success looks like#

✔ Built release 1 (12 pages)
✔ Preview: https://acme.prismdocs.page/_preview?token=…
✔ Release 1 is live at https://acme.prismdocs.page