https://github.com/vlad-iakovlev/telegram-md

Telegram MarkdownV2 formatter
https://github.com/vlad-iakovlev/telegram-md

markdown markdown-parser npm-package telegram

Last synced: about 2 months ago
JSON representation

Telegram MarkdownV2 formatter

• Host: GitHub
• URL: https://github.com/vlad-iakovlev/telegram-md
• Owner: vlad-iakovlev
• License: mit
• Created: 2022-07-19T19:24:53.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-07-28T20:50:21.000Z (5 months ago)
• Last Synced: 2024-07-31T10:17:50.220Z (5 months ago)
• Topics: markdown, markdown-parser, npm-package, telegram
• Language: TypeScript
• Homepage:
• Size: 947 KB
• Stars: 11
• Watchers: 2
• Forks: 1
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# telegram-md

Telegram MarkdownV2 formatter

![GitHub CI](https://img.shields.io/github/actions/workflow/status/vlad-iakovlev/telegram-md/ci.yml?branch=main&label=github-ci)

[![Codecov](https://img.shields.io/codecov/c/github/vlad-iakovlev/telegram-md/main)](https://codecov.io/gh/vlad-iakovlev/telegram-md)

[![NPM](https://img.shields.io/npm/v/@vlad-yakovlev/telegram-md)](https://www.npmjs.org/package/@vlad-yakovlev/telegram-md)

`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](#how-to-install)

2. [Usage Examples](#usage-examples)

3. [API Documentation](#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 = md`Hello, ${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.

### Markdown

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

### md

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

```ts

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

```

### md.build

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

```ts

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

md.build('Hello, World!') // => 'Hello, World\\!'

```

### md.bold

```ts

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

```

### md.italic

```ts

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

```

### md.underline

```ts

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

```

### md.strikethrough

```ts

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

```

### md.spoiler

```ts

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

```

### md.link

```ts

md.link('inline URL', 'http://www.example.com/') // => Markdown with value '[inline URL](http://www\\.example\\.com/)'

md.link('inline mention of a user', 'tg://user?id=123456789') // => Markdown with value '[inline mention of a user](tg://user?id\\=123456789)'

```

### md.inlineCode

```ts

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

```

### md.codeBlock

````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

```

````