├── .gitignore ├── assets ├── img │ ├── us_seal.png │ └── gsa-logo-dark.jpg └── css │ └── site.scss ├── Gemfile ├── .github └── issue_template.md ├── _data ├── navigation.yml ├── header.yml ├── footer.yml └── theme.yml ├── pages ├── docs.md └── landing.html ├── README.md ├── _config.yml ├── CONTRIBUTING.md ├── LICENSE.md └── Gemfile.lock /.gitignore: -------------------------------------------------------------------------------- 1 | _site/ 2 | .sass-cache/ 3 | .jekyll-metadata 4 | .DS_Store 5 | -------------------------------------------------------------------------------- /assets/img/us_seal.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/18F/federalist-uswds-template/HEAD/assets/img/us_seal.png -------------------------------------------------------------------------------- /assets/img/gsa-logo-dark.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/18F/federalist-uswds-template/HEAD/assets/img/gsa-logo-dark.jpg -------------------------------------------------------------------------------- /assets/css/site.scss: -------------------------------------------------------------------------------- 1 | --- 2 | --- 3 | 4 | $font-path: '../uswds/fonts'; 5 | $image-path: '../uswds/img'; 6 | 7 | @import 'uswds/all'; 8 | -------------------------------------------------------------------------------- /Gemfile: -------------------------------------------------------------------------------- 1 | source "https://rubygems.org" 2 | 3 | gem 'uswds-jekyll', :git => 'https://github.com/18F/uswds-jekyll.git' 4 | 5 | group :jekyll_plugins do 6 | gem 'jekyll-last-modified-at' 7 | end 8 | -------------------------------------------------------------------------------- /.github/issue_template.md: -------------------------------------------------------------------------------- 1 | 5 | 6 | **Template:** 7 | 8 | **Your site repo:** 9 | 10 | 11 | -------------------------------------------------------------------------------- /_data/navigation.yml: -------------------------------------------------------------------------------- 1 | primary: 2 | - text: Documentation 3 | href: /docs/ 4 | - text: Navigation section 5 | links: 6 | - text: Demo link A 7 | href: / 8 | - text: Demo link B 9 | href: / 10 | - text: Demo link C 11 | href: / 12 | 13 | footer: 14 | - text: Documentation 15 | href: /docs/ 16 | - text: Demo link one 17 | href: / 18 | - text: Demo link two 19 | href: / 20 | 21 | docs: 22 | - text: Documentation 23 | href: /docs/ 24 | - text: Installation 25 | href: / 26 | - text: Upgrading 27 | href: / 28 | - text: Help 29 | href: / 30 | -------------------------------------------------------------------------------- /pages/docs.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Documentation 3 | permalink: /docs/ 4 | 5 | layout: page 6 | sidenav: docs 7 | 8 | subnav: 9 | - text: Section one 10 | href: '#section-one' 11 | - text: Section two 12 | href: '#section-two' 13 | --- 14 | 15 | # Section one 16 | 17 | This is some content. 18 | 19 | ## Section two 20 | 21 | This is some more content. 22 | 23 | ### Section three 24 | 25 | This is some more content. 26 | 27 | #### Section four 28 | 29 | This is some more content. 30 | 31 | ##### Section five 32 | 33 | This is some more content. 34 | 35 | ###### Section six 36 | 37 | This is some more content. 38 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # U.S. Web Design Standards template for Federalist 2 | This is a Federalist site template that incorporates the [U.S. Web Design 3 | Standards] [Jekyll theme]. 4 | 5 | 6 | *development moved to [https://github.com/18F/federalist-uswds-jekyll](https://github.com/18F/federalist-uswds-jekyll)* 7 | 8 | View the [theme documentation] for more info on available [layouts] and 9 | [customization] options. 10 | 11 | [U.S. Web Design Standards]: https://standards.usa.gov 12 | [Jekyll theme]: https://jekyllrb.com/docs/themes/ 13 | [theme documentation]: https://github.com/18F/jekyll-uswds/#readme 14 | [layouts]: https://github.com/18F/jekyll-uswds/#layouts 15 | [customization]: https://github.com/18F/jekyll-uswds/#customization 16 | -------------------------------------------------------------------------------- /_data/header.yml: -------------------------------------------------------------------------------- 1 | # This is the configuration for the site header. 2 | 3 | # Set header title differently from the site's title (as defined in _config.yml). 4 | # Uncomment the following line to use the header title. 5 | # title: Header title 6 | 7 | # Show or hide the official USA banner at the top of the site. 8 | # Comment out to the following line to hide. 9 | usa_banner: true 10 | 11 | # Defines the type of header. 12 | # Header types can be 'basic' or 'extended'. 13 | # Basic - https://components.designsystem.digital.gov/components/detail/header--basic.html 14 | # Extended - https://components.designsystem.digital.gov/components/detail/header--extended.html 15 | type: extended 16 | 17 | # this is a key into _data/navigation.yml 18 | primary: 19 | links: primary 20 | 21 | # this is a key into _data/navigation.yml 22 | secondary: 23 | links: secondary 24 | -------------------------------------------------------------------------------- /_config.yml: -------------------------------------------------------------------------------- 1 | title: Site title 2 | 3 | # GitHub information 4 | # This is used for adding an edit this page link to the footer 5 | github: 6 | organization: 18F 7 | repository: federalist-uswds-template 8 | default_branch: master 9 | 10 | theme: uswds-jekyll 11 | 12 | # Configuration for Google Analytics, add your UA code here: 13 | google_analytics_ua: UA-48605964-32 14 | 15 | # Configuration for DAP, add your agency ID here: 16 | # dap_agency: GSA 17 | 18 | # Uncomment to enable AnchorJS functionality on docs layout. 19 | # See https://github.com/bryanbraun/anchorjs for more information. 20 | # anchor_js_targets: [h1, h2, h3, h4, h5, h6] 21 | 22 | # To enable search, uncomment the search section 23 | # You will need to setup a search account with search.gov 24 | # https://search.usa.gov/signup 25 | # Your search_site_handle value is from the search.gov settings page. 26 | 27 | # search_site_handle: searchgov-site-handle 28 | -------------------------------------------------------------------------------- /CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | ## Welcome! 2 | 3 | We're so glad you're thinking about contributing to an 18F open source project! If you're unsure about anything, just ask -- or submit the issue or pull request anyway. The worst that can happen is you'll be politely asked to change something. We love all friendly contributions. 4 | 5 | We want to ensure a welcoming environment for all of our projects. Our staff follow the [18F Code of Conduct](https://github.com/18F/code-of-conduct/blob/master/code-of-conduct.md) and all contributors should do the same. 6 | 7 | We encourage you to read this project's CONTRIBUTING policy (you are here), its [LICENSE](LICENSE.md), and its [README](README.md). 8 | 9 | If you have any questions or want to read more, check out the [18F Open Source Policy GitHub repository](https://github.com/18f/open-source-policy), or just [shoot us an email](mailto:18f@gsa.gov). 10 | 11 | ## Public domain 12 | 13 | This project is in the public domain within the United States, and 14 | copyright and related rights in the work worldwide are waived through 15 | the [CC0 1.0 Universal public domain dedication](https://creativecommons.org/publicdomain/zero/1.0/). 16 | 17 | All contributions to this project will be released under the CC0 18 | dedication. By submitting a pull request, you are agreeing to comply 19 | with this waiver of copyright interest. 20 | -------------------------------------------------------------------------------- /LICENSE.md: -------------------------------------------------------------------------------- 1 | As a work of the United States government, this project is in the 2 | public domain within the United States. 3 | 4 | Additionally, we waive copyright and related rights in the work 5 | worldwide through the CC0 1.0 Universal public domain dedication. 6 | 7 | ## CC0 1.0 Universal summary 8 | 9 | This is a human-readable summary of the [Legal Code (read the full text)](https://creativecommons.org/publicdomain/zero/1.0/legalcode). 10 | 11 | ### No copyright 12 | 13 | The person who associated a work with this deed has dedicated the work to 14 | the public domain by waiving all rights to the work worldwide 15 | under copyright law, including all related and neighboring rights, to the 16 | extent allowed by law. 17 | 18 | You can copy, modify, distribute and perform the work, even for commercial 19 | purposes, all without asking permission. 20 | 21 | ### Other information 22 | 23 | In no way are the patent or trademark rights of any person affected by CC0, 24 | nor are the rights that other persons may have in the work or in how the 25 | work is used, such as publicity or privacy rights. 26 | 27 | Unless expressly stated otherwise, the person who associated a work with 28 | this deed makes no warranties about the work, and disclaims liability for 29 | all uses of the work, to the fullest extent permitted by applicable law. 30 | When using or citing the work, you should not imply endorsement by the 31 | author or the affirmer. 32 | -------------------------------------------------------------------------------- /Gemfile.lock: -------------------------------------------------------------------------------- 1 | GIT 2 | remote: https://github.com/18F/uswds-jekyll.git 3 | revision: feae6a47126a705876a48fad8775d5ca9a46fa33 4 | specs: 5 | uswds-jekyll (4.1.0) 6 | jekyll (~> 3.4) 7 | 8 | GEM 9 | remote: https://rubygems.org/ 10 | specs: 11 | addressable (2.5.2) 12 | public_suffix (>= 2.0.2, < 4.0) 13 | colorator (1.1.0) 14 | concurrent-ruby (1.0.5) 15 | em-websocket (0.5.1) 16 | eventmachine (>= 0.12.9) 17 | http_parser.rb (~> 0.6.0) 18 | eventmachine (1.2.5) 19 | ffi (1.9.23) 20 | forwardable-extended (2.6.0) 21 | http_parser.rb (0.6.0) 22 | i18n (0.9.5) 23 | concurrent-ruby (~> 1.0) 24 | jekyll (3.7.3) 25 | addressable (~> 2.4) 26 | colorator (~> 1.0) 27 | em-websocket (~> 0.5) 28 | i18n (~> 0.7) 29 | jekyll-sass-converter (~> 1.0) 30 | jekyll-watch (~> 2.0) 31 | kramdown (~> 1.14) 32 | liquid (~> 4.0) 33 | mercenary (~> 0.3.3) 34 | pathutil (~> 0.9) 35 | rouge (>= 1.7, < 4) 36 | safe_yaml (~> 1.0) 37 | jekyll-last-modified-at (1.0.1) 38 | jekyll (~> 3.3) 39 | posix-spawn (~> 0.3.9) 40 | jekyll-sass-converter (1.5.2) 41 | sass (~> 3.4) 42 | jekyll-watch (2.0.0) 43 | listen (~> 3.0) 44 | kramdown (1.16.2) 45 | liquid (4.0.0) 46 | listen (3.1.5) 47 | rb-fsevent (~> 0.9, >= 0.9.4) 48 | rb-inotify (~> 0.9, >= 0.9.7) 49 | ruby_dep (~> 1.2) 50 | mercenary (0.3.6) 51 | pathutil (0.16.1) 52 | forwardable-extended (~> 2.6) 53 | posix-spawn (0.3.13) 54 | public_suffix (3.0.2) 55 | rb-fsevent (0.10.3) 56 | rb-inotify (0.9.10) 57 | ffi (>= 0.5.0, < 2) 58 | rouge (3.1.1) 59 | ruby_dep (1.5.0) 60 | safe_yaml (1.0.4) 61 | sass (3.5.5) 62 | sass-listen (~> 4.0.0) 63 | sass-listen (4.0.0) 64 | rb-fsevent (~> 0.9, >= 0.9.4) 65 | rb-inotify (~> 0.9, >= 0.9.7) 66 | 67 | PLATFORMS 68 | ruby 69 | 70 | DEPENDENCIES 71 | jekyll-last-modified-at 72 | uswds-jekyll! 73 | 74 | BUNDLED WITH 75 | 1.16.1 76 | -------------------------------------------------------------------------------- /_data/footer.yml: -------------------------------------------------------------------------------- 1 | # This is the configuration for the site footer. 2 | 3 | # Configuration for type of footer. 4 | # Footer types can be only be medium at the moment 5 | type: medium 6 | 7 | # Configuration for "Return to top" link. 8 | # Customize with 'text' and 'href' properties. 9 | # Comment out to the following section to hide. 10 | top: 11 | text: Return to top 12 | href: '#' 13 | 14 | # Configuration for "Edit this page" link in the footer. 15 | # Customize with 'text' property. 16 | # Uncomment the following line to show. 17 | edit_page: 18 | text: Edit this page 19 | 20 | # Configuration for "Last updated" date and time. 21 | # Uncomment the following line to show. 22 | # last_updated: true 23 | 24 | # Configuration for which links show at the top of the footer. 25 | # this is a key into _data/navigation.yml 26 | links: footer 27 | 28 | # Configuration for footer heading. (optional) 29 | heading: Name of agency 30 | 31 | # Configuration for agency logo(s) (shown side by side). 32 | # If the logo is external add external: true 33 | logos: 34 | - src: /assets/img/gsa-logo-dark.jpg 35 | alt: GSA 36 | - src: https://18f.gsa.gov/assets/img/logos/18f-logo.svg 37 | alt: 18F 38 | external: true 39 | 40 | # Configuration for footer contact links 41 | contact: 42 | # Configuration for social media links 43 | # Comment out links you don't want to use (RSS is an example) 44 | social_links: 45 | - text: Facebook 46 | href: https://facebook.com 47 | external: true 48 | type: facebook 49 | - text: Twitter 50 | href: https://twitter.com 51 | external: true 52 | type: twitter 53 | - text: YouTube 54 | href: https://youtube.com 55 | external: true 56 | type: youtube 57 | # - text: RSS Feed 58 | # href: https://usa.gov/ 59 | # external: true 60 | # type: rss 61 | heading: Agency contact center 62 | # Configuration for contact links for email, phone, etc... 63 | contact_links: 64 | - text: (800) CALL-GOVT 65 | href: tel:1-800-555-5555 66 | - text: info@agency.gov 67 | href: mailto:info@agency.gov 68 | -------------------------------------------------------------------------------- /pages/landing.html: -------------------------------------------------------------------------------- 1 | --- 2 | title: Home 3 | permalink: / 4 | 5 | layout: home 6 | 7 | hero: 8 | image: /assets/uswds/img/hero.png 9 | callout: 10 | alt: "Hero callout:" 11 | text: Call attention to a current priority 12 | button: 13 | href: /callout/ 14 | text: This is a call to all my 15 | link: 16 | text: Link to more about that priority 17 | href: /link/ 18 | content: Support the callout with some short explanatory text. You don't need more than a couple of sentences. 19 | 20 | 21 | tagline: A tagline highlights your approach. 22 | intro: | 23 | The tagline should inspire confidence and interest, focusing on the value that your overall approach offers to your audience. Use a heading typeface and keep your tagline to just a few words, and don’t confuse or mystify. 24 | 25 | Use the right side of the grid to explain the tagline a bit more. What are your goals? How do you do your work? Write in the present tense, and stay brief here. People who are interested can find details on internal pages. 26 | 27 | graphics: 28 | - image: 29 | src: /assets/uswds/img/circle-124.png 30 | alt: '' 31 | title: Graphic headings can vary. 32 | description: Graphic headings can be used a few different ways, depending on what your landing page is for. Highlight your values, specific program areas, or results. 33 | - image: 34 | src: /assets/uswds/img/circle-124.png 35 | alt: '' 36 | title: Stick to 6 or fewer words. 37 | description: Keep body text to about 30. They can be shorter, but try to be somewhat balanced across all four. It creates a clean appearance with good spacing. 38 | - image: 39 | src: /assets/uswds/img/circle-124.png 40 | alt: '' 41 | title: Never highlight anything without a goal. 42 | description: For anything you want to highlight here, understand what your users know now, and what activity or impression you want from them after they see it. 43 | - image: 44 | src: /assets/uswds/img/circle-124.png 45 | alt: '' 46 | title: Could also have 2 or 6. 47 | description: In addition to your goal, find out your users’ goals. What do they want to know or do that supports your mission? Use these headings to show those. 48 | --- 49 | 50 |

