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
Note, Warning, Tip, and Info callout boxes
Syntax highlighting, tabs, and line numbers
Card and CardGroup for navigation and features
Tabbed content for multi-option views
Step-by-step instructions
Accordion and AccordionGroup for collapsible sections
Changelog entries with labels and version tags
Slim or rich multi-column site footer
Restrict page sections to specific audiences
Endpoint, ParamField, ResponseField, and more
Quick Reference
Callouts
Informational notes for important context.
Warnings for potential issues or pitfalls.
Helpful suggestions and best practices.
Cards
Get started in 5 minutes
Explore the API
See code examples
Code Blocks
const user = await client.users.create({
email: "alice@example.com"
});
user = client.users.create(email="alice@example.com")
Steps
Install the CLI with npm install -g @syntext/cli
Run stx init in your project
Deploy with stx deploy
Tabs
npm install @syntext/sdk
yarn add @syntext/sdk
pnpm add @syntext/sdk
API Components
For REST, GraphQL, WebSocket, and gRPC documentation:
Endpoint
Parameter Field
User's email address.
Response Field
Unique user identifier.
Usage
Components are used like JSX/HTML tags in your MDX:
# My Page
This is regular markdown.
<Note>
This is a component with children content.
</Note>
<Card title="Quick Start" href="/quickstart" />
Components can be nested and combined. Experiment to find what works best for your content.