us_web_design_standards: U.S. Web Design Standards style assets gem

Provides the style assets from the U.S. Web Design Standards as a Ruby Gem.

Provides plugins for use with Jekyll-based web sites. Other frameworks may be supported in the future.

Usage

This gem is compatible with both Jekyll and Rails.

Jekyll

In your Gemfile, include the following:

group :jekyll_plugins do
  gem 'us_web_design_standards'
end

Add a uswds.scss file to your project in the asset directory of your choosing that contains at least the following:

---
---

@import "us_web_design_standards";

Integrate the generated uswds.css file and its styles into your project's layouts and templates, build the site per usual, and observe the results.

Rails

In your Gemfile, include the following:

gem 'us_web_design_standards'

In your app/assets/stylesheets/application.scss, add the following:

/*
 * = require us_web_design_standards
 * = require us_web_design_standards_fonts
 */

In your app/assets/javascripts/application.js, add the following:

/*
 * = require vendor/jquery-1.11.3.min.js
 * = require components.js
 */

Rails should automatically compile the images included within the assets, but if there are issues where it is unable to find images, you might need to explicitly add the images_path to the asset pipeline configuration (likely found in config/initializers/asset.rb) to include something like this:

Rails.application.config.assets.paths << USWebDesignStandards::Assets.images_path

Development

First, choose a Jekyll site you'd like to use to view the impact of your updates and clone its repository; then clone this repository into the same parent directory. For example, to use the 18F Guides Template:

$ git clone [email protected]:18F/guides-template.git
$ git clone [email protected]:18F/us_web_design_standards_gem.git

In the Gemfile of the Jekyll site's repository, include the following:

group :jekyll_plugins do
  gem 'us_web_design_standards_gem', :path => '../us_web_design_standards_gem'
end

Public domain

This project is in the worldwide public domain. As stated in CONTRIBUTING:

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.