pyrogram/docs/source/resources/TextFormatting.rst

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.
Beside bold, italic, and pre-formatted code, **Pyrogram does also support inline URLs and inline mentions of users**.

Markdown Style
--------------

To use this mode, pass :obj:`pyrogram.ParseMode.MARKDOWN` or "markdown" in the *parse_mode* field when using
:obj:`send_message <pyrogram.Client.send_message>`. Use the following syntax in your message:

.. code::

    **bold text**

    __italic text__

    [inline URL](http://www.example.com/)

    [inline mention of a user](tg://user?id=123456789)

    `inline fixed-width code`

    ```block_language
    pre-formatted fixed-width code block
    ```

HTML Style
----------

To use this mode, pass :obj:`pyrogram.ParseMode.HTML` or "html" in the *parse_mode* field when using
:obj:`send_message <pyrogram.Client.send_message>`. The following tags are currently supported:

.. code::

    <b>bold</b>, <strong>bold</strong>

    <i>italic</i>, <em>italic</em>

    <a href="http://www.example.com/">inline URL</a>

    <a href="tg://user?id=123456789">inline mention of a user</a>

    <code>inline fixed-width code</code>

    <pre>pre-formatted fixed-width code block</pre>

.. note:: Mentions are only guaranteed to work if you have already contacted the user.

Examples
--------

-   Markdown inline entities (bold, italic, ...):

    .. code-block:: python

        client.send_message(
            chat_id="me",
            text=(
                "**bold**\n"
                "__italic__\n"
                "[mention](tg://user?id=23122162)\n"
                "[url](https://pyrogram.ml)\n"
                "`code`\n"
            )
        )

-   Markdown code blocks:

    .. code-block:: python

        client.send_message(
            chat_id="me",
            text=(
                # Code block language is optional
                "``` python\n"
                "for i in range(10):\n"
                "   print(i)\n"
                "```"
            )
        )

-   HTML example:

    .. code-block:: python

        from pyrogram import ParseMode

        client.send_message(
            chat_id="me",
            text=(
                "<b>bold</b>, <strong>bold</strong>\n"
                "<i>italic</i>, <em>italic</em>\n"
                "<a href=\"https://pyrogram.ml/\">inline URL</a>\n"
                "<a href=\"tg://user?id=23122162\">inline mention of a user</a>\n"
                "<code>inline fixed-width code</code>\n"
                "<pre>pre-formatted fixed-width code block</pre>\n"
            ),
            parse_mode=ParseMode.HTML
        )

.. _Telegram Bot API: https://core.telegram.org/bots/api#formatting-options