{"id":21619082,"url":"https://github.com/usds/uswds-jekyll","last_synced_at":"2025-07-24T11:15:05.034Z","repository":{"id":13247670,"uuid":"73382402","full_name":"usds/uswds-jekyll","owner":"usds","description":null,"archived":false,"fork":false,"pushed_at":"2022-12-11T19:08:11.000Z","size":12782,"stargazers_count":14,"open_issues_count":16,"forks_count":15,"subscribers_count":5,"default_branch":"master","last_synced_at":"2024-04-13T19:53:54.865Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"SCSS","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/usds.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-11-10T13:00:35.000Z","updated_at":"2023-05-10T19:51:27.000Z","dependencies_parsed_at":"2023-01-11T20:20:04.640Z","dependency_job_id":null,"html_url":"https://github.com/usds/uswds-jekyll","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/usds%2Fuswds-jekyll","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/usds%2Fuswds-jekyll/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/usds%2Fuswds-jekyll/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/usds%2Fuswds-jekyll/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/usds","download_url":"https://codeload.github.com/usds/uswds-jekyll/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244277179,"owners_count":20427312,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-24T23:07:50.763Z","updated_at":"2025-03-18T18:19:54.990Z","avatar_url":"https://github.com/usds.png","language":"SCSS","funding_links":[],"categories":[],"sub_categories":[],"readme":"# USWDS + Jekyll\n\nA boilerplate for using the [U.S. Web Design System](https://designsystem.digital.gov/) (USWDS) v 2.8.0 and [USWDS Gulp](https://github.com/uswds/uswds-gulp) to build basic static websites and quick prototypes with [Jekyll](https://jekyllrb.com/).\n\nFor a fully-featured, officially supported gem see [18F's USWDS Jekyll project](https://github.com/18F/uswds-jekyll).\n\n**Related docs**\n\n- [USWDS documentation](https://designsystem.digital.gov/how-to-use-uswds/)\n- [USWDS Gulp documentation](https://github.com/uswds/uswds-gulp#readme)\n- [Jekyll documentation](https://jekyllrb.com/docs/home/)\n\n## Setup\n\n### Prerequisites\n\n- [Ruby](https://www.ruby-lang.org/en/documentation/installation/)\n  - [Bundler](https://bundler.io/)\n- [Node](https://nodejs.org/)\n- [Gulp CLI](https://gulpjs.com/docs/en/getting-started/quick-start)\n\n### Install and run\n\n```\n$ npm install\n$ npm start\n```\n\nAfter installing dependencies from NPM, `npm install` additionally runs Bundler to install Ruby gems required by Jekyll.\n\n`npm start` runs `bundle exec jekyll start --livereload`, and spins a demo page up at `http://localhost:4000`. Changes will automatically refresh in the browser.\n\n## Customization\n\n### Erase demo files\n\nThe demo styles in `/assets/stylesheets/demo` and placeholder markup in `index.html` can be erased once the project is running locally.\n\n### Stylesheets\n\nThe main SCSS manifest is `assets/stylesheets/application.scss`. USWDS theme files are imported from `assets/uswds-theme`, and USWDS is imported from `node_modules/uswds`. In this implementation, all of USWDS is imported by default. For a custom configuration, comment/uncomment the desired USWDS components in the manifest.\n\nProject CSS is located in `assets/stylesheets/`. Create directories and `.scss` to suit project needs and `@import` them in `application.scss`. USWDS tokens/variables/etc will be accessible across custom stylesheets.\n\n### JavaScript\nJavaScript is imported and concatenated into `assets/js/application.js`. Importants are handled with Jekyll’s `include_relative` method.\n\nPlace scripts in `assets/js` and link to them in `assets/javascripts/application.js`.\n\n## Maintenance\n\n### Update USWDS without changing theme settings\n\nEdit the USWDS version number in `package.json`, then ...\n\n```\n$ npm install\n$ gulp update\n```\n\n`npm install` will update USWDS files (and any other dependencies, too) in `node_modules`.\n\n`gulp update` copies fonts, images, JS, and builds SASS. It skips the `copy-uswds-setup` portion of `gulp init`, which would overwrite existing theme settings in `assets/uswds-theme`. Check that USWDS updates haven't altered the setup of theme files. Double check that updates haven't changed paths referenced in `assets/stylesheets/application.scss`.\n\n### Reset USWDS\n\nTo reset USWDS and USWDS theme settings, run ...\n\n```\n$ gulp init\n```\n\nThis will re-run the initial Gulp setup as per `gulpfile.js`. This copies USWDS files to `assets/`, including `assets/uswds-theme`. Any customization to USWDS theme settings will be overwritten with defaults.\n\nAfter running, additional configuration may be needed to get `uswds-theme` working. See the [USWDS settings documentation](https://designsystem.digital.gov/documentation/settings/) for help.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fusds%2Fuswds-jekyll","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fusds%2Fuswds-jekyll","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fusds%2Fuswds-jekyll/lists"}