Skip to Main Content
Search RSS Feed

Markdown Syntax

A brief introduction to the Markdown syntax supported on this page

Markdown support on this page is intentionally limited. Some common features, such as headings and tables, are not supported. Advanced features such as HTML are also unavailable for security reasons.

The following syntax is currently supported.

Text

Use the following syntax to format text:

raw text
**bold text**
_italic text_
**_bold and italic text_**
~~strikethrough~~

`inline code`

Rendered output:

raw text
bold text
italic text
bold and italic text
strikethrough

inline code

Fence

Create a fenced code block by adding a language identifier after the opening backticks:

```language-id
your code here
```

For example:

```rust
fn main() {
    println!("Hello, world!");
}
```

Rendered output:

fn main() {
    println!("Hello, world!");
}

Links

Create a link using the following syntax:

[link text](https://example.com)

Rendered output:

link text

Links to pages on this site are automatically shortened to relative URLs:

[link text](https://lance.hk/p/test/)

becomes

[link text](/p/test/)

Lists

Create an unordered list using -, *, or +:

- George Washington

* John Adams

- Thomas Jefferson

Rendered output:

  • George Washington

  • John Adams

  • Thomas Jefferson

Create an ordered list using numbers followed by periods:

1. James Madison
2. James Monroe
3. John Quincy Adams

Rendered output:

  1. James Madison

  2. James Monroe

  3. John Quincy Adams

Blockquotes

Create a blockquote by adding > before the text:

> This is a blockquote

Rendered output:

This is a blockquote

Blockquotes can be nested up to three levels. Any additional nesting is flattened to the third level. For example, this input:

> > > > A blockquote with depth 4
> > > >
> > > > > Depth 5

is rendered as:

A blockquote with depth 4

Depth 5

Emotions

Add an emotion using its ID in the following format:

:emotion_id:

The emotion button in the upper-right corner of the editor opens the available emotion list. Select an emotion to insert it into your text.

For example:

:peek: :let-me-see: :holding-back: :refuse-to-face:
Emotion Peek Emotion Let Me See Emotion Holding Back Emotion Refuse to Face

Unsupported Syntax

Unsupported syntax includes, but is not limited to:

  • Headings

  • Tables

  • Images

  • HTML

  • Footnotes

If you are not sure whether a syntax is supported, just give it a try.

An alert in the Preview tab will inform you when you are trying to use syntaxes or programming languages that are unsupported:

Unsupported: Heading, Lang cobol