-
Notifications
You must be signed in to change notification settings - Fork 8
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Skoropad Aleksandr
committed
May 3, 2021
1 parent
194d106
commit 57515a4
Showing
1 changed file
with
42 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,42 @@ | ||
Description 1 | ||
# Telegramify-Markdown | ||
|
||
[![CircleCI](https://circleci.com/gh/skoropadas/telegramify-markdown.svg?style=svg)](https://circleci.com/gh/skoropadas/telegramify-markdown) | ||
|
||
Telegramify-Markdown is a Markdown | ||
to [Telegram-specific-markdown](https://core.telegram.org/bots/api#formatting-options) converter, based | ||
on [Unified](https://github.com/unifiedjs/unified) and [Remark](https://github.com/remarkjs/remark/). | ||
|
||
## Install | ||
|
||
```bash | ||
npm install telegramify-markdown | ||
``` | ||
|
||
## Usage | ||
|
||
```js | ||
const telegramifyMarkdown = require('telegramify-markdown'); | ||
const markdown = ` | ||
# List of items | ||
* item 1 | ||
* item 2 | ||
* item 3 | ||
[here is an example.](https://example.com) | ||
`; | ||
|
||
telegramifyMarkdown(markdown); | ||
/* | ||
*List of items* | ||
• item 1 | ||
• item 2 | ||
• item 3 | ||
[here is an example\.](https://example.com) | ||
/ | ||
* | ||
``` | ||
[MIT Licence](LICENSE) |