FastLinkIt

Markdown syntax reference

Pages & Templates6 min read

Several FastLinkIt pages — fundraising campaign descriptions, shop descriptions, payment product descriptions, wiki pages, and link-in-bio block content — use the Markdown Editor component. This page lists every feature the editor supports so you can format your content consistently across the platform.

The editor is based on EasyMDE with additional integrations: syntax highlighting via highlight.js, diagrams via Mermaid, and custom alert and video blocks.

Basic text formatting

**bold text**
*italic text*
~~strikethrough~~
`inline code`

Headings

Use # symbols for headings (up to six levels):

# Heading 1
## Heading 2
### Heading 3
#### Heading 4

Lists

Unordered list:

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

Ordered list:

1. First step
2. Second step
3. Third step
[Link text](https://example.com)
![Alt text](https://example.com/image.png)

The editor's image button lets you drag-and-drop or paste images (where upload is enabled, e.g. wiki pages).

Blockquotes

> This is a quoted paragraph. Great for testimonials or highlights.
>
> — Citation line

Horizontal rule

Three dashes on a line of their own:

---

Tables

| Column A | Column B | Column C |
|----------|----------|----------|
| Row 1    | Data     | Data     |
| Row 2    | Data     | Data     |

Code blocks with syntax highlighting (highlight.js)

Fence code with three backticks and add the language identifier. highlight.js renders the preview with proper colour.

```csharp
public record Person(string Name, int Age);
var p = new Person("Ada", 36);
Console.WriteLine(p);
```

Supported languages include: csharp, javascript, typescript, python, go, rust, java, kotlin, swift, php, ruby, bash, powershell, sql, json, yaml, xml, html, css, scss, markdown, diff, and many more. Use plaintext (or omit the language) for non-code content.

Inline code

For short snippets inside a sentence, wrap text in single backticks: var x = 1;.

Mermaid diagrams

Use a fenced code block with the language mermaid. The editor preview renders the diagram automatically.

```mermaid
flowchart LR
    A[Start] --> B{Is it working?}
    B -- Yes --> C[Great!]
    B -- No --> D[Check logs]
    D --> B
```

Supported diagram types: flowchart, sequenceDiagram, classDiagram, stateDiagram-v2, erDiagram, gantt, pie, mindmap, timeline, gitGraph, journey, quadrantChart. See the Mermaid docs for syntax.

Example sequence diagram:

```mermaid
sequenceDiagram
    Customer->>API: POST /payments
    API->>Stripe: Create checkout
    Stripe-->>API: session_id
    API-->>Customer: redirect URL
```

Alert / callout blocks

FastLinkIt's editor adds four callout types on top of standard Markdown. Toolbar buttons insert them, or you can type them directly as fenced blocks.

Note

```note
This is a neutral note with useful context.
```

Renders as a blue-bordered info callout.

Tip

```tip
Here's a practical suggestion or best-practice hint.
```

Renders as a green-bordered tip callout.

Warning

```warning
Something to be cautious about. Read this before continuing.
```

Renders as an amber-bordered warning callout.

Attention

```attention
Critical information. Action required.
```

Renders as a red-bordered attention callout.

The toolbar buttons (N, T, W, A) insert the correct fence block at your cursor. Alerts can contain any Markdown — paragraphs, lists, bold, inline code, etc.

Video embeds

Embed YouTube, Vimeo, or any video URL using a video fenced block:

```video
https://www.youtube.com/watch?v=dQw4w9WgXcQ
```

The editor renders the video as a responsive iframe in the preview. Supports:

  • YouTube — full watch?v=, short youtu.be/, or embed URLs
  • Vimeo — standard vimeo.com/{id} URLs
  • MP4 / WebM — direct video URLs (rendered with a native <video> player)

Use video blocks in campaign descriptions to pitch a cause, product descriptions to demo how something works, or wiki pages to record tutorials.

Where Markdown is supported

Area Rendered on Features enabled
Fundraising campaign description Public donation page, shop page, embedded widgets All (headings, callouts, code, mermaid, video)
Payment product description Shop page, product pages All
Shop description Public shop page All
Wiki page body /docs/{slug} All + image upload + wiki-specific toolbar buttons
Link-in-bio text block Public /p/{shortCode} pages Basic (headings, bold, italic, lists, links)
Mailing HTML body Email clients HTML-safe subset (email clients strip many features)

Toolbar shortcuts

Hover over each toolbar button for a keyboard shortcut tooltip. The most common ones:

  • Ctrl/Cmd + B — bold
  • Ctrl/Cmd + I — italic
  • Ctrl/Cmd + H — heading
  • Ctrl/Cmd + K — link
  • Ctrl/Cmd + P — toggle preview
  • Ctrl/Cmd + Alt + C — clean block
  • F11 — full screen
  • F9 — side-by-side preview

Preview modes

The editor supports three preview modes via the toolbar:

  1. Edit only (default) — source Markdown only
  2. Preview (🔍 button) — rendered HTML replaces the editor
  3. Side-by-side (⇆ button) — source on the left, rendered output on the right, scroll-synced

Mermaid diagrams, syntax highlighting, and callout blocks all render live in the preview and side-by-side modes.

Tips for long content

  • Use headings to break content into scannable sections. Fundraising campaign pages, product descriptions, and wiki pages all generate navigable tables of contents where supported.
  • Put call-to-actions inside a tip or attention block so they stand out.
  • Keep mermaid diagrams small (5-10 nodes). For complex diagrams, link out to an image instead.
  • Embed videos over writing walls of text where it speeds up understanding — 30 seconds of video is often clearer than 300 words.
  • Escape special characters with a backslash when you need them literal: \*, \_, \#.

Rejoining the server...

Rejoin failed... trying again in seconds.

Failed to rejoin.
Please retry or reload the page.

The session has been paused by the server.

Failed to resume the session.
Please retry or reload the page.