markdown-it-fontawesome

Markdown-it plugin that adds Font Awesome 5 icons support

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
markdown-it-fontawesome
0.3.06 years ago8 years agoMinified + gzip package size for markdown-it-fontawesome in KB

Readme

markdown-it-fontawesome
Markdown-itmarkdown-it plugin that adds Font Awesomefontawesome icons support. Turn this: ```md Hello World! :fa-flag: ``` Into this: ```html

Hello World!

```

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: ``` Gets converted to: ```html

Hello World!

```

Font Awesome 5+ example

```md Hello World! :fal-flag: ``` gets converted to: ```html

Hello World!

```

Credits

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

License

MIT