---
title: Components Overview
description: MDX components available in Syntext documentation.
icon: component
---

# Components Overview

Syntext provides a rich set of MDX components for building beautiful, interactive documentation. These components are automatically available in all MDX files.

## Component Categories

<CardGroup cols={2}>
  <Card title="Callouts" icon="message-square" href="/components/callouts">
    Note, Warning, Tip, and Info callout boxes
  </Card>
  <Card title="Code Blocks" icon="code" href="/components/code-blocks">
    Syntax highlighting, tabs, and line numbers
  </Card>
  <Card title="Cards" icon="layout" href="/components/cards">
    Card and CardGroup for navigation and features
  </Card>
  <Card title="Tabs" icon="columns" href="/components/tabs">
    Tabbed content for multi-option views
  </Card>
  <Card title="Steps" icon="list-ordered" href="/components/steps">
    Step-by-step instructions
  </Card>
  <Card title="Accordions" icon="layers" href="/components/accordions">
    Accordion and AccordionGroup for collapsible sections
  </Card>
  <Card title="Updates" icon="clock" href="/components/updates">
    Changelog entries with labels and version tags
  </Card>
  <Card title="Footer" icon="layout" href="/components/footer">
    Slim or rich multi-column site footer
  </Card>
  <Card title="Audience Gate" icon="lock" href="/components/audience-gate">
    Restrict page sections to specific audiences
  </Card>
  <Card title="API Components" icon="api" href="/components/api-components">
    Endpoint, ParamField, ResponseField, and more
  </Card>
</CardGroup>

## Quick Reference

### Callouts

<Note>
Informational notes for important context.
</Note>

<Warning>
Warnings for potential issues or pitfalls.
</Warning>

<Tip>
Helpful suggestions and best practices.
</Tip>

### Cards

<CardGroup cols={3}>
  <Card title="Quick Start" icon="rocket" href="/guides/quickstart">
    Get started in 5 minutes
  </Card>
  <Card title="API Reference" icon="api" href="/api-reference">
    Explore the API
  </Card>
  <Card title="Examples" icon="code" href="/examples">
    See code examples
  </Card>
</CardGroup>

### Code Blocks

<CodeGroup>

```typescript title="TypeScript"
const user = await client.users.create({
  email: "alice@example.com"
});
```

```python title="Python"
user = client.users.create(email="alice@example.com")
```

</CodeGroup>

### Steps

<Steps>
  <Step title="Install">
    Install the CLI with `npm install -g @syntext/cli`
  </Step>
  <Step title="Initialize">
    Run `stx init` in your project
  </Step>
  <Step title="Deploy">
    Deploy with `stx deploy`
  </Step>
</Steps>

### Tabs

<Tabs>
  <Tab title="npm">
    ```bash
    npm install @syntext/sdk
    ```
  </Tab>
  <Tab title="yarn">
    ```bash
    yarn add @syntext/sdk
    ```
  </Tab>
  <Tab title="pnpm">
    ```bash
    pnpm add @syntext/sdk
    ```
  </Tab>
</Tabs>

## API Components

For REST, GraphQL, WebSocket, and gRPC documentation:

### Endpoint

<Endpoint method="POST" path="/v1/users" />

### Parameter Field

<ParamField name="email" type="string" required>
  User's email address.
</ParamField>

### Response Field

<ResponseField name="id" type="string">
  Unique user identifier.
</ResponseField>

## Usage

Components are used like JSX/HTML tags in your MDX:

```mdx
# My Page

This is regular markdown.

<Note>
This is a component with children content.
</Note>

<Card title="Quick Start" href="/quickstart" />
```

<Tip>
Components can be nested and combined. Experiment to find what works best for your content.
</Tip>
