More detail info can be found at styleguide.healthcare.gov
Table of contents
- Quick start
- What's included
- Bugs and feature requests
- Running documentation locally
- Copyright and license
A couple of quick start options are available:
- Download the latest release.
- Clone the repo:
git clone https://github.com/CMSgov/HealthCare.gov-Styleguide.git.
Read the Assets landing page for information on the framework contents, templates and examples, and more.
Within the download you'll find the following directories and files, logically grouping common assets. You'll see something like this:
assets-components/ ├── css/ │ ├── bootstrap/ │ ├── cards/ │ ├── components/ │ ├── forms/ │ ├── layouts/ │ ├── all.less │ └── style.css └── fonts/ ├── Bitter-Bold.eot ├── Bitter-Italic.eot ├── Bitter-Regular.eot ├── glyphicons-halflings-regular.eot ├── OpenSans-Bold-webfont.eot ├── OpenSans-Italic-webfont.eot ├── OpenSans-Regular-webfont.eot └── OpenSans-Semibold-webfont.eot
We provide compiled CSS (
style.css), as well as the CSS Less source. Glyphicon fonts are also included. Since this styleguide's functionality is built directly on top of Bootstrap, you will need to include references to our jQuery and Bootstrap code bases in your html file:
Note: Assets.healthcare.gov gives you Section 508 compliant, cross-browser compatible UI components that you can use in your accessible web site or web application. Assets is an accessible, responsive, and modern framework.
Bugs and feature requests
HealthCare.gov's Styleguide documentation, included in this repo in the gh-pages branch root directory, is built with Jekyll and publicly hosted on GitHub Pages at https://styleguide.healthcare.gov/. The docs may also be run locally.
Running documentation locally
- If necessary, install Jekyll (requires version 2.5.x).
- Windows users: Read this unofficial guide to get Jekyll up and running without problems.
- From the gh-pages branch root directory, run
jekyll servein the command line.
- Open http://localhost:9001 in your browser, and you should see the entire Styleguide documentation run locally.
Please read through our contribution guidelines. Included are directions for opening issues, coding standards, and notes on development.
Copyright and license
As a work of the United States Government, this project is in the public domain within the United States.