octicons 4.2.0

  • README.md
  • CHANGELOG.md
  • Installing
  • Versions
  • 38

GitHub Octicons

NPM version Build Status

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

Install

NPM

This repository is distributed with npm. After installing npm, you can install octicons with this command.

$ npm install --save octicons

Usage

The source files included are written in Sass (scss) You can simply point your sass include-path at your node_modules directory and import it like this.

@import "octicons/index.scss";

Changing, adding, or deleting icons

  1. Open the Sketch document in /lib/. Each icon exists as an artboard within our master Sketch document. If you’re adding an icon, duplicate one of the artboards and add your shapes to it. Be sure to give your artboard a name that makes sense.
  2. Once you’re happy with your icon set, choose File > Export…
  3. Choose all the artboards you’d like to export and then press “Export”
  4. Export to /lib/svg/

You’ll next need to build your Octicons.

Building Octicons

All the files you need will be in the /build/ directory already, but if you’ve made changes to the /lib/ directory and need to regenerate, follow these steps:

  1. Open the Octicons directory in Terminal
  2. Run the command script/bootstrap. This will install any necessary dependencies for generating the Octicons font and SVGs.
  3. Run the command grunt. Running the grunt task will generate the font and SVGs, placing them in the /build/ directory.

License

(c) 2012-2016 GitHub, Inc.

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

Font License: SIL OFL 1.1
Applies to all font files and SVG files

Code License: MIT
Applies to all other files

Fixes:

  • Removing inline sourcemap from min versions of css.

4.2.0

Adds:

  • Keywords.json file that has an index of all octicons with alias names

4.1.1 (June 16, 2016)

Fixes:

  • Putting the $octicons-font-path back in the scss file.

4.1.0 (June 6, 2016)

Adds:

  • Installation docs https://github.com/primer/octicons/pull/94
  • grabber
  • plus-small

Modifies:

  • smiley

Refines:

  • Renames mail-reply to reply and refines its shape.

Fixes:

  • Revert license back to SPDX standard

4.0.0 (June 6, 2016)

Adds:

  • Whole new grunt build system including svg sprite sheet.
  • adding css min https://github.com/primer/octicons/pull/60
  • adding woff2 format https://github.com/primer/octicons/issues/3
  • creates spritesheet of svg files https://github.com/primer/octicons/issues/88

Removes:

  • Bower support

Fixes:

  • all svg icons include viewBox https://github.com/primer/octicons/issues/87
  • license in package.json https://github.com/primer/octicons/issues/85

3.5.0 (February 12, 2016)

Adds:

  • unverified

Refines:

  • verified

3.4.1 (January 24, 2016)

This includes various SVG viewport refinements.

Refines:

  • thumbs-down
  • logo-github

3.4.0 (January 22, 2016)

Adds:

  • verified
  • smiley

Removes:

  • color-mode

Refines:

  • primitive-dot
  • horizontal-rule
  • triangle-down
  • triangle-up
  • triangle-left
  • triangle-right
  • globe
  • flame
  • comment-discussion

3.3.0 (November 12, 2015)

Adds:

  • logo-gist

Resizes all our SVG to be 16x16 instead of 1024x1024

3.2.0 (November 6, 2015)

Adds:

  • bold
  • text-size
  • italic
  • tasklist

It also normalizes some styling in:

  • list-unordered
  • list-ordered
  • quote
  • mention
  • bookmark
  • threebars

Removes

  • screen-normal
  • screen-full

3.1.0 (August 13, 2015)

Adds

  • shield

This thickens stroke widths slightly on the following icons:

  • circle-slash
  • clock
  • cloud-upload
  • cloud-download
  • dashboard
  • info
  • issue-closed
  • issue
  • issue-reopened
  • history
  • question
  • search

Fills comment-discussion

Thickens x to match checkmark

3.0.1 (August 10, 2015)

Some files were missing in 3.0.0

3.0.0 (August 10, 2015)

