https://github.com/drewish/jekyll-font-awesome-sass
A plugin to add Font Awesome to your Jekyll site
https://github.com/drewish/jekyll-font-awesome-sass
List: jekyll-font-awesome-sass
font-awesome jekyll jekyll-plugin
Last synced: 4 months ago
JSON representation
A plugin to add Font Awesome to your Jekyll site
- Host: GitHub
- URL: https://github.com/drewish/jekyll-font-awesome-sass
- Owner: drewish
- License: mit
- Created: 2017-06-15T03:03:45.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2025-03-13T02:54:40.000Z (over 1 year ago)
- Last Synced: 2025-11-08T09:01:27.623Z (7 months ago)
- Topics: font-awesome, jekyll, jekyll-plugin
- Language: Ruby
- Size: 8.79 KB
- Stars: 29
- Watchers: 1
- Forks: 10
- Open Issues: 3
-
Metadata Files:
- Readme: README.markdown
- License: LICENSE.txt
Awesome Lists containing this project
README
# Jekyll Font Awesome SASS
*A plugin to add the [FontAwesome::Sass](https://github.com/FortAwesome/font-awesome-sass) framework to your Jekyll site.*
## Installation
Add the following to your site's `Gemfile`:
```ruby
gem 'jekyll-font-awesome-sass'
```
And add the following to your site's `_config.yml` file:
```yaml
plugins:
- jekyll-font-awesome-sass
```
## Usage
Create a `.scss` file (e.g., `assets/style.scss`), with the following:
```scss
---
---
$fa-font-path: "fonts/font-awesome/";
@import 'font-awesome';
// (Your custom CSS Here)
```
When your site is built, Jekyll will automatically add the Font Awesome framework before it renders your site's css. In the above example, the resulting file would be `assets/style.css` with Font Awesome's CSS followed by your own.
## Assets
By default, Jekyll Font Awesome SaSS will simply make the `@import 'font-awesome';` directive available to your custom stylesheets so that you can more easily include Font Awesome's CSS.
If you would like to use Font Awesome's static assets (e.g., fonts, javascripts), you'll need to add the following to your site's `_config.yml`:
```yml
font-awesome:
assets: true
```
This will create `/assets/fonts/font-awesome` and `assets/javascripts/font-awesome` folders in the generated site, which you can include in your site's header as you would any other javascript file or font.
## Specifying the Font Awesome version
`jekyll-font-awesome-sass` relies on official [`font-awesome-sass` Ruby gem](https://github.com/FortAwesome/font-awesome-sass). To specify the version of Font Awesome used, simply specify the `font-awesome-sass` gem version in your Gemfile.
## Credits
Just about everything in this gem is this is blatantly ripped off from [jekyll-bootstrap-sass](https://github.com/benbalter/jekyll-bootstrap-sass). It saved me a bunch of time getting this going.