Skip to content

Stirreg/styleguide

 
 

Repository files navigation

Readme Build Status

Installation

  1. Make sure you have the correct version of node installed as defined in the package.json. Do node -v to check your version and upgrade/downgrade accordingly. You can use https://github.com/tj/n to change easily change node versions.
  2. Run installer.sh.
  3. If you run into permission errors please refer to this document: https://docs.npmjs.com/getting-started/fixing-npm-permissions.
  4. (Optional for changing fonts or images.) Configure the correct S3 settings in tasks/config.json (replace the **** placeholders, passwords are in the password manager).
  5. Add the fonts (see next step). Fonts are not included in this source because they are licensed. See your local documentation and or repositories on where to get them.

Generating webfonts

  1. (Optional for adding new fonts.) Designer hands off original files (TTF, WOFF, or something else, but hopefully one of these).
  2. (Optional for adding new fonts.) Use https://www.fontsquirrel.com/tools/webfont-generator to generate the correct versions of the webfonts, follow these steps:
    • Upload the fonts.
    • Pick expert mode 😄.
    • Check TTF, WOFF and WOFF2.
    • Choose Arial to match x-height, as Arial is our first fallback font.
  3. Add the fonts to the this repo, in the src/fonts folder.
  4. Make sure the paths to the fonts are generated, by publishing the fonts (gulp fonts:clean && gulp fonts:rev && gulp fonts:release).
  5. Adjust the font-settings in the theme specific _settings.scss file.
  6. Make sure the @font-face rule is generated: check if the @webfont mixin is used for this font.
  7. Now you're ready for testing the new font.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • CSS 91.2%
  • JavaScript 8.5%
  • Other 0.3%