Markdown guide

What is Markdown?

Markdown is a simple way to give ordinary text headings, emphasis, lists, links, tables, and more. Edit the source, see the result, and learn every format Asterive supports.

Write readable source

A few plain-text symbols describe the structure. The file still makes sense even before it is rendered.

Preview a document

Asterive turns that source into polished headings, lists, code, media, diagrams, and other document elements.

Keep it portable

The source remains Markdown instead of becoming content that only one editor can understand.

How to take notes in Markdown

Start with a descriptive title, give each topic a heading, and use a short list for next steps. Keep source links beside the ideas they support. These examples work as plain text; try them in the playground below without creating an account.

Meeting notes with decisions and next steps

Separate what was decided from what still needs doing. A short checklist makes a meeting note useful after the meeting ends.

# Website planning

## Decision
Start with a clear product introduction and one useful demo.

## Next steps
- [ ] Draft the introduction
- [ ] Record a two-minute walkthrough

## Open question
Which example best explains the product?

Research notes with a source and your interpretation

Keep source material distinct from your conclusions. Use a link for the reference and write down why it matters in your own words.

# Markdown research

## Source
[CommonMark specification](https://spec.commonmark.org/)

## What I learned
Markdown adds structure to readable plain text.

## My next experiment
Try the same note in two readers and compare the result.
Keep supporting files with your Markdown notes →
Live Markdown playground

Edit the source. See the result.

This draft stays in this page and is not uploaded or saved as an Asterive note.

Source
Preview

A small Markdown document

Markdown keeps the source readable while giving you a polished preview.

Today’s plan

  • Learn the basics
  • Create a useful note
  • Share what I learned
tip

Edit the source on the left and watch this preview change.

FeatureWhy it helps
Plain textEasy to read anywhere
Simple symbolsFast to write

A link can point to the Asterive home page, and inline code stays distinct.

Start here

Everyday Markdown

These are the formats most people use for ordinary notes, plans, and documentation.

01

Paragraphs

Write normal text. Leave an empty line when you want to start a new paragraph.

Write
This is the first paragraph.

This is a separate paragraph.
Result

This is the first paragraph.

This is a separate paragraph.

02

Headings

Put one to six # symbols before text to create a section heading.

Asterive also supports Setext headings made with = or - on the following line.

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

Heading 1

Heading 2

Heading 3

Heading 4

Heading 5
Heading 6
03

Bold text

Wrap important words in two asterisks.

Write
This is **important** text.
Result

This is important text.

04

Italic text

Wrap a word or phrase in one asterisk for gentle emphasis.

Write
This is *emphasized* text.
Result

This is emphasized text.

05

Bold and italic

Use three asterisks when text needs both kinds of emphasis.

Write
This is ***very important*** text.
Result

This is very important text.

06

Strikethrough

Wrap text in two tildes to show that it is no longer current.

Write
The meeting is at ~~2:00 PM~~ 3:00 PM.
Result

The meeting is at 2:00 PM 3:00 PM.

07

Inline code

Use backticks for a command, filename, setting, or short piece of code.

Write
Run `npm run build` before publishing.
Result

Run npm run build before publishing.

09

Images

Add an exclamation mark before normal link syntax. The label becomes alternative text.

Complete https:// image addresses work directly. In a note, the image toolbar creates portable Markdown for uploaded or selected images.

Write
![Pink flower against a blue background](https://upload.wikimedia.org/wikipedia/commons/thumb/b/be/Flower-729515.jpg/640px-Flower-729515.jpg "Flower in bloom")

Image: [Bessi via Wikimedia Commons](https://commons.wikimedia.org/wiki/File:Flower-729515.jpg), [CC0](https://creativecommons.org/publicdomain/zero/1.0/).
Result
Pink flower against a blue backgroundFlower in bloom

Image: Bessi via Wikimedia Commons, CC0.

10

Unordered lists

Begin each item with a dash, asterisk, or plus sign.

Write
- Research the topic
- Write the first draft
- Ask for feedback
Result
  • Research the topic
  • Write the first draft
  • Ask for feedback
11

Ordered lists

Begin each item with a number and a period or closing parenthesis.

Custom starting numbers and nested ordered or unordered lists are supported.

Write
1. Open the note
2. Make the change
3. Review the preview
Result
  1. Open the note
  2. Make the change
  3. Review the preview
12

Nested lists

Indent a list beneath another item to show that it belongs inside it.

Write
- Launch plan
  - Prepare the release
  - Check the documentation
- Follow up
Result
  • Launch plan
    • Prepare the release
    • Check the documentation
  • Follow up
13

Checklists

Add [ ] for an open task or [x] for a completed task after a list marker.

In Asterive’s note editor, preview checkboxes can update the Markdown source directly.

Write
- [x] Learn the syntax
- [ ] Write a note
- [ ] Finish the project
Result
  • Learn the syntax
  • Write a note
  • Finish the project
14

Blockquotes

Begin a line with > to set apart a quotation or supporting thought.

Write
> Good tools make the source easy to keep and the result pleasant to read.
Result

Good tools make the source easy to keep and the result pleasant to read.

15

Horizontal rules

Use three dashes, asterisks, or underscores to divide sections.

Write
Before the divider

---

After the divider
Result

Before the divider


After the divider

16

Line breaks

End a line with two spaces or a backslash when the next line must begin immediately below it.

Write
First line ends here.  
Second line starts below it.

A normal soft break
stays in the same paragraph.
Result

First line ends here.
Second line starts below it.

A normal soft break stays in the same paragraph.

17

Literal Markdown symbols

Put a backslash before punctuation when you want the symbol to remain ordinary text.

Write
\*These asterisks stay visible.\*

Character references also work: © and ★.
Result

*These asterisks stay visible.*

Character references also work: © and ★.

Build documents

Structured content

Use these formats for technical notes, research, comparisons, and longer documents.

01

Code blocks

Put three backticks around code. Add a language name for syntax highlighting.

Tilde fences and indented code blocks are also supported. Full previews can wrap or copy code without changing the source.

Write
```typescript
const greeting: string = "Hello, Markdown";
console.log(greeting);
```
Result
Typescript
const greeting: string = "Hello, Markdown";
console.log(greeting);
02

Tables

Use pipes for columns and a separator row beneath the headings.

Full Asterive previews can wrap a wide table or copy it as tab-separated text.

Write
| Format | Supported |
| :--- | :---: |
| Tables | Yes |
| Checklists | Yes |
Result
FormatSupported
TablesYes
ChecklistsYes
05

Footnotes

Add a small reference in the text and define its supporting note elsewhere.

Write
Markdown can stay readable while adding detail.[^reason]

[^reason]: The explanation appears as a footnote.
Result

Markdown can stay readable while adding detail.1

Footnotes

  1. The explanation appears as a footnote. ↩

06

Definition lists

Place a colon-led explanation beneath a term.

Write
Markdown
: Plain text with lightweight formatting symbols.

Preview
: The formatted result produced from the source.
Result
Markdown
Plain text with lightweight formatting symbols.
Preview
The formatted result produced from the source.

Go further

Asterive extensions

Asterive adds useful document features while preserving the original Markdown source.

01

Math formulas

Use dollar signs for inline LaTeX-style math and double dollar signs for display math.

Asterive renders formulas with KaTeX and leaves the source unchanged.

Write
Energy is $E = mc^2$.

$$
\int_0^1 x^2\,dx = \frac{1}{3}
$$
Result

Energy is E=mc2E = mc^2.

∫01x2 dx=13\int_0^1 x^2\,dx = \frac{1}{3}
02

Mermaid diagrams

Use a fenced code block labeled mermaid to turn text into a diagram.

Diagrams follow the selected theme. Invalid diagrams retain a readable source fallback.

Write
```mermaid
flowchart LR
  A[Capture] --> B[Organize]
  B --> C[Find again]
```
Result
03

Callouts

Add a supported label at the beginning of a blockquote to create a highlighted message.

Supported types are NOTE, TIP, IMPORTANT, WARNING, and CAUTION.

Write
> [!NOTE]
> This detail is useful to remember.

> [!WARNING]
> Check the result before continuing.
Result
note

This detail is useful to remember.

warning

Check the result before continuing.

04

Table of contents

Use the Asterive TOC marker to generate links to the document’s headings.

Asterive also generates stable heading anchors for outline and table-of-contents navigation.

Write
[[_TOC_]]

## Introduction
Start here.

## Next steps
Continue here.
Result

Introduction

Start here.

Next steps

Continue here.

05

YAML front matter

Keep metadata between leading --- lines without showing it in the rendered document body.

Write
---
title: Project plan
tags: [work, launch]
---

# Visible document

The metadata above stays in the source.
Result

Visible document

The metadata above stays in the source.

07

Safe HTML formatting

A small sanitized HTML subset supports formatting that standard Markdown does not provide.

Scripts, forms, embedded frames, event handlers, styling hooks, unsafe URLs, and other executable content are removed.

Write
Use <u>underline</u>, <mark>highlight</mark>, H<sub>2</sub>O, or x<sup>2</sup>.

<details><summary>More detail</summary>Hidden until opened.</details>
Result

Use underline, highlight, H2O, or x2.

More detailHidden until opened.
08Account feature

Portable attachment links

Asterive represents files, recordings, locations, and uploaded media with ordinary Markdown links.

Real owned-file cards require a signed-in account and an uploaded file. The stored Markdown remains portable rather than using private app-only syntax.

Write
[Attachment: project-brief.pdf](/media/note_assets/example/project-brief.pdf)

[Location: Studio](https://www.google.com/maps/search/?api=1&query=35.6892,51.3890)
Result
project-brief.pdfPDF attachment
StudioLocationOpen in Maps
09

Right-to-left writing

Asterive detects direction for paragraphs and structural blocks so English, Persian, and Arabic can coexist.

Code and URLs remain isolated left-to-right while the surrounding writing follows its natural direction.

Write
## یادداشت پروژه

این پاراگراف به‌صورت راست‌به‌چپ نمایش داده می‌شود.

- مرحله اول
- مرحله دوم

Technical value: `npm run build`
Result

یادداشت پروژه

این پاراگراف به‌صورت راست‌به‌چپ نمایش داده می‌شود.

  • مرحله اول
  • مرحله دوم

Technical value: npm run build

10

Reading appearance

Refined, Minimal, and Classic change typography and decoration without rewriting the Markdown.

The current device’s Markdown appearance setting also controls this public preview.

Write
# The same durable source

> Appearance belongs to the reader, not the stored note.

- Refined
- Minimal
- Classic
Result

The same durable source

Appearance belongs to the reader, not the stored note.

  • Refined
  • Minimal
  • Classic

Markdown in Asterive

Durable source, without giving up a comfortable editor.

Asterive adds visual and source editing, polished reading styles, organization, files and recordings, Quick Find, history, portable exports, and AI changes you can review before applying—all around Markdown you can keep.