gitmyhub

octicons

JavaScript ★ 8.7k updated 16d ago

A scalable set of icons handcrafted with ❤️ by GitHub

Octicons is GitHub's official SVG icon library, with packages for JavaScript, React, Ruby, Rails, and Jekyll so you can use the same icons that appear across GitHub's own interface in your own projects.

JavaScriptTypeScriptReactRubyRailsJekyllSVGsetup: easycomplexity 2/5

Octicons is the official icon library built and used by GitHub. The icons are SVG files, which means they scale to any size without losing quality. This repository is where GitHub maintains those icons and the various packages that let developers use them in their own projects.

The repository is organized around several packages targeting different platforms. For JavaScript and Node.js projects, there is a core package with a JavaScript API plus a React-specific package that wraps each icon as a component you can drop into a React app. There is also a styled version of the React package that works with the Styled System library for applying spacing and color props directly on icon elements.

For Ruby projects, there are three packages: a plain Ruby gem with a Ruby API, a Rails helper that makes it easier to insert icons in Rails templates, and a Jekyll plugin for using octicons in Jekyll-generated static sites.

All packages share the same underlying SVG source files stored in this repository. When GitHub updates or adds an icon, the change flows through to all the platform packages from a single source.

The icon set is used across GitHub's own web interface, so it reflects the visual language GitHub has developed for its product. Contributions from outside GitHub staff are welcome for bug reports and feedback, but adding new icons to the library requires an internal review process. The code is MIT-licensed; the GitHub logo icons themselves are subject to GitHub's separate logo usage guidelines.

Where it fits