# markdown-it-fontawesome

> Markdown-it plugin that adds Font Awesome 5 icons support

Latest version **0.3.0** (published 2018-05-17) · MIT license · 0 weekly downloads

## Install

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

## 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.3.0 |
| Published | 2018-05-17 |
| First published | 2015-12-02 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 12.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 21 |
| Author | Nuno Freitas |
| Maintainers | nunof |
| Keywords | markdown-it-plugin, markdown-it, markdown, fontawesome |

## Links

- npm: https://www.npmjs.com/package/markdown-it-fontawesome
- Repository: https://github.com/nunof07/markdown-it-fontawesome
- Homepage: https://github.com/nunof07/markdown-it-fontawesome#readme
- Issues: https://github.com/nunof07/markdown-it-fontawesome/issues
- npm.io page: https://npm.io/package/markdown-it-fontawesome

## Dependencies (1)

- [markdown-it-regexp](https://npm.io/package/markdown-it-regexp.md) ^0.4.0

## 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.3.0 (latest) — 2018-05-17
- 0.2.0 — 2016-01-27
- 0.1.0 — 2015-12-02

## README

# markdown-it-fontawesome
[Markdown-it][markdown-it] plugin that adds [Font Awesome][fontawesome] icons support.

Turn this:

```md
Hello World! :fa-flag:
```

Into this:

```html
<p>Hello World! <i class="fa fa-flag"></i></p>
```


## Install
```bash
$ npm install markdown-it-fontawesome --save
```



## Usage


### Enable plugin

```js
var md = require('markdown-it');
var fa = require('markdown-it-fontawesome');

md().use(fa);
```


### Font Awesome version 4 example

```md
Hello World! :fa-flag:

- [:fa-google: Google](https://www.google.com/)
- [:fa-github: GitHub](https://github.com/)
```

Gets converted to:

```html
<p>Hello World! <i class="fa fa-flag"></i></p>
<ul>
<li><a href="https://www.google.com/"><i class="fa fa-google"></i> Google</a></li>
<li><a href="https://github.com/"><i class="fa fa-github"></i> GitHub</a></li>
</ul>
```


### Font Awesome 5+ example


```md
Hello World! :fal-flag:

- [:fab-google: Google](https://www.google.com/)
- [:fab-github: GitHub](https://github.com/)
```

gets converted to: 

```html
<p>Hello World! <i class="fal fa-flag"></i></p>
<ul>
<li><a href="https://www.google.com/"><i class="fab fa-google"></i> Google</a></li>
<li><a href="https://github.com/"><i class="fab fa-github"></i> GitHub</a></li>
</ul>
```


[markdown-it]: https://github.com/markdown-it/markdown-it
[fontawesome]: https://fortawesome.github.io/Font-Awesome/


### Credits 

Original: https://github.com/nunof07

Font awesome 5 support and tests: https://github.com/rjjakes


### License

MIT

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