From f5f387711a87555ea5c7b4988e4510975512a324 Mon Sep 17 00:00:00 2001 From: Ashwin Maroli Date: Sun, 11 Dec 2016 15:35:46 +0530 Subject: [PATCH 1/3] update documentation on updating FontAwesome Iconset --- docs/_docs/contributing.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/docs/_docs/contributing.md b/docs/_docs/contributing.md index c5a37722..662c60c0 100644 --- a/docs/_docs/contributing.md +++ b/docs/_docs/contributing.md @@ -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. + +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 +2. Click `Import Icons` on the top-horizontal-bar and upload `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 `/docs/`. + - Copy the contents of `selection.json` and overwrite existing content inside `/docs/icomoon-selection.json`. + - Copy the entire `@font-face {}` declaration and only the **new-icon(s)' css declarations** further below, to update the + `/docs/_sass/_font-awesome.scss` sass partial. + - Fix paths in the `@font-face {}` declaraion 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. From 8a89f033ad0b67a71f5df5940e634c3acf02ff3a Mon Sep 17 00:00:00 2001 From: Ashwin Maroli Date: Sun, 11 Dec 2016 19:52:22 +0530 Subject: [PATCH 2/3] fix errors. --- docs/_docs/contributing.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/_docs/contributing.md b/docs/_docs/contributing.md index 662c60c0..0099c08a 100644 --- a/docs/_docs/contributing.md +++ b/docs/_docs/contributing.md @@ -71,25 +71,25 @@ 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 +### 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. 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 -2. Click `Import Icons` on the top-horizontal-bar and upload `icomoon-selection.json` -3. Click `Add Icons from Library..` further down on the page, and add 'Font Awesome' +1. Go to . +2. Click `Import Icons` on the top-horizontal-bar and upload the existing `/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 +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 `/docs/`. - Copy the contents of `selection.json` and overwrite existing content inside `/docs/icomoon-selection.json`. - Copy the entire `@font-face {}` declaration and only the **new-icon(s)' css declarations** further below, to update the `/docs/_sass/_font-awesome.scss` sass partial. - - Fix paths in the `@font-face {}` declaraion by adding `../` before `fonts/FontAwesome.???` like so: - `('../fonts/Fontawesome.woff?9h6hxj')` + - Fix paths in the `@font-face {}` declaration by adding `../` before `fonts/FontAwesome.*` like so: + `('../fonts/Fontawesome.woff?9h6hxj')`. ### Adding plugins From 109dceee3dfe35ebba51e4706d9c19d926943f1e Mon Sep 17 00:00:00 2001 From: Ashwin Maroli Date: Sun, 18 Dec 2016 07:45:08 +0530 Subject: [PATCH 3/3] move changes to /.github/ and regenerate site --- .github/CONTRIBUTING.markdown | 20 ++++++++++++++++++++ docs/_docs/contributing.md | 2 +- 2 files changed, 21 insertions(+), 1 deletion(-) diff --git a/.github/CONTRIBUTING.markdown b/.github/CONTRIBUTING.markdown index 9e9e479c..6a239fc7 100644 --- a/.github/CONTRIBUTING.markdown +++ b/.github/CONTRIBUTING.markdown @@ -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 . +2. Click `Import Icons` on the top-horizontal-bar and upload the existing `/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 `/docs/`. + - Copy the contents of `selection.json` and overwrite existing content inside `/docs/icomoon-selection.json`. + - Copy the entire `@font-face {}` declaration and only the **new-icon(s)' css declarations** further below, to update the + `/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. diff --git a/docs/_docs/contributing.md b/docs/_docs/contributing.md index 0099c08a..9ccac293 100644 --- a/docs/_docs/contributing.md +++ b/docs/_docs/contributing.md @@ -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: