/Docs
Search docs or ask a question⌘K
DocsAgent
Changelog
Components Components Overview

Components Overview

MDX components available in Syntext documentation.

2 min read

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

Component Categories

Quick Reference

Callouts

Note

Informational notes for important context.

Warning

Warnings for potential issues or pitfalls.

Tip

Helpful suggestions and best practices.

Cards

Code Blocks

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

Steps

  1. 01Step 1 of 31 ›Step 11.
    Install

    Install the CLI with brew install syntext-dev/tap/stx

  2. 02Step 2 of 32 ›Step 22.
    Initialize

    Run stx init in your project

  3. 03Step 3 of 33 ›Step 33.
    Deploy

    Deploy with stx deploy

Tabs

Homebrewcurl
bash
brew install syntext-dev/tap/stx

API Components

For documenting HTTP APIs:

Endpoint

POST/v1/users

Parameter Field

NameDescription
email:stringRequired
User's email address.

Response Field

NameDescription
id:string
Unique user identifier.

Usage

Components are used like JSX/HTML tags in your MDX. You can also write plain HTML in a page; scripts and event handlers in it run only when your project allows them — see HTML in your pages.

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.

Was this page helpful? Yes No
Product
Resources
Company
© 2026 SyntextBuilt with Syntext