Syntax Referente Example Page
Below you will find examples of all the formats you can use in your Markdown documentation
References
2024-10-03
Below you will find examples of all the formats you can use in your Markdown documentation
Example Endpoint Docs
Example endpoint title
Example endpoint description
GET
STABLEhttps://example.com/end/point/resource
<Endpoint
method="GET"
title="Example endpoint title"
description="Example endpoint description"
label="STABLE"
>
// Your markdown code here
</Endpoint>
Example Alert Docs
Example message
Example message
Example message
Example message
- Usage:
<Alert type="warning">Example message</Alert>
typeproperties:
export type AlertType = "success" | "error" | "warning" | "info";
Other Markdown utils
Example title with link
- Astro Framework.
- Tailwind CSS.
- Astro Content Collections (MDX).
- React Integration.
- shadcn/ui with Radix.
Example table
| Column 1 | Column 2 | Column 3 |
|---|---|---|
| Row 1, Cell 1 | Row 1, Cell 2 | Row 1, Cell 3 |
| Row 2, Cell 1 | Row 2, Cell 2 | Row 2, Cell 3 |
| Row 3, Cell 1 | Row 3, Cell 2 | Row 3, Cell 3 |
Heading
Use # to define different levels of headings (from h1 to h4).
## Heading Level 1
### Heading Level 2
#### Heading Level 3
Bold Italic Strikethrough
**Bold**
_Italic_
~~Strikethrough~~
Lists
- First item
- Second item
- Sub-item 2.1
- Sub-item 2.2
- Third item
1. First item
2. Second item
1. Sub-item 2.1
2. Sub-item 2.2
3. Third item