Data Design Standards documentation
This repo includes code and documentation for the Data Design Standards website.
Note that this README includes steps to pull the latest version of the Data Design Standards into your local instance of the documentation.
The Data Standards documentation is built using Jekyll for the file framework, gulp for task management, and the node module for the Standards.
Before you start
You will need to have the following installed on your machine before following the commands below:
- Ruby v2.2.2+, Installation guides
- Node v4.2.3+, Installation guides
- Bundler v1.12.3+, Installation guides
- Chrome v59 or higher (v60 if on Windows)
Building the documentation with gulp
Some parts of the documentation are built using gulp.
To work on the site, switch to your local copy of the repository in terminal then run the following command to install project dependencies:
Now that all of your dependencies are installed, you can run your local server by running the following command:
127.0.0.1:4000 in your browser — you should be viewing a local instance of the Data Design Standards.
Here are a few other utility commands you may find useful:
npm run clean: Cleans out copied-over dependency assets.
npm run lint: Runs
npm test: Runs all tests and linters.
npm run watch: Runs a series of commands that watches for any changes in both the Standards node module and the root level asset folders in this repo.
Using the latest version of the
Sometimes you will want to use the latest version of the
web-design-standards repo. Follow these steps to do so:
- Clone the latest version of the
npm installto install the dependencies required for the package in the
npm run build:packageto create the built version of the Standards in the
npm linkin the root level of the
web-design-standardsdirectory on your local machine.
npm link uswdsin the root level of the
web-design-standards-docsdirectory on your local machine.
npm run watchin both project directories to have changes automatically built and compiled on changes to any asset files.
- In a new terminal window, run
npm startin the
web-design-standards-docsdirectory to start the Jekyll server locally.
You are now using the latest version of the Standards via your cloned version on your local machine. To stop using this version, type
npm unlink uswds from the root level of the
Please read through our contributing guidelines. These guidelines are directions for opening issues and submitting pull requests, and they also detail the coding and design standards we follow.