Skip to main content

Mistune Telegram

Plugin mistune for converting Markdown into Telegram format.

Supported Markdown elements

Markdown element Telegram Markdown Telegram Markdown V2 Telegram HTML
Headings :white_check_mark: :white_check_mark: :white_check_mark:
Paragraphs :white_check_mark: :white_check_mark: :white_check_mark:
Line Breaks :white_check_mark: :white_check_mark: :white_check_mark:
Bold :white_check_mark: :white_check_mark: :white_check_mark:
Italic :white_check_mark: :white_check_mark: :white_check_mark:
Blockquotes :x: :x: :x:
Lists :x: :x: :white_check_mark:
Code :white_check_mark: :white_check_mark: :white_check_mark:
Code blocks :white_check_mark: :white_check_mark: :white_check_mark:
Horizontal rules :white_check_mark: :white_check_mark: :white_check_mark:
Links :white_check_mark: :white_check_mark: :white_check_mark:
Images :x: :x: :x:

Install

$ pip install mistune-telegram

Or use your python package manager.

Usage

Markdown style example:

import mistune
from mistune_telegram import TelegramMarkdownRenderer
telegram_style = mistune.create_markdown(renderer=TelegramMarkdownRenderer())

print(telegram_style(
"""
# Heading level 1
## Heading level 2
### Heading level 3
#### Heading level 4
##### Heading level 5
###### Heading level 6

Heading level 1
===============
Heading level 2
---------------

First paragraph.

Second paragraph.

First line.
Second line.

**bold**
__bold__

*italic*
_italic_

`code`

```
code blocks
```

```python
code blocks written in the Python programming language
```

[link](http://www.example.com/)

"""))

Output:

*Heading level 1*

*Heading level 2*

*Heading level 3*

*Heading level 4*

*Heading level 5*

*Heading level 6*

*Heading level 1*

*Heading level 2*

First paragraph.

Second paragraph.

First line.
Second line.

*bold*
*bold*

_italic_
_italic_

`code`

```
code blocks
```

```python
code blocks written in the Python programming language
```

[link](http://www.example.com/)

MarkdownV2 style example:

import mistune
from mistune.plugins.formatting import strikethrough
from mistune_telegram import TelegramMarkdownV2Renderer

telegram_style = mistune.create_markdown(renderer=TelegramMarkdownV2Renderer(), plugins=[strikethrough])

print(telegram_style(
"""
# Heading level 1
## Heading level 2
### Heading level 3
#### Heading level 4
##### Heading level 5
###### Heading level 6

Heading level 1
===============
Heading level 2
---------------

First paragraph.

Second paragraph.

First line.
Second line.

**bold**
__bold__

*italic*
_italic_

`code`

```
code blocks
```

```python
code blocks written in the Python programming language
```

[link](http://www.example.com/)

~~strikethrough~~

"""))

Output:

*Heading level 1*

*Heading level 2*

*Heading level 3*

*Heading level 4*

*Heading level 5*

*Heading level 6*

*Heading level 1*

*Heading level 2*

First paragraph.

Second paragraph.

First line.
Second line.

*bold*
*bold*

_italic_
_italic_

`code`

```
code blocks
```

```python
code blocks written in the Python programming language
```

[link](http://www.example.com/)

~strikethrough~

HTML style example:

import mistune
from mistune.plugins.formatting import strikethrough
from mistune_telegram import TelegramHTMLRenderer

telegram_style = mistune.create_markdown(renderer=TelegramHTMLRenderer(), plugins=[strikethrough])

print(telegram_style(
"""
# Heading level 1
## Heading level 2
### Heading level 3
#### Heading level 4
##### Heading level 5
###### Heading level 6

Heading level 1
===============
Heading level 2
---------------

First paragraph.

Second paragraph.

First line.
Second line.

**bold**
__bold__

*italic*
_italic_

1. First item
2. Second item

- First item
- Second item

* First item
* Second item

`code`

```
code blocks
```

```python
code blocks written in the Python programming language
```

[link](http://www.example.com/)

~~strikethrough~~

"""))

Output:

<strong>Heading level 1</strong>

<strong>Heading level 2</strong>

<strong>Heading level 3</strong>

<strong>Heading level 4</strong>

<strong>Heading level 5</strong>

<strong>Heading level 6</strong>

<strong>Heading level 1</strong>

<strong>Heading level 2</strong>

First paragraph.

Second paragraph.

First line.
Second line.

<strong>bold</strong>
<strong>bold</strong>

<em>italic</em>
<em>italic</em>

- First item
- Second item

- First item
- Second item

- First item
- Second item

<code>code</code>

<pre>code blocks
</pre>
<pre><code class="language-python">code blocks written in the Python programming language
</code></pre>
<a href="http://www.example.com/">link</a>

<s>strikethrough</s>

Metadata

Release files for mistune-telegram 0.5.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for mistune-telegram 0.5.0
File Size Uploaded
mistune_telegram-0.5.0.tar.gz 3.1 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for mistune-telegram 0.5.0
File Interpreter ABI Platform
mistune_telegram-0.5.0-py3-none-any.whl Python 3 none any Details

Total release size: 7.4 kB

Release files / mistune_telegram-0.5.0.tar.gz

Download URL mistune_telegram-0.5.0.tar.gz
Size 3.1 kB
Tags Source
SHA-256 checksum
How to use checksums
fbbf0dc6eff436ce363afcbc8552512ac3e2246cd93418de90663993624058b3
BLAKE2b-256 checksum
How to use checksums
5069e66a39c53706cfe0aba513bed18b815664a4b6b53be7ab58b8dbc559b782
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.8.5 CPython/3.13.5 Linux/6.12.34_1

Release files / mistune_telegram-0.5.0-py3-none-any.whl

Download URL mistune_telegram-0.5.0-py3-none-any.whl
Size 4.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
eff36a38df1d30c4d180a5129d6025206a81f99ffd504c31421e13fecfff1925
BLAKE2b-256 checksum
How to use checksums
5732231baa72f84e8f817533aea1dec82dded42d48232eae07c48f11e9791961
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.8.5 CPython/3.13.5 Linux/6.12.34_1

Release history Release notifications | RSS feed

This release

0.5.0 This release

2 release files

0.4.0

2 release files

0.3.0

2 release files

0.2.0

2 release files

0.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page