Exciting release!Introducing "safe npm". Learn more
Socket
Log inDemoInstall

markdown-it-icons

Package Overview
Dependencies
3
Maintainers
1
Versions
25
Issues
File Explorer

Advanced tools

markdown-it-icons

Plugin for markdown-it, supports emoji icons and font-awesome icons.

    0.4.1latest
    Github

Version published
Maintainers
1
Weekly downloads
361
decreased by-42.52%

Weekly downloads

Readme

Source

markdown-it-icons

Plugin for markdown-it, supports emoji icons and font-awesome icons.

Installation

yarn add markdown-it-icons

Usage

for node.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') // <p>I <i class="e1a-heart"></i> you</p> mdi.render('A :fa-car: runs') // <p>A <i class="fa fa-car"></i> runs</p>

for browser

You also need to import the css:

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

FAQs

Last updated on 18 Dec 2017

Did you know?

Socket installs a Github app to automatically flag issues on every pull request and report the health of your dependencies. Find out what is inside your node modules and prevent malicious activity before you update the dependencies.

Install Socket
Socket
support@socket.devSocket SOC 2 Logo

Product

  • Package Issues
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc