@code.gov/code-gov-font

Custom font with icons used by code-gov-web. Based on font-awesome. Built using fontello.

Stats

StarsIssuesVersionUpdatedCreatedSize
@code.gov/code-gov-font
210.10.1a year ago4 years agoMinified + gzip package size for @code.gov/code-gov-font in KB

Readme

code-gov-font

Custom font for icons used by code-gov-web. Based on font-awesome and icon by Hadrien. Built using fontello.

Install this font

In order to use the font on a website, you have to install it first. There's a good chance that you will have to update the paths below to match you folder structure.

@font-face {
  font-family: 'code-gov';
  src: url('../font/code-gov.eot?90902143');
  src: url('../font/code-gov.eot?90902143#iefix') format('embedded-opentype'),
       url('../font/code-gov.woff2?90902143') format('woff2'),
       url('../font/code-gov.woff?90902143') format('woff'),
       url('../font/code-gov.ttf?90902143') format('truetype'),
       url('../font/code-gov.svg?90902143#code-gov') format('svg');
  font-weight: normal;
  font-style: normal;
}

Install (this project)

  1. Clone the repo
  2. Execute npm install

Update this font

  1. Upload the config.json file from code-gov-font project to the fontello website.
  2. Use the fontello site to add/remove icons as needed
  3. Name the font code-gov and download the new package (download webfont) as a .zip
  4. Extract the .zip and copy the new config.json then use it to replace the config.json in the code-gov-font directory
  5. Run npm run build to rebuild the font
  6. At this point, the font has been updated. You can save & commit these changes for testing

Use

This project is a dependency of code-gov-style. After updating this font, a new version of this package must be released and the @code.gov/code-gov-font version must be updated in code-gov-style. Follow our Component Release instructions for details on how to do this. *Note: After these steps have been completed, you must run npm install then run npm run update-font in code-gov-style to finish the font update. And finally, in code-gov-style, update the icon list in the _fontello.scss file to add any new icons and delete any that were removed. You can find the icon unicode character ( { content: '\f253'; } ) info in the code-gov.svg file by searching for the name of the icon you just added. This info is also on the fontello site under the Customize Codes tab.

Fontello has some documentation on How to save and load projects that has additional info for reference.

Screen Shot 2019-10-03 at 10 58 33 AM Screen Shot 2019-10-03 at 10 58 27 AM Screen Shot 2019-06-15 at 9 25 52 AM

Questions

If you have any questions, please post a GitHub issue! :-)

Contact

Twitter: @CodeDotGov
Email: code@gsa.gov
LinkedIn: code-gov
Join our #opensource-public Slack channel: https://chat.18f.gov/

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.