www.aleph1.co.uk Git - yaffs-website/blob - node_modules/videojs-font/README.md

   1 # Video.js Icon Font
   2
   3 This project contains all of the tooling necessary to generate a new icon font for Video.js. The icons themselves are from
   4 Google's [Material Design Icons](https://github.com/google/material-design-icons).
   5
   6 ## Usage
   7
   8 ```
   9 $ npm install grunt-cli // only if you don't already have grunt installed
  10 $ npm install
  11 $ grunt
  12 ```
  13
  14 ## Making changes to the font
  15
  16 To make changes to the font, simply edit the `icons.json` file. You can add or remove icons, either by just selecting new
  17 SVGs from the [Material Design set](https://www.google.com/design/icons/), or pulling in new SVGs altogether.
  18
  19 ```json
  20 {
  21   "font-name": "VideoJS",
  22   "root-dir": "./node_modules/material-design-icons/",
  23   "icons": [
  24     {
  25       "name": "play",
  26       "svg": "av/svg/production/ic_play_arrow_48px.svg"
  27     },
  28     {
  29       "name": "pause",
  30       "svg": "av/svg/production/ic_pause_48px.svg"
  31     },
  32     {
  33       "name": "cool-custom-icon",
  34       "svg": "neato-icon.svg",
  35       "root-dir": "./custom-icons/neato-icon.svg"
  36     }
  37   ]
  38 }
  39 ```
  40
  41 Once you're done, simply run `grunt` again to regenerate the fonts and scss partial. To edit the `_icons.scss` partial,
  42 update `templates/scss.hbs`.