Charted Data.

Command Palette

Search for a command to run...

4 min readCharted Data

Getting Started with Markdown

A comprehensive guide to standard Markdown syntax and how to use it in Charted Data.

Markdown is a lightweight markup language with plain-text-formatting syntax. This guide shows you how to use all the standard features with live examples and authoring references.


1. Headings#

Headings help structure your content and are automatically added to the Table of Contents.

Heading 1#

Heading 2#

Heading 3#

Heading 4#

Heading 5#
Heading 6#

How to author:

# Heading 1
## Heading 2
### Heading 3
#### Heading 4
##### Heading 5
###### Heading 6

2. Text Formatting#

Support for bold, italic, and strikethrough is standard.

  • Bold text using double asterisks.
  • Italic text using single asterisks.
  • Bold and Italic using triple asterisks.
  • Strikethrough text using double tildes.
  • Inline code using backticks.

How to author:

- **Bold text**
- *Italic text*
- ***Bold and Italic***
- ~~Strikethrough text~~
- `Inline code`

3. Lists#

Unordered List#

  • Item one
  • Item two
    • Nested item
    • Another nested item
  • Item three

How to author:

- Item one
- Item two
- Nested item
- Item three

Ordered List#

  1. First step
  2. Second step
  3. Third step
    1. Sub-step A
    2. Sub-step B

How to author:

1. First step
2. Second step
3. Third step
1. Sub-step A
2. Sub-step B

Task Lists#

  • Completed task
  • Incomplete task
  • Planned task

How to author:

- [x] Completed task
- [ ] Incomplete task
- [ ] Planned task

4. Blockquotes#

Use blockquotes to highlight quotes or external references.

"The details are not the details. They make the design." — Charles Eames

Nested Blockquotes#

This is a top-level quote.

This is a nested quote.

How to author:

> "The details are not the details. They make the design."
> — Charles Eames
> This is a top-level quote.
> > This is a nested quote.

Next.js Documentation

How to author:

[Next.js Documentation](https://nextjs.org)

Custom Link

How to author:

[Custom Link][1]
[1]: https://nextjs.org

Images#

Images are automatically styled with rounded corners and subtle borders. Sample Image

How to author:

![Sample Image](https://images.unsplash.com/photo-1498050108023-c5249f4df085?w=800&auto=format&fit=crop)

6. Tables#

Tables are rendered with a clean, documentation-style aesthetic.

FeatureSupportPerformance
Markdown100%High
ChartsNativeExtreme
CSS v4NativeOptimized

How to author:

| Feature | Support | Performance |
| :--- | :---: | ---: |
| Markdown | 100% | High |
| Charts | Native | Extreme |
| CSS v4 | Native | Optimized |

7. Footnotes#

Footnotes are great for adding citations or extra context without cluttering the main text.

Here is a simple footnote1. With another one here2.

How to author:

Here is a simple footnote[^1].
[^1]: This is the first footnote.

8. Separators#

Use horizontal rules to divide your content sections.


How to author:

---

9. Custom Callouts (JSX)#

While not standard Markdown, these JSX components are available for enhanced noticeability.

This is a tip for your readers.
This is important information.
This is a general note.
This is an important warning.
This is a critical danger alert.

How to author:

<Tip>This is a tip for your readers.</Tip>
<Info>This is important information.</Info>
<Note>This is a general note.</Note>
<Warning>This is an important warning.</Warning>
<Danger>This is a critical danger alert.</Danger>

Happy Writing!

Footnotes#

  1. This is the first footnote.

  2. This is the second footnote with more detail.

Download This Boilerplate ⚡