Pinnate Docs

GitHubApp

Embeds

Embed API reference, SDK docs, or CLI docs in a site.

Embed sections render live product UIs inside the docs shell. Narrative how-tos stay in Markdown; leave generated reference tables to embeds.

API reference

- name: API
  slug: api
  api: payments

Uses the API’s latest published OpenAPI document. Readers get the interactive reference without a separate host. Resolution: organization API id or slug.

Deep dive: OpenAPI embed.

SDK docs

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

Prefer the SDK slug so console renames stay stable. Id and name also resolve.

CLI docs

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

Groups

Pack multiple embeds under a dropdown:

- name: More
  children:
    - name: SDKs
      slug: sdks
      sdk: payments-sdk
    - name: CLI
      slug: cli
      cli: payments-cli

Tips

  • Publish the underlying API/SDK/CLI before embedding so the section is not empty

  • Unresolved refs fail git sync with a validation error

  • Keep getting-started content in guides; link to the embed for operations