Skip to content

Latest commit

 

History

History
84 lines (57 loc) · 3.75 KB

README.md

File metadata and controls

84 lines (57 loc) · 3.75 KB
Raw

Fontello - icon font scissors

CI Gitter

website: fontello.com, help: wiki

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. 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 - quick load iconic font from your project via CLI & save result back.
  • 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 - Ruby CLI gem for interacting with the API. Additional features (Sass conversion) for Rails integration, but should work for every project.
  • grunt-fontello - lightweight integration with grunt

Authors

Thanks to:

License

Fontello's code (all files, except fonts) is distributed under MIT license. See 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 :)