# markdown-it-twitter

> Twitter mentions and hashtag links in markdown-it

Latest version **0.0.2** (published 2021-11-25) · MIT license · 0 weekly downloads

## Install

```sh
npm install markdown-it-twitter
pnpm add markdown-it-twitter
yarn add markdown-it-twitter
bun add markdown-it-twitter
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.2 |
| Published | 2021-11-25 |
| First published | 2021-11-25 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 28.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Kristian Freeman |
| Maintainers | signalnerve |
| Keywords | markdown-it-plugin, markdown-it, twitter |

## Links

- npm: https://www.npmjs.com/package/markdown-it-twitter
- Repository: https://github.com/signalnerve/markdown-it-twitter
- Issues: https://github.com/signalnerve/markdown-it-twitter/issues
- npm.io page: https://npm.io/package/markdown-it-twitter

## Alternatives

- [@mdxeditor/editor](https://npm.io/package/@mdxeditor/editor.md) — 962.4K weekly downloads
- [mmdb-lib](https://npm.io/package/mmdb-lib.md) — 680.9K weekly downloads
- [playcanvas](https://npm.io/package/playcanvas.md) — 36.2K weekly downloads
- [@glw907/cairn-cms](https://npm.io/package/@glw907/cairn-cms.md) — 967 weekly downloads
- [markdown-to-confluence](https://npm.io/package/markdown-to-confluence.md) — 103 weekly downloads

## Recent versions

- 0.0.2 (latest) — 2021-11-25
- 0.0.1 — 2021-11-25

## README

# markdown-it-twitter

very wip markdown parsing for twitter hashtags/mentions

forked from https://github.com/flowdock/markdown-it-flowdock

> flowdock hashtag (`#tag`), mentions (`@user`) and relaxed autolink plugin for [markdown-it](https://github.com/markdown-it/markdown-it) markdown parser.

* `@user` => `<a class="mention" href="https://twitter.com/user" target="_blank">@user</a>`
* `#hashtag` => `<span class="hashtag">#hashtag</span>`

## Install

```bash
npm install markdown-it-twitter --save
```

```js
var md = require('markdown-it')().use(require('markdown-it-twitter'));

md.render('Test #hashtag @user'); 
// 'Test <span class="hashtag">#hashtag</span> <a class="mention" href="https://twitter.com/user" target="_blank">@user</a>'
```

## Tests

Tests are run with npm:

```bash
npm install
npm test
```

---
_Source: https://npm.io/package/markdown-it-twitter · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._