1.0.1 • Published 3 years ago

kswds v1.0.1

Weekly downloads
1
License
CC0-1.0
Repository
github
Last release
3 years ago

State of Kansas Web Design System

The same USWDS you know and love, with Kansas theming!

Forked from the NASA Web Design System.

KS Theme customizations

  • Minor tweaks to colors in _uswds-theme-color.scss
  • Headings use helvetica instead of source sans pro font in _uswds-theme-typography.scss
  • Kansas favicons in theme/favicons
  • Dark header option and other minor visual tweaks in _uswds-theme-custom-styles.scss
    • To use the dark header option, add the .usa-header--dark class to the <header> element.
    • For the close icon in the mobile slideout menu to appear white instead of dark gray replace close.svg with close-white.svg in this line of html <button class="usa-nav__close"><img src="/assets/img/close.svg" alt="close"></button>

How to Use

Like USWDS, KSWDS has two installation options:

  • Direct download - Download the .zip file attached to the latest stable release under the assets section. Extract then add the files to your project's code base. For more details see this section in the USWDS developer documentation.

  • Install using npm - KSWDS is available as an npm package. To install via npm, follow these instructions, but where it says uswds replace with kswds.

For more detailed installation and usage instructions see the USWDS developer documentation.

Updates

KSWDS updates to the latest version of USWDS automagically. (thanks GitHub Actions!)

KSWDS uses a GitHub Action workflow to check for an updated version of USWDS every 15 days and updates itself automatically with the latest version on the develop branch, and releases a beta pre-release on GitHub and NPM. A two week window is provided for testing. Any issues found should be opened in this repository. After two weeks, if no unresolved issues are present in this GitHub repository, a GitHub Action workflow creates a new stable release on GitHub and NPM and merges develop into master.