discord-markdown（Discord Markdown 控制）

Discord Markdown Formatting

Format text for Discord's chat rendering engine. Discord uses a modified subset of Markdown with some unique additions (spoilers, timestamps, subtext, guild navigation).

Output Presentation — CRITICAL

When composing a Discord message for the user, always present the final message inside a fenced code block so the user can copy-paste it directly into Discord with all markdown formatting intact.

Why: Claude's chat interface renders markdown (e.g., **bold** becomes bold). If the user copies rendered text, the markdown syntax is stripped and the message loses its formatting when pasted into Discord. A code block preserves the raw syntax.

How to Present Discord Messages

Always wrap the final copy-paste-ready message in a fenced code block with the markdown language tag:

🚀 Announcement

This is bold and ~~this is struck~~ and ||this is a spoiler||

Block quote here

-# Subtext footer

Rules

1. Always use a fenced code block — Triple backticks with markdown language identifier
2. The ENTIRE message goes in ONE block — Everything the user will paste into Discord lives inside a single fenced code block. No part of the Discord message should ever appear outside the block as rendered markdown
3. Explain outside the block — Put any notes, options, or context _before_ or _after_ the code block, never inside it
4. Handle nested code blocks — If the Discord message itself contains code blocks, use four backticks (``````) as the outer fence so the inner triple backticks are preserved. The user copies everything between the outer fence — the inner triple backticks are part of the Discord message:

Here's some code:

console.log("hello");

Pretty cool right?

1. Multiple messages = multiple blocks — If providing alternatives or a multi-message sequence, use a separate code block for each with a label above it
2. Message metadata summary — Always display a metadata summary table immediately after every Discord message code block (see below)
3. Templates too — When presenting templates from the reference files, they should also be in copyable code blocks following these same rules
4. Never partially render — Do NOT put headers, bold text, code snippets, or any other Discord-formatted content outside the code block. If it's part of the Discord message, it goes inside the block. The user should never have to assemble a message from rendered markdown and code blocks

Message Metadata Summary

After every Discord message code block, include a summary table with the following stats:

Format the summary as a compact table directly below the code block:

| Stat               | Value          |
|--------------------|----------------|
| Characters         | 437 / 2,000    |
| Sections           | 3              |
| User Mentions      | 1              |
| Role Mentions      | 1 (@everyone)  |
| Channel Mentions   | 0              |
| URLs               | 0              |
| Code Blocks        | —              |

Notes:

• For role mentions, parenthetically note if @everyone or @here is included since those ping the entire server
• For code blocks, list each language, e.g. javascript, bash — or (no lang) if the block has no language identifier
• If characters exceed 80% of the limit, add a ⚠️ warning
• If characters exceed the limit, add a 🚫 and suggest splitting the message

Example Interaction

User: "Write me a Discord announcement about a new SDK release that includes code examples"

Claude's response should look like:

Here's your SDK announcement:

# 🚀 Volvox SDK v2.0 — Breaking Changes

Hey @everyone — we just shipped **v2.0** of the SDK and there are a few things you need to know before upgrading.

## What Changed

The `createJar` method now accepts an options object instead of positional arguments:

**Before:**

const jar = createJar("Lunch Spots", ["Chipotle", "Sweetgreen"], true);

**After:**

const jar = createJar({ name: "Lunch Spots", options: ["Chipotle", "Sweetgreen"], allowDuplicates: true, });

## New: Shake Events

jar.on("shake", (result) => { console.log(🎉 Selected: ${result.option}); });

> 💡 Full migration guide pinned in <#dev-resources>

Drop questions in <#sdk-support> — <@core-team> is standing by. 🫡

-# v2.0.0 • <t:1770537600:D>

Key: Notice the outer fence uses four backticks (``````) because the Discord message contains inner triple-backtick code blocks. The user copies everything between the outer fence — inner backticks are part of the message.

Quick Reference

Text Formatting

Emphasis

*italic* or _italic_
**bold**
***bold italic***
__underline__
~~strikethrough~~
||spoiler text||

Combining Styles

Nest formatting markers from outside in. Discord resolves them in this order: underline → bold → italic → strikethrough.

__**bold underline**__
__*italic underline*__
__***bold italic underline***__
~~**bold strikethrough**~~
~~__**bold underline strikethrough**__~~
||**bold spoiler**||

