uswds-rails

The uswds-rails gem eases the use of the US Web Design Standards with Ruby on Rails applications.

Usage

At the moment, we've confirmed that the fonts and stylesheets in this repo work in Rails apps. JavaScript is TBD.

Until this gem is released, you can load it via GitHub:

gem 'uswds-rails', github: '18F/uswds-rails-gem'

Then bundle and include the stylesheets in your manifest in this order:

# app/assets/stylesheets/application.scss

@import 'uswds_rails_overrides/core/defaults';
@import 'uswds/all';
@import 'uswds_rails_overrides/all';

Now, all of the standard USWDS css is available in your rails app. To learn more, visit the docs.

Contributing

See CONTRIBUTING for additional information.

Upgrading gem to use a new version of the US Web Design Standards

Someday, we hope to automate this. For now, here is how to manually update to a new version of the design standards.

1. Download the latest version of the standards locally

$ npm install --save uswds

1. Remove the existing vendored assets

$ rm vendor/assets/stylsheets/uswds/*

1. Copy the downloaded assets into the correct location in vendor

$ mv node_modules/uswds/src/stylesheets/* vendor/assets/stylesheets/uswds/

1. Repeat for fonts, images, and javascripts.

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.