https://github.com/tylingsoft/markdown-it-icons
Plugin for markdown-it, supports emoji icons and font-awesome icons.
https://github.com/tylingsoft/markdown-it-icons
Last synced: about 1 year ago
JSON representation
Plugin for markdown-it, supports emoji icons and font-awesome icons.
- Host: GitHub
- URL: https://github.com/tylingsoft/markdown-it-icons
- Owner: tylingsoft
- Created: 2017-01-02T02:11:29.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2017-12-18T13:49:53.000Z (over 8 years ago)
- Last Synced: 2025-03-28T07:16:40.617Z (over 1 year ago)
- Language: JavaScript
- Size: 186 KB
- Stars: 5
- Watchers: 2
- Forks: 5
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# markdown-it-icons
Plugin for markdown-it, supports emoji icons and font-awesome icons.
## Installation
```
yarn add markdown-it-icons
```
## Usage
### for node.js
```js
import markdownIt from 'markdown-it'
import markdownItIcons from 'markdown-it-icons'
const mdi = markdownIt()
mdi.use(markdownItIcons, 'emoji')
mdi.use(markdownItIcons, 'font-awesome')
mdi.render('I :heart: you') //
I you
mdi.render('A :fa-car: runs') // A runs
```
### for browser
You also need to import the css:
```js
import 'markdown-it-icons/dist/index.css'
```
Or you can add the css to the web page directly.
## Development
### Build
```
yarn build:watch
```
### Test
```
yarn test
```
### Distribution
```
yarn release && npm publish
```
## Todo