-
-
Notifications
You must be signed in to change notification settings - Fork 9.9k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update documentation on updating FontAwesome Iconset #5655
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👍 for the idea. Just some small things i noticed.
@@ -71,6 +71,26 @@ You can find the documentation for jekyllrb.com in the [docs](https://github.com | |||
|
|||
One gotcha, all pull requests should be directed at the `master` branch (the default branch). | |||
|
|||
### Updating FontAwesome package for jekyllrb.com | |||
|
|||
We recently moved to using a stripped-down version of FontAwesome iconset on the site, consisting of only those icons that we actually use here. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe the FontAwesome inconset
? Sounds better IMHO.
|
||
If you ever need to update our documentation with an icon that is not already available in our custom iconset, you'll have to regenerate the iconset using Icomoon's Generator: | ||
|
||
1. Go to <https://icomoon.io/app/> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think there should be a .
at the end of each instruction.
If you ever need to update our documentation with an icon that is not already available in our custom iconset, you'll have to regenerate the iconset using Icomoon's Generator: | ||
|
||
1. Go to <https://icomoon.io/app/> | ||
2. Click `Import Icons` on the top-horizontal-bar and upload `icomoon-selection.json` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[...] upload the existing docs/icomoon-selection.json file.
- Copy the contents of `selection.json` and overwrite existing content inside `<jekyll>/docs/icomoon-selection.json`. | ||
- Copy the entire `@font-face {}` declaration and only the **new-icon(s)' css declarations** further below, to update the | ||
`<jekyll>/docs/_sass/_font-awesome.scss` sass partial. | ||
- Fix paths in the `@font-face {}` declaraion by adding `../` before `fonts/FontAwesome.???` like so: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There is a typo in declaration
. And i think fonts/FontAwesome.*
looks better, ???
seems to me like something is missing :)
Thank you for the feedback @Crunch09. 😃. Will update shortly. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you! Our build process actually overwrites this file from .github/CONTRIBUTING.md. Can you move this new content there and run rake site:generate
to generate the site file?
@@ -71,6 +71,26 @@ You can find the documentation for jekyllrb.com in the [docs](https://github.com | |||
|
|||
One gotcha, all pull requests should be directed at the `master` branch (the default branch). | |||
|
|||
### Updating FontAwesome iconset for jekyllrb.com | |||
|
|||
We recently moved to using a stripped-down version of FontAwesome iconset on the site, consisting of only those icons that we actually use here. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe just "We use a custom version of FontAwesome which contains just the icons we use." 4 years from now this will still say "recently" 😆
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
lol.. yeah, valid point. 😆 I'll update.
@jekyllbot: merge +site |
Addresses #5650
Adds a comprehensive section to
contributing.md
Leaves
docs/readme.md
as is..--
/cc @jekyll/documentation