uswds/uswds-assets

Name: uswds-assets

Owner: U.S. Web Design System

Description: U.S. Web Design System visual design assets

Created: 2015-06-18 21:03:50.0

Updated: 2018-05-22 17:56:51.0

Pushed: 2018-05-22 17:56:50.0

Homepage: https://designsystem.digital.gov

Size: 66353

Language: JavaScript

GitHub Committers

UserMost Recent Commit# Commits

Other Committers

UserEmailMost Recent Commit# Commits

README

U.S. Web Design System Design Assets

This repository hosts editable, open source design files of the U.S. Web Design System for government designers or anyone wishing to make use of the UI components or visual style guide in this site. The following file types are available for your use and can be found in their corresponding folders:

Colors
Components
Fonts

Preview files have been made available for the Sketch, Omnigraffle, and EPS so you can see how each file is structured and it?s content.

We encourage and solicit your input. Please leave any feedback in the project?s primary repo, which you?ll find here: https://github.com/uswds/uswds

Installing the color palettes

You have a few options for working with our color palette: You can either use the color swatches included in the Illustrator and Sketch sticker sheet files, or you can install the ASE or Sketch Palette files. To install the files, follow the directions below, and let us know if you run into any difficulty.

Sketch

Some single-function components, such as buttons, have been turned into symbols for easy access from the symbol menu. Before you alter anything (except text), detach the instance of the symbol so that you don?t change every instance. We?ve left more complex components, such as footers, as groups.

Wherever appropriate, we?ve created type styles and layer styles to make these components easier to adapt.

Style and symbol names are a compromise between U.S. Web Design System CSS naming conventions (which allow us to transition Sketch files more easily into development) and names that make sense in the context of screen design.

Illustrator
Omnigraffle
Generating archive files

To help with the distribution of these assets, the project uses npm run scripts to generate four types of zip archives. These zip archives are used in the uswds documentation website.

Generating these files requires node, npm, and the zip command line tool. To get started, you need to install the dependencies for this project locally.

install

After you?ve installed these dependencies, generate the four zip archives for each supported release based on file extension: omnigraffle, eps, ai, & sketch.

release
Updating the USWDS documentation site

These archive files generated by npm run release may then be manually copied over to the files directory of the USWDS Site for distribution on the For Designers - Getting Started page.

Testing the current supported file extensions

To ensure the existence of all of the files necessary to generate a release, we?ve included some smoke tests in this project. Running the following command will run the smoke tests to verify that all necessary files for a release are in the project:

test
Licenses and attribution
A few parts of this project are not in the public domain

The files in Fonts/Merriweather.zip and Fonts/Source_Sans_Pro.zip are from Google Web Fonts, licensed under the SIL Open Font License.

The files in Fonts/Font_Awesome.zip are from Font Awesome by Dave Gandy under the SIL Open Font License 1.1.

The rest of this project is in the public domain

The rest of this project is in the worldwide public domain.

This project is in the public domain within the United States, and copyright and related rights in the work worldwide are waived through the CC0 1.0 Universal public domain dedication.

All contributions to this project will be released under the CC0 dedication. By submitting a pull request, you are agreeing to comply with this waiver of copyright interest.


This work is supported by the National Institutes of Health's National Center for Advancing Translational Sciences, Grant Number U24TR002306. This work is solely the responsibility of the creators and does not necessarily represent the official views of the National Institutes of Health.