telegramify-markdown
Advanced tools
Comparing version 1.0.0-beta.1 to 1.0.0
{ | ||
"name": "telegramify-markdown", | ||
"version": "1.0.0-beta.1", | ||
"version": "1.0.0", | ||
"description": "Convert markdown into Telegram-specific markdown", | ||
@@ -5,0 +5,0 @@ "main": "index.js", |
@@ -1,1 +0,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) |
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
No v1
QualityPackage is not semver >=1. This means it is not stable and does not support ^ ranges.
Found 1 instance in 1 package
20486
0
43