Escaping

Prefix any markdown character with \ to display it literally:

\*not italic\*
\*\*not bold\*\*
\|\|not a spoiler\|\|

Headers

Headers require # at the start of a line followed by a space. Only three levels are supported.

# Large Header
## Medium Header
### Small Header

Important: Headers do not work inline. The # must be the first character on the line.

Subtext

Small, muted gray text below content. Useful for footnotes, disclaimers, or attribution.

-# This renders as subtext

Block Quotes

Single-line

> This is a single block quote

Multi-line

Everything after >>> (including subsequent lines) becomes quoted:

>>> This entire block
including this line
and this line
are all quoted

Lists

Unordered

Use - or * with a space. Indent with spaces for nesting:

- Item one
- Item two
  - Nested item
  - Another nested item
    - Deep nested

Ordered

1. First item
2. Second item
3. Third item

Auto-numbering trick: Discord auto-increments if you repeat 1.:

1. First
1. Second (renders as 2.)
1. Third (renders as 3.)

Code Blocks

Inline Code

Use `inline code` for short snippets

Multi-line Code Block

Wrap code with triple backticks on their own lines:

function hello() { return "world"; }

Syntax Highlighting

Add a language identifier after the opening backticks:

function hello() { return "world"; }

See references/syntax-highlighting.md for the full list of supported languages.

Commonly used languages: javascript, typescript, python, csharp, json, bash, css, html, sql, yaml, diff, markdown

Links

Masked Links

[Click here](https://example.com)

Note: Masked links work in embeds and some contexts, but regular chat may show a preview. Discord may suppress masked links from bots in certain conditions.

Auto-linking

Discord auto-links any valid URL pasted directly:

Check out https://example.com for more info

Suppressing Link Previews

Wrap a URL in angle brackets to prevent Discord from generating a preview embed:

<https://example.com>

Timestamps

Dynamic timestamps that display in each user's local timezone.

Format: <t:UNIX_TIMESTAMP:FORMAT_FLAG>

Example:

Event starts <t:1770537600:F>
That was <t:1770537600:R>

Tip: Use Math.floor(Date.now() / 1000) or date +%s to get the current Unix timestamp.

Mentions & References

<@USER_ID>          → @username mention
<@!USER_ID>         → @username mention (nickname format)
<@&ROLE_ID>         → @role mention
<#CHANNEL_ID>       → #channel link
<id:browse>         → Browse Channels link
<id:customize>      → Customize Community link
<id:guide>          → Server Guide link
<id:linked-roles>   → Linked Roles link

Emoji

:emoji_name:                    → Standard/custom emoji
<:emoji_name:EMOJI_ID>          → Custom emoji
<a:emoji_name:EMOJI_ID>         → Animated custom emoji

Discord-Specific Gotchas

1. No nested block quotes — Discord does not support >> for nested quotes
2. Headers need line start — # must be the first character on the line (not inline)
3. Underline is NOT standard Markdown — __text__ underlines in Discord but bolds in standard Markdown
4. Spoilers are Discord-only — ||text|| has no equivalent in standard Markdown
5. Lists need a blank line — Start lists after a blank line or they may not render
6. Embed markdown differs — Some formatting behaves differently in embeds vs chat messages
7. 2000 character limit — Standard messages max at 2,000 characters; nitro users get 4,000
8. Embed description limit — Embed descriptions max at 4,096 characters
9. Code block language names are case-insensitive — JS, js, and JavaScript all work

Formatting for Different Contexts

Reminder: Regardless of context, always present the final Discord-ready message inside a fenced code block so the user can copy-paste it directly. See "Output Presentation" above.

Chat Messages

Full markdown support. 2,000 character limit (4,000 with Nitro).

Embed Descriptions

Full markdown support. 4,096 character limit. Masked links work reliably here.

Embed Field Values

Limited markdown. 1,024 character limit per field.

Bot Messages / Webhooks

Full markdown support. Same as chat messages. Use embeds for richer formatting.

Forum Posts

Full markdown support in the post body. Title is plain text only.

Resources

• Syntax highlighting: references/syntax-highlighting.md — full list of supported languages with examples
• Templates: references/templates.md — copy-paste templates for common Discord formatting patterns