Installations

npm install @gerhobbelt/markdown-it-fontawesome

Developer Guide

BETA

Typescript

No

Module System

CommonJS

Min. Node Version

>=10

Node Version

12.12.0

NPM Version

6.11.3 Score

68.6

Supply Chain

95.8

Quality

75.1

Maintenance

100

Vulnerability

100

License

Pull Requests

Open

3

Total

5

Closed

0

Merged

2

Issues

Open

2

Total

4

Closed

2

Releases

Unable to fetch releases

Contributors

2

Unable to fetch Contributors

View All 2 Contributors

Languages

1

JavaScript

JavaScript (100%)

Love this project? Help keep it running — sponsor us today! 🚀

Developer

nunof07

Download Statistics

Total Downloads

1,782

Last Day

1

Last Week

2

Last Month

22

Last Year

289

GitHub Statistics

MIT License

20 Stars

11 Commits

3 Forks

1 Watchers

4 Branches

2 Contributors

Updated on Dec 13, 2024

Bundle Size

1.02 kB

Minified

567.00 B

Minified + Gzipped

Bundlephobia

Maintainers

1

Package Meta Information

Latest Version

0.3.0-3

Package Id

@gerhobbelt/markdown-it-fontawesome@0.3.0-3

Unpacked Size

14.71 kB

Size

3.42 kB

File Count

13

NPM Version

6.11.3

Node Version

12.12.0

Total Downloads

Cumulative downloads

Total Downloads

1,782

Last Day

0%

1

Compared to previous day

Last Week

-75%

2

Compared to previous week

Last Month

120%

22

Compared to previous month

Last Year

0.3%

289

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

1

@gerhobbelt/markdown-it-regexp

Dev Dependencies

10

@gerhobbelt/markdown-it @gerhobbelt/markdown-it-testgen @gerhobbelt/prepend-header camelcase chai cross-env eslint microbundle mocha nyc

markdown-it-fontawesome

Markdown-it plugin that adds Font Awesome icons support.

Turn this:

1Hello World! :fa-flag:

Into this:

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

Install

1$ npm install @gerhobbelt/markdown-it-fontawesome --save

Usage

Enable plugin

1var md = require('@gerhobbelt/markdown-it');
2var fa = require('@gerhobbelt/markdown-it-fontawesome');
3
4md().use(fa);

Font Awesome version 4 example

1Hello World! :fa-flag:
2
3- [:fa-google: Google](https://www.google.com/)
4- [:fa-github: GitHub](https://github.com/)

Gets converted to:

1<p>Hello World! <i class="fa fa-flag"></i></p>
2<ul>
3<li><a href="https://www.google.com/"><i class="fa fa-google"></i> Google</a></li>
4<li><a href="https://github.com/"><i class="fa fa-github"></i> GitHub</a></li>
5</ul>

Font Awesome 5+ example

1Hello World! :fal-flag:
2
3- [:fab-google: Google](https://www.google.com/)
4- [:fab-github: GitHub](https://github.com/)

gets converted to:

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

Credits

Original: https://github.com/nunof07

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

License

MIT

No vulnerabilities found.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

5

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

1

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Maintained

Determines if the project is "actively maintained".

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

SAST

Determines if the project uses static code analysis.

Score

2.5

/10

Last Scanned on 2025-02-03

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More