telegram-md

Telegram MarkdownV2 formatter

!GitHub CI

telegram-md is a powerful TypesScript library designed to simplify the formatting of text messages in Telegram MarkdownV2 format. It provides a range of methods for applying markdown formatting, such as bold, italic, and links, making it easier to create richly formatted messages programmatically.

Table of Contents

1. How to Install
2. Usage Examples
3. API Documentation

How to install

``sh
npm install @vlad-yakovlev/telegram-md
`

Usage Examples

`ts
import { md } from '@vlad-yakovlev/telegram-md'

// Simple message formatting
const message = mdHello, ${md.bold('World')}!
api.sendMessage(chatId, md.build(message))

// Using different formatting styles
const complexMessage = md
This is an ${md.italic('italic')}
and ${md.bold('bold')} text
with a ${md.link('link', 'http://example.com')}!

api.sendMessage(chatId, md.build(complexMessage))
`

API Documentation

Every method escapes all unescaped input. Input is assumed to be escaped only when it's an instance of Markdown.

$3

Stores the result of executing md methods. Used to differentiate between normal strings and escaped strings.

$3

Template tag which can be used to build markdown formatted messages.

`ts
mdHello, ${md.bold('World')}! // => Markdown with value 'Hello, World\\!'
`

$3

Returns message text that cat be safely sent to telegram API.

`ts
md.build(mdHello, ${md.bold('World')}!) // => 'Hello, World\\!'
md.build('Hello, World!') // => 'Hello, World\\!'
`

$3

`ts
md.bold('bold text') // => Markdown with value 'bold \text'
`

$3

`ts
md.italic('italic text') // => Markdown with value '_italic \text_'
`

$3

`ts
md.underline('underline') // => Markdown with value '__underline__'
`

$3

`ts
md.strikethrough('strikethrough') // => Markdown with value '~strikethrough~'
`

$3

`ts
md.spoiler('spoiler') // => Markdown with value '||spoiler||'
`

$3

`ts
md.link('inline URL', 'http://www.example.com/') // => Markdown with value 'inline URL'
md.link('inline mention of a user', 'tg://user?id=123456789') // => Markdown with value 'inline mention of a user'
`

$3

`ts
md.inlineCode('inline fixed-width code') // => Markdown with value 'inline fixed\\-width code'
`

$3

`ts
md.blockquote('blockquote') // => Markdown with value '>blockquote'
`

$3

``ts
md.code(
'pre-formatted fixed-width code block',
) // => Markdown with value
`
pre\\-formatted fixed\\-width code block
`
``

``ts
md.code(
'pre-formatted fixed-width code block written in the Python',
'python',
) // => Markdown with value
`python
pre\\-formatted fixed\\-width code block written in the Python
`
```