streamich / octicons

A scalable set of icons handcrafted with <3 by GitHub

Octicons

Octicons are a scalable set of icons handcrafted with <3 by GitHub.

Adding/Updating an icon

To begin working with this repository you'll need to run script/bootstrap. This installs everything needed. Currently there's a requirement of Sketch to be able to edit and export the SVG files.

Open up the octicons-master.sketch file. Edit the slice you want to update, or add a new one. Save the file. If you've added a new icon, you'll need to add a new entry and keywords for it in the data.json file. Run script/build. This will export the octicons from the sketch file, minify them, and output into lib/*/build/svg directories.

Libraries

This repository is a repository containing other packages. Each of them are in the lib/ folder and give access to octicons on a different platform / language.

Package	Version
octicons Node.js package with Javascript API
octicons Ruby gem with Ruby API
octicons_helper Rails helper for using octicons
jekyll-octicons Jekyll plugin for using octicons

License

(c) GitHub, Inc.

When using the GitHub logos, be sure to follow the GitHub logo guidelines.

Code License: MIT
Applies to all other files