Skip to content

docs: remove examples column from entity reference tables #13

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
KnightNiwrem merged 2 commits into from
Nov 29, 2025
Merged

docs: remove examples column from entity reference tables #13

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0e2cb39
docs: remove examples column from entity reference tables
KnightNiwrem Nov 29, 2025
58da64b
docs: simplify FormattedString Method column in tables
KnightNiwrem Nov 29, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions docs/Markdown.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,14 +26,14 @@ Use `\` to escape these characters when you want them as literal text.

## Entity Reference

| Syntax | Example | MessageEntity Type | FormattedString Method |
|--------|---------|-------------------|----------------------|
| `*bold*` | *bold* | `bold` | `FormattedString.bold()` or `fmt\`${bold}...\`` |
| `_italic_` | _italic_ | `italic` | `FormattedString.italic()` or `fmt\`${italic}...\`` |
| `` `code` `` | `code` | `code` | `FormattedString.code()` or `fmt\`${code}...\`` |
| ` ```pre``` ` | pre block | `pre` | `FormattedString.pre()` or `fmt\`${pre()}...\`` |
| `[text](url)` | [link](url) | `text_link` | `FormattedString.link(text, url)` |
| `[text](tg://user?id=123)` | user mention | `text_link` | `FormattedString.mentionUser(text, userId)` |
| Syntax | MessageEntity Type | FormattedString Method |
|--------|-------------------|----------------------|
| `*bold*` | `bold` | `FormattedString.bold()` |
| `_italic_` | `italic` | `FormattedString.italic()` |
| `` `code` `` | `code` | `FormattedString.code()` |
| ` ```pre``` ` | `pre` | `FormattedString.pre()` |
| `[text](url)` | `text_link` | `FormattedString.link(text, url)` |
| `[text](tg://user?id=123)` | `text_link` | `FormattedString.mentionUser(text, userId)` |

### Not Supported in Legacy Markdown

Expand Down
30 changes: 15 additions & 15 deletions docs/MarkdownV2.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,21 +21,21 @@ Inside inline link URLs `(...)`, only `)` and `\` need escaping.

## Entity Reference

| Syntax | Example | MessageEntity Type | FormattedString Method |
|--------|---------|-------------------|----------------------|
| `*bold*` | *bold* | `bold` | `FormattedString.bold()` or `fmt\`${bold}...\`` |
| `_italic_` | _italic_ | `italic` | `FormattedString.italic()` or `fmt\`${italic}...\`` |
| `__underline__` | underline | `underline` | `FormattedString.underline()` or `fmt\`${underline}...\`` |
| `~strikethrough~` | ~~strikethrough~~ | `strikethrough` | `FormattedString.strikethrough()` or `fmt\`${strikethrough}...\`` |
| `\|\|spoiler\|\|` | spoiler | `spoiler` | `FormattedString.spoiler()` or `fmt\`${spoiler}...\`` |
| `` `code` `` | `code` | `code` | `FormattedString.code()` or `fmt\`${code}...\`` |
| ` ```pre``` ` | pre block | `pre` | `FormattedString.pre()` or `fmt\`${pre()}...\`` |
| ` ```language\ncode``` ` | code block | `pre` (with `language`) | `FormattedString.pre(text, "language")` |
| `[text](url)` | [link](url) | `text_link` | `FormattedString.link(text, url)` or `fmt\`${link(url)}...\`` |
| `[text](tg://user?id=123)` | user mention | `text_link` | `FormattedString.mentionUser(text, userId)` |
| `![emoji](tg://emoji?id=123)` | custom emoji | `custom_emoji` | `FormattedString.emoji(text, emojiId)` |
| `>blockquote` | blockquote | `blockquote` | `FormattedString.blockquote()` or `fmt\`${blockquote}...\`` |
| `**>expandable...||` | expandable blockquote | `expandable_blockquote` | `FormattedString.expandableBlockquote()` |
| Syntax | MessageEntity Type | FormattedString Method |
|--------|-------------------|----------------------|
| `*bold*` | `bold` | `FormattedString.bold()` |
| `_italic_` | `italic` | `FormattedString.italic()` |
| `__underline__` | `underline` | `FormattedString.underline()` |
| `~strikethrough~` | `strikethrough` | `FormattedString.strikethrough()` |
| `\|\|spoiler\|\|` | `spoiler` | `FormattedString.spoiler()` |
| `` `code` `` | `code` | `FormattedString.code()` |
| ` ```pre``` ` | `pre` | `FormattedString.pre()` |
| ` ```language\ncode``` ` | `pre` (with `language`) | `FormattedString.pre(text, "language")` |
| `[text](url)` | `text_link` | `FormattedString.link(text, url)` |
| `[text](tg://user?id=123)` | `text_link` | `FormattedString.mentionUser(text, userId)` |
| `![emoji](tg://emoji?id=123)` | `custom_emoji` | `FormattedString.emoji(text, emojiId)` |
| `>blockquote` | `blockquote` | `FormattedString.blockquote()` |
| `**>expandable...\|\|` | `expandable_blockquote` | `FormattedString.expandableBlockquote()` |

---

Expand Down