{"id":38113569,"url":"https://github.com/cloud-gov/pages-uswds-11ty","last_synced_at":"2026-01-16T22:06:41.195Z","repository":{"id":38339875,"uuid":"471496915","full_name":"cloud-gov/pages-uswds-11ty","owner":"cloud-gov","description":"An 11ty SSG template using USWDS","archived":false,"fork":false,"pushed_at":"2025-10-02T18:25:42.000Z","size":1980,"stargazers_count":19,"open_issues_count":13,"forks_count":13,"subscribers_count":12,"default_branch":"main","last_synced_at":"2025-10-02T20:30:01.143Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/cloud-gov.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":"CODEOWNERS","security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2022-03-18T19:46:19.000Z","updated_at":"2025-10-02T18:25:46.000Z","dependencies_parsed_at":"2024-08-29T21:36:32.638Z","dependency_job_id":"faeec802-bd8e-489d-a1bc-3e1c35fa4474","html_url":"https://github.com/cloud-gov/pages-uswds-11ty","commit_stats":null,"previous_names":[],"tags_count":0,"template":true,"template_full_name":null,"purl":"pkg:github/cloud-gov/pages-uswds-11ty","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cloud-gov%2Fpages-uswds-11ty","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cloud-gov%2Fpages-uswds-11ty/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cloud-gov%2Fpages-uswds-11ty/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cloud-gov%2Fpages-uswds-11ty/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cloud-gov","download_url":"https://codeload.github.com/cloud-gov/pages-uswds-11ty/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cloud-gov%2Fpages-uswds-11ty/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28484748,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-16T11:59:17.896Z","status":"ssl_error","status_checked_at":"2026-01-16T11:55:55.838Z","response_time":107,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":"2026-01-16T22:06:40.430Z","updated_at":"2026-01-16T22:06:41.187Z","avatar_url":"https://github.com/cloud-gov.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"# 11ty-uswds-template\n\n## Why this project\n\nThis is an [11ty](https://www.11ty.dev/) static site generator (SSG) template using [U.S. Web Design System v 3.0 (USWDS)](https://designsystem.digital.gov/) and is focused on providing developers a starter template and reference implementation for Federalist/Cloud.gov Pages websites.\n\nThis project strives to be compliant with requirements set by [21st Century IDEA Act](https://www.meritalk.com/articles/senate-passes-idea-act/). The standards require that a website or digital service:\n\n- is accessible to individuals with disabilities;\n- has a consistent appearance;\n- does not duplicate any legacy websites (the legislation also requires agencies to ensure that legacy websites are regularly reviewed, removed, and consolidated);\n- has a search function;\n- uses an industry standard secure connection;\n- “is designed around user needs with data-driven analysis influencing management and development decisions, using qualitative and quantitative data to determine user goals, needs, and behaviors, and continually test the website, web-based form, web-based application, or digital service to ensure that user needs are addressed;”\n- allows for user customization; and\n- is mobile-friendly.\n\n## Key Functionality\nThis repository contains the following examples and functionality:\n\n✅  Publish blog posts, press releases, announcements, etc. To modify this code, check out `blog/index.html`, which manages how the posts are listed. You should then check out `_includes/layouts/post.html` to see how individual posts are structured.\n\n✅ Publish single one-off pages. Instead of creating lots of folders throughout the root directory, you should put single pages in `pages` folder and change the `permalink` at the top of each page. Use sub-folders only when you really need to.\n\n✅  There are two different kinds of `pages`, one does not have a side bar navigation, and the other uses `_includes/sidenav.html`. You can enable this option by adding `sidenav: true` to your page front matter.\n\n```\n---\ntitle: Document with Sidenav\nlayout: layout/page\nsidenav: true\npermalink: /document-with-sidenav\n---\n```\n\n✅ [Search.gov](https://search.gov) integration - Once you have registered and configured Search.gov for your site by following [these instructions](https://federalist.18f.gov/documentation/search/), add your \"affiliate\" and \"access key\" to `_data/site.yml`. Ex.\n\n```\nsearchgov:\n\n  # You should not change this.\n  endpoint: https://search.usa.gov\n\n  # replace this with your search.gov account\n  affiliate: federalist-uswds-example\n\n  # replace with your access key\n  access_key: xX1gtb2RcnLbIYkHAcB6IaTRr4ZfN-p16ofcyUebeko=\n\n  # this renders the results within the page instead of sending to user to search.gov\n  inline: true\n```\n\nThe logic for using Search.gov can be found in `_includes/searchgov/form.html` and supports displaying the results inline or sending the user to Search.gov the view the results. This setting defaults to \"inline\" but can be changed by setting\n```\nsearchgov:\n  inline: false\n```\nin `_data/site.yml`.\n\n✅ [Digital Analytics Program (DAP)](https://digital.gov/services/dap/) integration - Once you have registered your site with DAP add your \"agency\" and optionally, `subagency` to `_data/site.yml` and uncomment the appropriate lines. Ex.\n\n```\ndap:\n  # agency: your-agency\n\n  # Optional\n  # subagency: your-subagency\n```\n\n✅ [Google Analytics](https://analytics.google.com/analytics/web/) integration - If you have a Google Analytics account to use, add your \"ua\" to `_data/site.yml` and uncomment the appropriate lines. Ex.\n\n```\nga:\n  # ua: your-ua\n```\n\n## Getting Started\n\n### Installing Dependencies\n\n`npm install`\n\nTODO\n\n### Running a Dev Instance\n\n`npm run dev`\n\nTODO\n\n## Netlify CMS\n\n\n\n### Config\n\nThe Netlify CMS can be configured in [`/admin/config.yml`](./admin/config.yml) and you will update the\n`repo` key to be your Github organization and repository name.\n\n```yml\nbackend:\n  name: github\n  repo: \u003cyour-github-org\u003e/\u003cyour-repository-name\u003e\n  base_url: https://federalistapp.18f.gov\n  auth_endpoint: external/auth/github\n  preview_context: federalist/build\n  branch: master\n  use_graphql: true\n```\n\n### Running Locally\n\nYou can run the Netlify CMS locally to more easily customize and troubleshoot the CMS to you content.\nWe provide comments in the [`/admin/config.yml`](./admin/config.yml) instructing you how to change the `backend` values from your production site to the local development.\n\n\u003e *Note: Make sure to not commit and push the config with the `backend` set for local develop to Github or\nelse you will break your production site's Netlify CMS.\n\n```yml\n# Local development backend\nbackend:\n  name: git-gateway\nlocal_backend: true\n```\n\nOnce you [`/admin/config.yml`](./admin/config.yml) is set to local development, you run `npm run dev:cms` to\nserve as a development authentication server.\n\n## How To\n\n### Adding Collections\n\nTODO\n\n### Adding Static Data\n\nTODO\n\n### Creating links\n\nFor preview links generated on the platform, we automatically set the `pathPrefix` in the [`.eleventy.js`](/.eleventy.js) file base on the `BASEURL` environment variable. We use the built-in 11ty filter for `url` to properly append the prefix path for the linked page.  When adding new links, use the following syntax:\n\n```liquid\n\u003ca href=\"/myDir/\"\u003eLink to My Dir\u003c/a\u003e\n```\n\nSee the [11ty docs](https://www.11ty.dev/docs/filters/url/)\n\n### Referencing Images\n\nAll of your images will be stored in the `_img/` directory. To reference your images in your templates you can use the `shortcodes` built into the template.\n\nFor referencing an image without a style class, you will pass the template shortcode the image's source path and the alternative image name in that order. ie:\n\n```\n{% image \"_img/my-image.png\" \"My PNG Image Alternative Name\" %}\n```\n\nFor referencing an image with a style class, you will pass the template shortcode the image's source path, class names, and the alternative image name in that order. ie:\n\n```\n{% image_with_class \"_img/my-image.png\" \"img-class another-class\" \"My PNG Image Alternative Name\" %}\n```\n\n### Referencing USWDS Sprite Icons\n\nUSWDS has sprite icons available for use. Here is the [list of icons](https://designsystem.digital.gov/components/icon/) available when using the sprite shortcode `uswds_icon` in the template. The following example is how you can reference the icon in a template.\n\n```\n{% uswds_icon \"\u003cUSWDS sprite name\u003e\" %}\n```\n\n### Expanding SCSS Styles\n\nCSS and SASS can be added or imported into the `styles/styles.scss`. You can also use [USWDS Design Tokens](https://designsystem.digital.gov/design-tokens/) in the `styles/themes` files to update colors, fonts, and layout to fit your site's branding. This template uses [esbuild](https://esbuild.github.io/)and [autoprefixer](https://github.com/postcss/autoprefixer) to bundle your SASS/CSS and fingerprint the files in the site build.\n\n### Adding custom Javascript\n\nJavascript can be added to the admin UI or site UI by adding or importing code into the `js/admin.js` or `js/app.js` files respectively. This template uses [esbuild](https://esbuild.github.io/) to bundle your javascript and fingerprint the files in the site build.\n\n### Customizing 11ty\n\nTODO\n\n## Contributing\n\nSee [CONTRIBUTING](CONTRIBUTING.md) for additional information.\n\n## Public domain\n\nThis project is in the worldwide [public domain](LICENSE.md). As stated in [CONTRIBUTING](CONTRIBUTING.md):\n\n\u003e 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](https://creativecommons.org/publicdomain/zero/1.0/).\n\u003e\n\u003e 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.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcloud-gov%2Fpages-uswds-11ty","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcloud-gov%2Fpages-uswds-11ty","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcloud-gov%2Fpages-uswds-11ty/lists"}