2.5 KiB
Content Guidelines
Table of Contents
Basics
Here are some essential markdoc syntax elements with code examples:
Paragraphs and Line Breaks
To create a new paragraph, simply leave a blank line between lines of text.
This is the first paragraph.
This is the second paragraph.
Headers
Headers are used to create section titles. Use hashtags (#) for headers, with more hashtags for lower-level headers.
# Header 1
## Header 2
### Header 3
Headers can also be given ID's so they can be linked to and are present in the ToC:
# Header with ID {% #header-with-id %}
Lists
Create ordered (numbered) and unordered (bulleted) lists using 1., *, or -.
Ordered List:
1. First item
2. Second item
3. Third item
Unordered List:
- Apple
- Banana
- Cherry
Links
Create hyperlinks to other web pages or sections within your documentation.
[Google](https://www.google.com)
[Link to Section](#section-name)
Images
Embed images using the  syntax.

Code Blocks
Format code blocks using triple backticks (```).
```python
def hello_world():
print("Hello, World!")
```
Inline Code
Highlight inline code with backticks (`) around the code snippet.
Use the `print()` function to display text.
Emphasis and Strong Text
Use asterisks (*) or underscores (_) for emphasis and double asterisks or underscores for strong text.
_Italic Text_ or _Italic Text_
**Bold Text** or **Bold Text**
Tables
Tables allow you to display structured data in your documentation. Use pipes (|) to separate columns and hyphens (-) to define the table header.
| Header 1 | Header 2 | Header 3 |
| ------------ | ------------ | ------------ |
| Row 1, Col 1 | Row 1, Col 2 | Row 1, Col 3 |
| Row 2, Col 1 | Row 2, Col 2 | Row 2, Col 3 |
Block Quotes
Block quotes are used to emphasize or highlight text. To create a block quote, use the > symbol at the beginning of the quoted text.
> This is a block quote.
> It can span multiple lines.
These are the fundamental Markdown syntax elements you'll need to create well-structured and formatted documentation.
Components
Tabs
{% tabs %}
{% tabsitem #js title="Javascript" %}
...
{% /tabsitem %}
{% tabsitem #flutter title="Flutter" %}
...
{% /tabsitem %}
{% /tabs %}
Multicode Examples