This is the public repo for plainlanguage.gov, which is an online resource to help federal employees understand and comply with the Plain Writing Act of 2010. It represents a joint effort by the Plain Language Action and Information Network (PLAIN) and the General Services Administration.
-
This site uses Jekyll, a Ruby-based static site generator. For more information about using Jekyll, refer to the Jekyll documentation.
-
The site is built with the U.S. Web Design Standards, a set of reusable, high-quality components for modern websites. We're using the Web Design Standards Jekyll theme with some customized styles and Font Awesome icons.
-
The site is optimized for deployment on 18F's Federalist publishing service.
After cloning the repo, install Jekyll and any necessary dependencies using:
npm install
bundle install
To run the site locally, from the project folder, run:
bundle exec jekyll serve
If all goes well, visit the site at http://localhost:4000
.
We follow the WCAG2AA standard, and one of the ways we check that we're following the right rules is through automated tools, like pa11y. For more info on the rules being tested checkout the pa11y wiki.
To run a web accessibility test on digital.gov do the following:
- Install and run the site locally following the
Running the site locally
instructions above. Site must be running locally to perform the scan.
- If this is your first time running pa11y, then you'll need to run
npm install
to make sure pa11ly is installed.
- In a separate terminal window, run
npm run test:pa11y
to initiate the accessibility checker.
Note: Accessibility testing configuration is located in the .pa11yci file.
To provide feedback on plainlanguage.gov, follow this repository and open an issue in the repo.
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.