diff --git a/docs/source/resources/TextFormatting.rst b/docs/source/resources/TextFormatting.rst index 124d02da..aaa78f0a 100644 --- a/docs/source/resources/TextFormatting.rst +++ b/docs/source/resources/TextFormatting.rst @@ -1,8 +1,8 @@ Text Formatting =============== -Pyrogram, just like `Telegram Bot API`_, supports basic Markdown and HTML formatting styles for messages and media captions; -Markdown uses the same syntax as Telegram Desktop's and is enabled by default. +Pyrogram, just like `Telegram Bot API`_, supports basic Markdown and HTML formatting styles for text messages and +media captions; Markdown uses the same syntax as Telegram Desktop's and is enabled by default. Beside bold, italic, and pre-formatted code, **Pyrogram does also support inline URLs and inline mentions of users**. Markdown Style @@ -11,15 +11,15 @@ Markdown Style To use this mode, pass :obj:`MARKDOWN ` or "markdown" in the *parse_mode* field when using :obj:`send_message() `. Use the following syntax in your message: -.. code:: +.. code-block:: txt **bold text** __italic text__ - [inline URL](http://www.example.com/) + [inline URL](https://docs.pyrogram.ml/) - [inline mention of a user](tg://user?id=123456789) + [inline mention of a user](tg://user?id=23122162) `inline fixed-width code` @@ -27,78 +27,70 @@ To use this mode, pass :obj:`MARKDOWN ` or "markdow pre-formatted fixed-width code block ``` + HTML Style ---------- To use this mode, pass :obj:`HTML ` or "html" in the *parse_mode* field when using :obj:`send_message() `. The following tags are currently supported: -.. code:: +.. code-block:: txt bold, bold italic, italic - inline URL + inline URL - inline mention of a user + inline mention of a user inline fixed-width code -
pre-formatted fixed-width code block
+
pre-formatted fixed-width
+    code block
+    
-.. note:: Mentions are only guaranteed to work if you have already contacted the user. +.. note:: Mentions are only guaranteed to work if you have already met the user (in groups or private chats). Examples -------- -- Markdown inline entities (bold, italic, ...): +- Markdown: .. code-block:: python app.send_message( - chat_id="me", + chat_id="haskell", text=( "**bold**, " "__italic__, " "[mention](tg://user?id=23122162), " - "[url](https://pyrogram.ml), " - "`code`" - ) - ) - -- Markdown code blocks: - - .. code-block:: python - - app.send_message( - chat_id="me", - text=( - # Code block language is optional - "``` python\n" - "for i in range(10):\n" - " print(i)\n" + "[URL](https://docs.pyrogram.ml), " + "`code`, " "```" + "for i in range(10):\n" + " print(i)```" ) ) -- HTML example: +- HTML: .. code-block:: python - from pyrogram import ParseMode - app.send_message( - chat_id="me", + chat_id="haskell", text=( - "bold, bold, " - "italic, italic, " - "inline URL, " - "inline mention of a user, " - "inline fixed-width code, " - "
pre-formatted fixed-width code block
" + "bold, " + "italic, " + "mention, " + "URL, " + "code, " + "
"
+                "for i in range(10):\n"
+                "    print(i)"
+                "
" ), - parse_mode=ParseMode.HTML + parse_mode="html" ) .. _Telegram Bot API: https://core.telegram.org/bots/api#formatting-options \ No newline at end of file