Pinnate Docs

GitHubApp

SDK and CLI embeds

Embed generated SDK or CLI documentation in a site.

SDK

- name: SDKs
  slug: sdks
  sdk: payments-sdk

Resolves by id, slug (preferred), or name.

CLI

- name: CLI
  slug: cli
  cli: payments-cli

Resolves by id or name.

Tips

  • Publish a successful SDK/CLI build before embedding

  • Keep getting-started narrative in Markdown; leave generated reference to the embed

  • Nest under a group when the top nav is crowded

See SDKs and CLIs.