Coder Social home page Coder Social logo

isabella232 / buffer-icons Goto Github PK

View Code? Open in Web Editor NEW

This project forked from bufferapp/buffer-icons

0.0 0.0 0.0 2.86 MB

Custom Buffer fonts for all!

Home Page: https://icons.buffer.com/0.17.0/buffer-icons.html

JavaScript 36.46% HTML 52.20% CSS 11.34%

buffer-icons's Introduction

Buffer Icon Fonts

Purpose

Buffer Icon Fonts is a fast, easy and flexible font generator for creating custom icon based webfonts for use across all devices.

Usage

In your page's <head>, include the icon stylesheet from the CDN with the version of your choosing. See the releases tab for all available version numbers. Example for version 0.9.0:

<link rel="stylesheet" href="https://icons.buffer.com/0.9.0/buffer-icons.css" />

Now you can use these icons. Adjust the font-size and color in your css to customize the icons.

<i class="bi-circle-twitter"></i>

Setup

To get started, you'll need to install a couple dependencies to generate the font files. These are dependencies of the grunt-webfont package.

$ brew install ttfautohint fontforge --with-python

Now lets install all the dependencies for node. Install grunt if you haven't already.

$ npm install -g grunt-cli
$ npm install

Add a new icon

Once all the dependencies are installed you simply add the .svg files you want to be included into the font into the 'src/icons' directory and run the grunt command.

The font, less and html files can be found in the dist directory.

Release new version to CDN

To release a new set of icons, use the following steps:

  1. Update your changes and ensure you check in your changes in the dist directory. These will be the files published to the CDN.

  2. Bump the version number in the package.json file to a higher number. Use semantic versioning for your update. For example, adding new icons would dictate a minor (0.3.0) increase, fixing an existing icon could be a patch increase (0.4.1). After the new version is pushed to master on github, move to step 3.

  3. Head over to the releases tab and click "Draft a new release." For the tag version, use the version number from step 2 and add a title of your choosing. In the description add any information on changes to icons in that release.

  4. Click "Publish release." Jenkins will automatically grab this and publish your new files to the CDN w/ your new version number. Update the version number in your <link> tag and you're good to go!

buffer-icons's People

Contributors

djfarrelly avatar alex-ray avatar hamstu avatar pioul avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.