Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hentioe/telegex_marked
Safe Markdown parser/renderer for Telegram
https://github.com/hentioe/telegex_marked
Last synced: 14 days ago
JSON representation
Safe Markdown parser/renderer for Telegram
- Host: GitHub
- URL: https://github.com/hentioe/telegex_marked
- Owner: Hentioe
- License: mit
- Created: 2020-07-03T08:24:04.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-05-09T12:38:47.000Z (over 1 year ago)
- Last Synced: 2024-07-17T10:13:19.766Z (4 months ago)
- Language: Elixir
- Homepage:
- Size: 55.7 KB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Telegex.Marked
[](http://hex.pm/packages/telegex_marked)
[](https://hexdocs.pm/telegex_marked/api-reference.html)
[](https://t.me/elixir_telegex)
Markdown parsing/rendering library customized for Telegram.
As an optional enhanced support, this library is part of [Telegex](https://github.com/Hentioe/telegex). To build a reliable bot program that can safely send complex messages, it is recommended to use this library to participate in development.
## Background introduction
For Telegram bots, sending messages in Markdown format is very dangerous. There are **many problems with Telegram server support for Markdown**.
### Like this
Create a link containing `](` in the text:
```elixir
markdown = "[[Google](](https://google.com)"
```
Set `parse_mode` to `Markdown` or `Markdown2`, and send:
```elixir
Telegex.send_message(chat_id, markdown, parse_mode: "MarkdownV2")
```
As a result, there was an accident:
```elixir
{:error,
%Telegex.Model.Error{
description:
"Bad Request: can't parse entities: Can't find end of TextUrl entity at byte offset 14",
error_code: 400
}}
```
You can choose to escape certain characters, but in the face of dynamic text (such as getting the user's name), it is still very dangerous.
## Installation
Add telegex_marked to your `mix.exs` dependencies:
```elixir
def deps do
[{:telegex_marked, "~> 0.1.0"}]
end
```
Run the `mix deps.get` command to install.
## Features
This library has customized support for `MarkdownV2` to solve these situations. It renders Markdown as HTML, and the HTML is relatively safe.
Not only that, when the wrong Markdown format appears, it can still be parsed as safe HTML. To avoid the failure of sending messages.
All Markdown elements supported (including nesting support):
````elixir
markdown = """
*bold*
_italic_
__underline__
~strikethrough~
*bold _italic bold ~italic bold strikethrough~ __underline italic bold___ bold*
[inline URL](http://www.example.com/)
[inline mention of a user](tg://user?id=123456789)
`inline fixed-width code`
```
pre-formatted fixed-width code block
```
```python
pre-formatted fixed-width code block written in the Python programming language
```
"""
````
The converted HTML text:
```elixir
html = """
bold
italic
underline
strikethrough
bold italic bold italic bold strikethrough underline italic bold bold
inline URL
inline mention of a user
inline fixed-width code
pre-formatted fixed-width code block
pre-formatted fixed-width code block written in the Python programming language
"""
```
Call the `Telegex.Marked.as_html/2` function and test:
```elixir
assert Telegex.Marked.as_html(markdown) == html
```
You only need to convert the Markdown content to HTML before sending, and then specify `parse_mode` as `HTML`.
The general Markdown parser cannot complete this task because the Markdown format supported by Telegram is incomplete and not standard.