Section heading

51 | 52 |

53 | Everything up to this point should help people understand your agency or 54 | project: who you are, your goal or mission, and how you approach it. Use this 55 | section to encourage them to act. Describe why they should get in touch here, 56 | and use an active verb on the button below. “Get in touch,” “Learn more,” and 57 | so on. 58 |

59 | 60 | 61 | Call to action 62 | 63 | -------------------------------------------------------------------------------- /_data/theme.yml: -------------------------------------------------------------------------------- 1 | ## Color configurations 2 | ## 'primary' - Defines content link color, primary button bg color, return to top link color 3 | ## 'primary darker' - Defines content link hover color, primary button hover bg color, return to top link hover color 4 | ## 'base' - Defines header site title, active top nav link color, left nav link color, link color in primary and main footer and text in usa-banner 5 | ## 'visited' - Defines visited link color 6 | # 7 | # colors: 8 | # primary: 'DodgerBlue' 9 | # primary-darker: 'pink' 10 | # base: 'orange' 11 | # visited: 'red' 12 | # 13 | # # USA banner colors 14 | # usa-banner: 15 | # usa-banner-bg: 'LightBlue' 16 | # usa-banner-text: 'Black' 17 | # usa-banner-link: 'Gray' 18 | # usa-banner-link-hover: 'Gray' 19 | # 20 | # # Header colors 21 | # header: 22 | # header-bg: '#e6e3d0' 23 | # header-title: 'Black' 24 | # header-link: 'DarkSlateGray' 25 | # header-link-hover: 'Indigo' 26 | # 27 | # # Alt section colors 28 | # alt-section: 29 | # bg-color: '#e6e3d0' 30 | # header-color: 'DarkSlateGray' 31 | # text-color: 'Black' 32 | # link-color: 'red' 33 | # link-hover-color: 'orange' 34 | # 35 | # # Hero colors 36 | # hero: 37 | # hero-bg: 'white' 38 | # hero-header: 'DarkSlateGray' 39 | # hero-header-alt: 'DarkSlateGray' 40 | # hero-text: 'Gray' 41 | # hero-link: 'DodgerBlue' 42 | # hero-button-bg: 'DodgerBlue' 43 | # hero-button-text: 'white' 44 | # 45 | # # Top navigation colors 46 | # top-navigation: 47 | # top-nav-bg: 'DarkSlateGray' 48 | # top-nav-link: 'white' 49 | # top-nav-link-hover: 'black' 50 | # top-nav-link-hover-bg: '#6eb7b7' 51 | # top-nav-link-current: 'black' 52 | # top-nav-dropdown-bg: '#6eb7b7' 53 | # top-nav-dropdown-link: 'orange' 54 | # top-nav-dropdown-link-hover-bg: 'DarkSlateGray' 55 | # 56 | # # Side navigation colors 57 | # side-navigation: 58 | # side-nav-bg: 'white' 59 | # side-nav-link: 'black' 60 | # side-nav-link-hover: 'white' 61 | # side-nav-link-hover-bg: 'DarkSlateGray' 62 | # side-nav-link-current: 'DarkSlateGray' 63 | # 64 | # # Footer colors 65 | # footer: 66 | # primary-footer-bg: 'Gainsboro' 67 | # primary-footer-link: 'black' 68 | # footer-bg: 'DarkSlateGray' 69 | # footer-text: 'white' 70 | # footer-link: 'LightBlue' 71 | # 72 | # 73 | # # Font configurations 74 | # # 'sans' - Defines navigation and body text 75 | # # 'serif' - Defines headings 76 | # # 'normal' - Defines the default font weight 77 | # # 'bold' - Defines the bold font weight 78 | # 79 | # fonts: 80 | # sans: >- 81 | # "Source Sans Pro", "Helvetica Neue", "Helvetica", "Roboto", "Arial", sans-serif 82 | # serif: >- 83 | # "Baskerville", "Georgia", "Cambria", "Times New Roman", "Times", serif 84 | # normal: 300 85 | # bold: 500 86 | --------------------------------------------------------------------------------