{"repo":"uswds/uswds-site","free":true,"listed":false,"github":"https://github.com/uswds/uswds-site","clone":"git clone https://github.com/uswds/uswds-site.git","description":"The U.S. Web Design System documentation website, a design system for the federal government.","language":"HTML","stars":247,"topics":["design-system","documentation","uswds","federal-government","web-design-and-development"],"license":null,"category":"ui-components","readme_excerpt":"U.S. Web Design System (USWDS) Documentation Website Welcome! This repository contains the code for the U.S. Web Design System (USWDS) documentation website . If you're looking for the main USWDS components and codebase, head over to our USWDS repository. --- Running the Website Locally This site is built using: - Jekyll, a static site generator - Gulp.js, for task automation - USWDS npm package, stable version Follow the steps below to set up the site on your local machine. Prerequisites Before getting started, make sure you have the following installed: 1. Git – Installation guide 2. Ruby – Version specified in .ruby-version or .tool-versions - Installation guide 3. Node.js – Version specified in .nvmrc or .tool-versions - Installation guide 4. Bundler – Version specified in .bundler-version - Installation guide ⚠️ Ubuntu 20.04 Users If you encounter this error: Fix it by running: --- Installation 1. Clone the repository: 2. Navigate into the project folder: 3. Install dependencies: 4. Start the local server: 5. View the site in your browser: Open http://127.0.0.1:4000 to see the site running locally. --- Useful Commands Here are some additional commands you may find helpful: - npm run clean – Removes copied dependency assets. - npm run lint – Runs eslint and sass-lint to check for coding issues. - npm test – Runs all tests and linters. - npm run watch – Watches for changes and automatically rebuilds the site. - npm start -- --incremental or npm run serve – Runs the site wi","default_branch":null,"files":null,"tree":[],"storefront":"/r/uswds","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/uswds/uswds-site/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}