herrbertling / font-library

:card_index: An open source project to tag and organize Google Fonts

Font Library

Contributing

The are over 700 Google Fonts, let's organize them!

Background

Font Library is built with Jekyll and AngularJS, but you don't need to know either to add or edit the tags — you only need to know how to edit a file.

Each font family is stored as an object in families.json. Each family has an array of tags.

Adding/editing families.json guidelines

• Use double quotes "
• Do not delete or change the first tag, this is the classification defined by Google
• Keep the list alphabetical by family name
• Tags are lowercase
• Each font should have no more than 5 tags
• Avoid creating new tags that are similar to already established tags, instead consolidate or rename all similar tags if a different tag name is more intuitive
• Avoid ambiguous names for tags; make the tag name intuitive (Would you use this tag to find font X?)
• The family name must match the Google Font family name exactly

View families.json

Help wanted

You're welcome to edit families.json to add, edit, or improve tags. I recommend starting by tagging fonts that you often want to find for yourself -- curate your own tag! It's likely that someone else will dig your collection.

Want to help, but don't know where to start? Open your browser's Console:

• Help wanted! These fonts need to be added to families.json — if Google adds a new font, but we haven't added it to families.json yet, then the Console will log it along with the exact entry you can copy and paste into families.json. Feel free to add additional tags to the entry.
• New font alert! — if a family has less than 2 tags, then the Console will log it. Open the provided link to the specimen page and read the description to get ideas for tags. Try to use tags that are already established, but create new tags when necessary.

Creating a pull request or issue

Please create a pull request or create an issue to add/edit tags or to add newly added Google fonts.

When creating a pull request, it's helpful to:

• Double check your tags and ask yourself if it's something that you would use to find fonts
• Provide a brief description of the tags your added or changed
• Edit tags in small batches (<20 edits) to make reviewing quicker and easier

If you're new to Github, I'm happy to walk you through it. I recommend reading Creating an issue and Creating a pull request. If you need help with your pull request, create an issue and tag me in it @katydecorah and I'll help.

Building

Font Library is built with Jekyll. If you're just updating tags in families.json, you don't need to build the site locally. But you can if you prefer to see your changes before you submit a pull request.

To build it locally, you will need to:

• Install Jekyll
• Install Bundler: bundle install

To build the site:

rake serve

or

bundle exec jekyll serve --watch

To test the site run:

rake test

License

The MIT License (MIT)

Font tag data is licensed under CC0 1.0 Universal (CC0 1.0)