Components Components Overview
Components Overview
MDX components available in Syntext documentation.
Syntext provides a rich set of MDX components for building beautiful, interactive documentation. These components are automatically available in all MDX files.
Component Categories
Hero
Landing banner, inset card, or your preset's home hero
Callouts
Note, Info, Tip, Warning and Danger callout boxes
Code Blocks
Syntax highlighting, tabs, and line numbers
Cards
Card and CardGroup for navigation and features
Columns
Columns and Column for laying content side by side
Search
SearchBar — an in-page entry point to the search modal, or the home search box
Home blocks
SectionCards, QuickStart, ApiGroups, SdkList, CommandList, PopularPages, LatestUpdates and SupportCard — build a docs home in your preset's style (doc engine v2)
Tabs
Tabbed content for multi-option views
Steps
Step-by-step instructions
Playground
Interactive request console readers can send real calls from (doc engine v1)
Accordions
Accordion and AccordionGroup for collapsible sections
Updates
Changelog entries with labels and version tags
Footer
Slim or rich multi-column site footer
Badge, Icon, Frame and Check
Inline labels and icons, framed screenshots and check-marked lines (doc engine v2)
Audience Gate
Restrict page sections to specific audiences
API Components
Endpoint, ParamField, ResponseField, Property, and more
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"
});
user = client.users.create(email="alice@example.com")
Steps
- 01Step 1 of 31 ›Step 11.Install
Install the CLI with
brew install syntext-dev/tap/stx - 02Step 2 of 32 ›Step 22.Initialize
Run
stx initin your project - 03Step 3 of 33 ›Step 33.Deploy
Deploy with
stx deploy
Tabs
bash
brew install syntext-dev/tap/stx
bash
curl -fsSL https://get.syntext.dev | sh
API Components
For documenting HTTP APIs:
Endpoint
POST
/v1/usersParameter Field
NameDescription
emailUser's email address.
Response Field
NameDescription
idUnique 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
Next