Removes

  • microscope
  • beer
  • split
  • puzzle
  • steps
  • podium
  • timer
  • all alignment icons
  • all move icons
  • all playback icons
  • all jump icons

Adds

  • beaker
  • bell
  • desktop-download
  • watch

Line-weight changes, sizing normalization, and new drawings

  • circle-slash
  • lock
  • cloud-upload
  • cloud-download
  • plus
  • broadcast
  • lock
  • all repo icons
  • organization
  • person
  • all chevrons & triangles
  • all diff icons
  • clippy
  • all issue and circular icons
  • rss
  • ruby
  • cancel
  • settings
  • mirror
  • external-link
  • history
  • gear
  • settings
  • info
  • history
  • package
  • gist-secret
  • rocket
  • law
  • telescope
  • search
  • tag
  • normal-screen
  • iphone
  • no-new-line
  • desktop
  • all git icons
  • circuit-board
  • heart
  • home
  • briefcase
  • wiki
  • bookmark
  • briefcase
  • calendar
  • color-mode
  • comment
  • discussions
  • credit-card
  • dashboard
  • camera
  • video
  • bug
  • desktop
  • ellipses
  • eye
  • all files & folders
  • fold
  • unfold
  • gift
  • graph
  • hubot
  • inbox
  • jersey
  • keyboard
  • light-bulb
  • link
  • location
  • mail
  • mail-read
  • marker
  • plug
  • mute
  • pencil
  • push-pin
  • fullscreen
  • unfullscreen
  • server
  • sign-in
  • sign-out
  • tag
  • terminal
  • thumbs-up
  • thumbs-down
  • trash
  • unmute
  • versions
  • gist
  • key
  • megaphone
  • checklist

2.4.1 (June 2, 2015)

  • Add the scss file I forgot to include

2.4.0 (June 2, 2015)

  • Add octicons.scss
  • Revert path changes to sprockets-octicons.scss, as they broke octicons in sprockets.

2.3.0 (May 28, 2015)

  • Add a path variable to sprockets-octicons.scss to be consistent with octicons.less`

2.2.3 (May 21, 2015)

  • Use SPDX license identifiers in package.json

2.2.2 (April 1, 2015)

Fixes file icons for

  • file-binary
  • file-code
  • file-media
  • file-pdf
  • file-symlink-file
  • file-text
  • file-zip

2.2.1 (March 30, 2015)

  • Fix vector artifact and smooth curves in mark-github

2.2.0 (Feb 18, 2015)

  • Add two new icons: thumbsup and thumbsdown

2.0.1 (June 16, 2014)

  • Add mention of github.com/logos to the license

2.0.0 (June 16, 2014)

  • Hello world

1. Depend on it

Add this to your package's pubspec.yaml file:


dependencies:
  octicons: "^4.2.0"

2. Install it

You can install packages from the command line:

with pub:


$ pub get

with Flutter:


$ flutter packages get

Alternatively, your editor might support pub get or packages get. Check the docs for your editor to learn more.

Version Uploaded Documentation Archive
4.2.0 Jul 3, 2016 Go to the documentation of octicons 4.2.0 Download octicons 4.2.0 archive

Analysis

This feature is new.
We welcome feedback.
More details: scoring.

We analyzed this package, and provided a score, details, and suggestions below.

  • completed on Feb 3, 2018
  • Dart: 2.0.0-dev.20.0
  • pana: 0.10.1

Scores

Popularity:
Describes how popular the package is relative to other packages. [more]
0 / 100
Health:
Code health derived from static analysis. [more]
100 / 100
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
41 / 100
Overall score:
Weighted score of the above. [more]
38

Platforms

Detected platforms: Flutter, web, other

No libraries.

Suggestions

  • The description is too short.

    Add more detail about the package, what it does and what is its target use case. Try to write at least 60 characters.

  • Maintain an example.

    Create a short demo in the example/ directory to show how to use this package. Common file name patterns include: main.dart, example.dart or you could also use octicons.dart.