Permalink
Browse files

move changes to /.github/ and regenerate site

  • Loading branch information...
1 parent 8a89f03 commit 109dceee3dfe35ebba51e4706d9c19d926943f1e @ashmaroli ashmaroli committed Dec 18, 2016
Showing with 21 additions and 1 deletion.
  1. +20 −0 .github/CONTRIBUTING.markdown
  2. +1 −1 docs/_docs/contributing.md
@@ -66,6 +66,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 use a custom version of FontAwesome which contains just the icons we use.
+
+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 the existing `<jekyll>/docs/icomoon-selection.json`.
+3. Click `Add Icons from Library..` further down on the page, and add 'Font Awesome'.
+4. Select the required icon(s) from the Library (make sure its the 'FontAwesome' library instead of 'IcoMoon-Free' library).
+5. Click `Generate Font` on the bottom-horizontal-bar.
+6. Inspect the included icons and proceed by clicking `Download`.
+7. Extract the font files and adapt the CSS to the paths we use in Jekyll:
+ - Copy the entire `fonts` directory over and overwrite existing ones at `<jekyll>/docs/`.
+ - 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 {}` declaration by adding `../` before `fonts/FontAwesome.*` like so:
+ `('../fonts/Fontawesome.woff?9h6hxj')`.
+
### Adding plugins
If you want to add your plugin to the [list of plugins](https://jekyllrb.com/docs/plugins/#available-plugins), please submit a pull request modifying the [plugins page source file](https://github.com/jekyll/jekyll/blob/master/docs/_docs/plugins.md) by adding a link to your plugin under the proper subheading depending upon its type.
@@ -73,7 +73,7 @@ One gotcha, all pull requests should be directed at the `master` branch (the def
### 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.
+We use a custom version of FontAwesome which contains just the icons we use.
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:

0 comments on commit 109dcee

Please sign in to comment.