https://github.com/zignis/docsify-fa

A FontAwesome plugin for Docsify that supports custom colored icons
https://github.com/zignis/docsify-fa

docsify-plugin

Last synced: 27 days ago
JSON representation

A FontAwesome plugin for Docsify that supports custom colored icons

• Host: GitHub
• URL: https://github.com/zignis/docsify-fa
• Owner: zignis
• License: apache-2.0
• Created: 2021-09-18T18:09:17.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2022-11-17T07:46:22.000Z (almost 2 years ago)
• Last Synced: 2023-03-11T23:36:47.216Z (over 1 year ago)
• Topics: docsify-plugin
• Homepage:
• Size: 22.5 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
Inspired from [erickjx/docsify-fontawesome](https://github.com/erickjx/docsify-fontawesome), allows you to apply custom colors to the icons.

# ⚙️ Setup

Inject FontAwesome CSS files to your main html file:

```html

```

Inject the script in the same document:

```html

```

# :hammer: Usage

The syntax is `:fa(style) fa-(icon_name) ...:[c=(color_resolvable)]`, the color parameter is optional.

Text enclosed by `:fa :` will be parsed to CSS, for example:

```

:fas fa-cog:[c=#fff]

``` 

will be parsed to 

```html



```

Any of the following styles can be used: 

- `:fas fa-cog:`

- `:fas fa-cog:[c=black]`

- `:fad fa-cat:[c=#FFFFFF]`

- `:fas fa-pencil:[c=blue]`

- `:fas fa-aws:[c=hsla(120,100%,25%,0.3)]`

- `:fas fa-home:[c=rgb(0,0,255)]`.

Basically anything that works in CSS should work here.

# :link: Links

- [Font Awesome](https://fontawesome.com/)

- [Docsify](https://docsify.js.org/#/)

- [erickjx/docsify-fontawesome](https://github.com/erickjx/docsify-fontawesome)

# :ledger: License

[Apache License 2.0](https://github.com/zignis/docsify-fa/blob/main/LICENSE)