Octri

docs theme

Prints every appearance setting your project has set. 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 appearance.

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

octri docs theme set key=value …

Changes one or more settings and keeps the rest. 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.

The API ignores a key it doesn't know rather than failing, so the command compares what it sent with what was saved and names any key that was dropped. A typo can't pass for a save.

Arguments

key=valuestringrequired

One or more settings.

ValueMeaning
primaryColor logoUrl logoUrlDark logoHref showLogo faviconUrlBrand
colorScheme showThemeToggleLight and dark
layout contentWidth borderRadiusLayout
fontFamily headingFont codeFont googleFontFamily googleHeadingFont googleCodeFontFonts
sidebarTextSize contentTextSize codeTextSizeText size
navbarLayout navbarSurface navbarColor navbarColorDark searchPlacementTop bar
sidebarStyle sidebarWidth sidebarResizable showSidebarLines showSidebarIconsSidebar
codeTheme codeThemeDark showToc showGuideTocCode and outline
repoUrl repoStarsEnabledRepository link

Examples

Show appearance

bash
octri docs theme
Output
✔ Loading theme

Docs appearance
  borderRadius       default
  codeFont           jetbrains-mono
  codeTextSize       smaller
  codeTheme          octri
  colorScheme        system
  contentTextSize    large
  contentWidth       default
  customCss          not set
  faviconRasterUrl   not set
  faviconUrl         not set
  fontFamily         manrope
  googleCodeFont     not set
  googleFontFamily   not set
  …

Change several settings

bash
octri docs theme set primaryColor=#ff6a00 colorScheme=dark codeTheme=nord