Octri

docs buttons

Lists the buttons at the right of your top bar, up to three, with each one's style and address. There's no draft: a change is live on your docs site as soon as the command returns, the same as saving in API Studio.

bash
octri docs buttons [list | add <label> <url> | remove <label>]

octri docs buttons add <label> <url>

Adds a button, or updates the one with the same label.

Arguments

<label>stringrequired

The button's text.

<url>stringrequired

Where it links.

Flags

--style <style>stringdefault: plain

How it looks.

ValueMeaning
plainA text link
outlineAn outlined button
primaryA filled button in your brand colour

octri docs buttons remove <label>

Removes the button with that label.

Arguments

<label>stringrequired

The button's text.

Examples

Add a sign-up button

bash
octri docs buttons add "Sign up" https://acme.com/signup --style primary
Output
✔ Saving nav buttons
✔ Sign up is in the nav. Buttons go live on save.

List buttons

bash
octri docs buttons
Output
✔ Loading nav buttons

Nav buttons (1 of 3)
  LABEL       STYLE    URL
  ──────────  ───────  ───────────────────────
  Sign up     primary  https://acme.com/signup