Components — Sambadocs Docs

sambadocsDocs

Beyond Markdown, Sambadocs ships a small set of components for the things docs need most. This page shows each one rendering live — exactly how it looks on your published site.

Callouts

Use <Callout> to highlight notes, tips, warnings, and errors. The type controls the color and meaning:

Info

The default. Carries the brand tint — good for tips and context.

Success

For confirmations and “you’re done” moments.

Warning

For gotchas and things that need care before proceeding.

Error

For destructive actions or hard requirements.

<Callout type="warn" title="Heads up">
  Builds publish from your default branch only.
</Callout>

Tabs

Group alternative content — language variants, OS-specific steps — with <Tabs> and <Tab label="…">:

npm install acme

<Tabs>
  <Tab label="npm">npm install acme</Tab>
  <Tab label="pnpm">pnpm add acme</Tab>
</Tabs>

Code blocks

Fenced code blocks get syntax highlighting and a copy button. Add the language after the opening fence:

export function greet(name: string): string {
  return `Hello, ${name}!`;
}

Inline code works with single backticks.

Writing pages — frontmatter and Markdown basics.
API reference from OpenAPI — generate API docs from a spec.

Callouts

Tabs

Code blocks

Next