Octri

docs seo

Prints your site's search and social settings, such as its meta title and whether search engines may index it. 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. See SEO.

bash
octri docs seo [show | set key=value …]

octri docs seo set key=value …

Changes one or more settings. Values are text, except true and false, which turn something on or off. @ reads a value from a file, as in css=@docs.css. A dotted key sets one field inside another, as in defaultAuth.type=bearer. As with appearance, the command names any key the API didn't keep.

Arguments

key=valuestringrequired

Such as metaTitle="Acme API" or indexable=true.

Examples

Show SEO settings

bash
octri docs seo
Output
✔ Loading seo

Docs SEO
  enabled          on
  indexable        on
  keywords         not set
  metaDescription  not set
  metaTitle        not set
  ogImageUrl       not set
  titleMode        dynamic
  titleTemplate    not set
  twitterHandle    not set
  octri docs seo set key=value …
  • octri docs theme: Read and change appearance: colours, logo, fonts, layout and code themes.
  • SEO