Octri

docs guides

Guides are the pages you write, as opposed to the ones generated from your spec. On its own, this command lists them, with each one's ID, which the other subcommands and docs home set take. See writing guides.

bash
octri docs guides [list | show <guideId> | publish <guideId>]

octri docs guides show <guideId>

Prints one guide: its title, then its content as Markdown, the draft if there is one.

Arguments

<guideId>stringrequired

The guide's ID.

octri docs guides publish <guideId>

Publishes the guide's draft, so readers see it. See drafts and publishing.

Arguments

<guideId>stringrequired

The guide's ID.

Examples

List guides

bash
octri docs guides
Output
✔ Loading guides

Guides (0)
  No guides.
  • octri docs pages: List, regenerate, retitle and publish the endpoint pages generated from your spec.
  • octri docs home: Choose the guide served at the root of your docs site.
  • octri github docs: Pull your repository's Markdown files, or keep page drafts in sync with them.