Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/fontello/fontello

Iconic fonts scissors
https://github.com/fontello/fontello

Last synced: 21 days ago
JSON representation

Iconic fonts scissors

Awesome Lists containing this project

README 

        
Fontello - icon font scissors

=============================



[![CI](https://github.com/fontello/fontello/workflows/CI/badge.svg?branch=master)](https://github.com/fontello/fontello/actions)

[![Gitter](https://badges.gitter.im/fontello/fontello.svg)](https://gitter.im/fontello/fontello)



website: [fontello.com](https://fontello.com/), help: [wiki](https://github.com/fontello/fontello/wiki/Help)



[![](https://opencollective.com/puzrin/tiers/baker.svg?width=770)](https://opencollective.com/puzrin#category-CONTRIBUTE)



This tool lets you combine icon webfonts for your own project. With fontello you can:



1. shrink glyph collections, minimizing font size

2. merge symbols from several fonts into a single file

3. access large sets of professional-grade open source icons



## Developers API



Fontello allows easy scripting, to implement different convenient features:



1. Open site from command line, with your configuration, and import edited project

    - [Makefile example](https://gist.github.com/puzrin/5537065). That's a live working code, used

      for development of fontello itself.

2. Writing website plugins, to import/export icons via admin panel.



When more examples available, those will be added here.



### API methods



1. `POST https://fontello.com/` creates a session with your config and

   return you `session_id`. You can use it later to open fontello with your configuration

   and to automatically download your font. Session is stored for 24h. POST params

   (form-encoded):

    - `config` - (Required) content of `config.json` for your font

    - `url` - (Optional) if used, download button will link to your admin panel, where you can

      run importing script.

2. `https://fontello.com/[session_id]` - opening fontello with your config preloaded.

   When you edit font, your config is automatically sent to server

3. `https://fontello.com/[session_id]/get` - download your font.



Note. When you open site via API url, `download` button will have another text.



### Examples



* [Makefile](https://gist.github.com/puzrin/5537065) - quick load iconic font

  from your project via CLI & save result back.

* [fontello-cli](https://github.com/paulyoung/fontello-cli) - the same, as above,

  but written in `node.js`. If you don't like `make` utility, then

  `fontello-cli` is for you :)

* [fontello_rails_converter](https://github.com/railslove/fontello_rails_converter) - Ruby CLI gem for interacting with the API.  Additional features (Sass conversion) for Rails integration, but should work for every project.

* [grunt-fontello](https://github.com/jubalm/grunt-fontello) - lightweight integration with grunt



## Authors



- Roman Shmelev ([shmelev](https://github.com/shmelev)).

- Vitaly Puzrin ([puzrin](https://github.com/puzrin)).

- Aleksey Zapparov ([ixti](https://github.com/ixti)).

- Evgeny Shkuropat ([shkuropat](https://github.com/shkuropat)).

- Vladimir Zapparov ([dervus](https://github.com/dervus)).

- Alex Kocharin ([rlidwka](https://github.com/rlidwka)).



Thanks to:



- [Werner Lemberg](https://github.com/lemzwerg) for help with ttfautohint.

- [Hermanto Lim](https://github.com/nackle2k10) for the image.



## License



Fontello's code (all files, except fonts) is distributed under MIT license. See

[LICENSE](https://github.com/fontello/fontello/blob/master/LICENSE) file for details.



Embedded fonts are distributed under their primary licenses (SIL OFL / CC BY / CC BY-SA).

See fonts info on fontello website for credits & links to homepages. This info is also

included in generated font archives for your convenience (see LICENSE.txt file).



Generated fonts are intended for web usage, and should not be

considered/distributed as independent artwork. Consider fontello a

"font archiver" and credit original font creators according to their respective license.



Crediting fontello is not required :)