Markdown Syntax

Your knowledge sharing hub uses markdown to help you format the content that will automatically be rendered on your content site without having to leave your IDE. We support most Markdown formatting options. In this page you can find a cheatsheet to the most common ones.

Titles

Use titles to introduce main sections. They structure your content and help users navigate pages easily.

## Section Title

Subtitles

Use subtitles to divide sections further. They create a more detailed content hierarchy for better readability.

### Section Subtitle

Text Formatting

Improve the readability of your content with markdown.

Combine formatting for richer text styles and visual emphasis.

For exponents, indices, or mathematical notations, use HTML <sup> and <sub> tags.

Links

Links connect different parts of your content and external resources, essential for user navigation and providing references. To create a link, wrap the link text in brackets []().

[TTT](http://team.teaches.team)

Internal links

For linking within your content, use root-relative paths like /playbook/usage/markdown-syntax.

[Playbook - Markdown Syntax](/playbook/usage/markdown-syntax)

Lists

Organize related items in a structured, readable format. Markdown supports unordered, ordered, and nested lists for various content needs.

Unordered

Use unordered lists for items without a specific sequence. Start each item with a - symbol.

- I'm a list item.
- I'm another list item.
- I'm the last list item.

Ordered

Use ordered lists when item order matters, like steps in a process. Start each item with a number followed by a dot.

1. I'm a list item.
1. I'm another list item.
1. I'm the last list item.

Nested

Create hierarchical lists with sub-items for complex structures. Indent sub-items by four spaces for nesting.

- I'm a list item.
  - I'm a nested list item.
  - I'm another nested list item.
- I'm another list item.

Tables

Present structured data in rows and columns clearly. Tables are ideal for comparing data or listing properties.

| Prop        | Default   | Type     |
|-------------|-----------|----------|
| **_name_**  |           | `string` |
| **_size_**  | `md`      | `string` |
| **_color_** | `neutral` | `string` |

Blockquotes

Highlight important quotations, citations, or emphasized text. Blockquotes visually distinguish quoted content.

Singleline

Single-line blockquotes are best for short, impactful quotes or citations that fit within a single line. To create a single-line blockquote, add a > in front of a sentence.

> Knowledge is power. **Knowledged shared is powered multiplied!** *-Robert Boyce*

Multiline

Multi-line blockquotes are suitable for longer quotes or when you need to include multiple paragraphs within a single quotation.

> Knowledge is like money: to be of value it must circulate, and in circulating it can increase in quantity, and hopefully, in value. 
> 
> **_Louis L'Amoar_**