Add docs on formatting options#55
Merged
KnightNiwrem merged 9 commits intogrammyjs:masterfrom Nov 29, 2025
Merged
Conversation
Add comprehensive documentation for all three Telegram formatting styles: - MarkdownV2.md: Full entity reference with syntax, MessageEntity types, and FormattedString mappings - HTML.md: HTML tag reference with all supported elements and nesting rules - Markdown.md: Legacy format documentation with deprecation notice and migration guide Each document includes: - Entity reference tables - Detailed syntax examples - MessageEntity JSON structures - FormattedString usage examples - Nesting rules and limitations
- Fix redeclared const result variables in code examples (use unique names) - Correct 'instance method' comments to 'static method' where applicable - Use consistent text in expandable blockquote examples - Add closing || to expandable blockquote syntax in MarkdownV2 table - Fix expandable_blockquote MessageEntity length to 108
docs: add formatting options documentation
Remove the 'Example' column from entity reference tables in Markdown.md and MarkdownV2.md to match the format used in HTML.md. Also fix the broken table in MarkdownV2.md caused by incorrectly escaped markdown (|| in expandable blockquote row).
Remove template literal examples from the FormattedString Method column to fix table rendering issues caused by escaped backticks.
docs: remove examples column from entity reference tables
Remove template literal examples from the FormattedString Method column to fix table rendering issues caused by escaped backticks.
docs: simplify FormattedString Method column in HTML.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.