markdown-it-fontawesome's Introduction

markdown-it-fontawesome

Markdown-it plugin that adds Font Awesome icons support.

Turn this:

Hello World! :fa-flag:

Into this:

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

Install

$ npm install markdown-it-fontawesome --save

Usage

Enable plugin

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

md().use(fa);

Font Awesome version 4 example

Hello World! :fa-flag:

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

Gets converted to:

<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

Hello World! :fal-flag:

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

gets converted to:

<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>

Credits

Original: https://github.com/nunof07

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

License

MIT

markdown-it-fontawesome's People

Contributors

Stargazers

Watchers

markdown-it-fontawesome's Issues

regex only works for icon with additional '-' prefixes

This works only for fa-home but wont work with fa-pause-circle or fa-pause-circle-o

Doesn't seem to work for Hexo

Endpoint

output:

Endpoint
:fab-google: Google
:fab-github: GitHub

package.json has "markdown-it-fontawesome": "^0.3.0" and html has use.fontawesome.com/releases/v5.6.1/css/all.css

Loads plugins directly into the page without using a package system.

This is a great plugin, is it possible to use it directly like other markdown-it plugins?

Usage with package:

var md = require('markdown-it');
var fa = require('markdown-it-fontawesome');
 
md().use(fa);

Direct use I mean:
var md = window.markdownit().use(window.markdownitFontAwesome);

How do you use this plugin in Angular?

Sorry, this is more a question than an issue. Can this component be used with Angular?
If yes than how?
Thank you in advance!

Recommend Projects

React

A declarative, efficient, and flexible JavaScript library for building user interfaces.

Vue.js

🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

Typescript

TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

TensorFlow

An Open Source Machine Learning Framework for Everyone

Django

The Web framework for perfectionists with deadlines.

Laravel

A PHP framework for web artisans

D3

Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

javascript

JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

web

Some thing interesting about web. New door for the world.

server

A server is a program made to process requests and deliver data to clients.

Machine learning

Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

Visualization

Some thing interesting about visualization, use data art

Game

Some thing interesting about game, make everyone happy.

Recommend Org

Facebook

We are working to build community through open source technology. NB: members must have two-factor auth.

Microsoft

Open source projects and samples from Microsoft.

Google

Google ❤️ Open Source for everyone.

Alibaba

Alibaba Open Source for everyone

D3

Data-Driven Documents codes.

Tencent

China tencent open source team.

nunof07 / markdown-it-fontawesome Goto Github PK