federalist-basic-report-theme 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9f2fb5ccc18ae6c36c70883ebb5e7878cf2af9b5
+  data.tar.gz: 93e4a21ce3125abfc6bbad833fbe08745497f272
+SHA512:
+  metadata.gz: d60adb5a9c5626646df541e7faf22226bba19562b42a322b30b319aa59ef3485657a8791b1315d8994d15d8fd522f8f3af0d9083651cb3142ca802f39968af8c
+  data.tar.gz: 1158a8d1acba4727266e110351517ab9488e1499f0a818643e7c244b0196e5755b0742547e3ade33a11ed6f8f60e99d98f1a59082a1e4bce1dea0b8854f39755

data/LICENSE.md

@@ -0,0 +1,31 @@
+As a work of the United States government, this project is in the
+public domain within the United States.
+
+Additionally, we waive copyright and related rights in the work
+worldwide through the CC0 1.0 Universal public domain dedication.
+
+## CC0 1.0 Universal summary
+
+This is a human-readable summary of the [Legal Code (read the full text)](https://creativecommons.org/publicdomain/zero/1.0/legalcode).
+
+### No copyright
+
+The person who associated a work with this deed has dedicated the work to
+the public domain by waiving all rights to the work worldwide
+under copyright law, including all related and neighboring rights, to the
+extent allowed by law.
+
+You can copy, modify, distribute and perform the work, even for commercial
+purposes, all without asking permission.
+
+### Other information
+
+In no way are the patent or trademark rights of any person affected by CC0,
+nor are the rights that other persons may have in the work or in how the
+work is used, such as publicity or privacy rights.
+
+Unless expressly stated otherwise, the person who associated a work with
+this deed makes no warranties about the work, and disclaims liability for
+all uses of the work, to the fullest extent permitted by applicable law.
+When using or citing the work, you should not imply endorsement by the
+author or the affirmer.

data/README.md

@@ -0,0 +1,164 @@
+[![CircleCI](https://circleci.com/gh/adborden/federalist-basic-report-theme.svg?style=svg)](https://circleci.com/gh/adborden/federalist-basic-report-theme)
+
+# Federalist Basic Report Theme
+
+This repo contains the Jekyll theme for the Basic Report [Federalist] template.
+
+The Basic Report template is a simple, easy to use setup designed to host
+multiple pages about a recent report or order. This setup provides a clean space
+for complex details or instructions. Navigation can be customized to host many
+pages while maintaining a clear hierarchy.
+
+
+## Installation
+
+STOP! You probably want to create your site from
+[Federalist](https://federalist.18f.gov/sites/new) and choose the "Basic Report"
+template from there. If you already have a Jekyll site and want to move to the
+Basic Report theme, read on!
+
+Add this line to your Jekyll site's `Gemfile`:
+
+```ruby
+gem "federalist-basic-report-theme"
+```
+
+And add this line to your Jekyll site's `_config.yml`:
+
+```yaml
+theme: federalist-basic-report-theme
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install federalist-basic-report-theme
+
+## Usage
+
+TODO: Write usage instructions here. Describe your available layouts, includes, sass and/or assets.
+
+### Site-wide Configuration
+
+These are site-wide settings that can be configured in `_config.yml`.
+
+
+#### `download_report_button` (object)
+
+Configure the primary call to action in the header. The `text` is what the
+button should display, the `href` is the path to your downloadable report PDF. The PDF
+should be uploaded to the `assets/` directory.
+
+```
+# _config.yml
+
+download_report_button:
+  text: Download as PDF
+  href: /assets/docs/sample-document.pdf
+```
+
+### Page configuration
+
+These settings can be added to the front-matter of your content pages.
+
+
+#### `title` (string)
+
+The title of your page.
+
+
+#### `permalink` (string)
+
+The URL path your page should appear as. e.g. `/my-page/`.
+
+
+#### `subnav` (array)
+
+The sidenav can display a subnav to jump to headings on the current page. It follows the
+same syntax as `site.sidenav`.
+
+```
+subnav:
+  - text: I. Ipsum
+    href: '#i-ipsum'
+  - text: II. Morem Ipsum
+    href: '#ii-morem-ipsum'
+  - text: III. Even Morem Ipsum
+    href: '#iii-even-morem-ipsum'
+```
+
+
+### Layouts
+
+#### `page`
+
+This is the main layout that most pages should use. It contains a sidenav that
+can be configured in `_config.yml`.
+
+
+#### `default`
+
+The base layout with a header and footer. Additional layouts should inherit from
+this one.
+
+
+### Includes
+
+#### `header.html`
+
+#### `
+
+### Stylesheets
+
+
+##### federalist.scss
+
+This contains the USWDS Sass as well as additional styles for the common Federalist UI components.
+
+
+##### theme.scss
+
+This contains styles specific to this Federalist theme.
+
+
+### Assets
+
+Add your downloadable PDF report under the `assets/` directory. Then add
+configuration for how you want the download report button.
+
+```
+# _config.yml
+
+download_report_button:
+  text: Download as PDF
+  href: /assets/docs/sample-document.pdf
+```
+
+
+## Development
+
+To set up your environment to develop this theme, run `bundle install`.
+
+Your theme is setup just like a normal Jekyll site! To test your theme, run `bundle exec jekyll serve` and open your browser at `http://localhost:4000`. This starts a Jekyll server using your theme. Add pages, documents, data, etc. like normal to test your theme's contents. As you make modifications to your theme and to your content, your site will regenerate and you should see the changes in the browser after a refresh, just like normal.
+
+When your theme is released, only the files in `_layouts`, `_includes`, `_sass` and `assets` tracked with Git will be bundled.
+To add a custom directory to your theme-gem, please edit the regexp in `federalist-basic-report-theme.gemspec` accordingly.
+
+
+## Contributing
+
+See [CONTRIBUTING](CONTRIBUTING.md) for additional information.
+
+
+## Public domain
+
+This project is in the worldwide [public domain](LICENSE.md). As stated in [CONTRIBUTING](CONTRIBUTING.md):
+
+> 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/).
+>
+> 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.
+
+[Federalist]: https://federalist.18f.gov/

data/_includes/analytics.html

@@ -0,0 +1,20 @@
+{% if site.google_analytics_ua %}
+<!-- Google Analytics -->
+<script>
+  (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
+  (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
+  m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
+  })(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
+  ga('create', '{{ site.google_analytics_ua }}', 'auto');
+
+  // anonymize user IPs (chops off the last IP triplet)
+  ga('set', 'anonymizeIp', true);
+  ga('set', 'forceSSL', true);
+  ga('send', 'pageview');
+</script>
+{% endif %}
+
+{% if site.dap_agency %}
+<!-- Digital Analytics Program roll-up, see https://analytics.usa.gov for data -->
+<script id="_fed_an_ua_tag" src="https://dap.digitalgov.gov/Universal-Federated-Analytics-Min.js?agency={{ site.dap_agency }}"></script>
+{% endif %}

data/_includes/banner.html

@@ -0,0 +1 @@
+{% include components/banner.html %}

data/_includes/components/banner.html

@@ -0,0 +1,20 @@
+<div class="usa-banner">
+  <div class="usa-accordion">
+    <header class="usa-banner-header">
+      <div class="usa-grid usa-banner-inner"> <img src="{{ site.baseurl }}/assets/uswds/img/favicons/favicon-57.png" alt="U.S. flag">
+        <p>An official website of the United States government</p> <button class="usa-accordion-button usa-banner-button" aria-expanded="false" aria-controls="gov-banner"> <span class="usa-banner-button-text">Here's how you know</span> </button> </div>
+    </header>
+    <div class="usa-banner-content usa-grid usa-accordion-content" id="gov-banner">
+      <div class="usa-banner-guidance-gov usa-width-one-half"> <img class="usa-banner-icon usa-media_block-img" src="{{ site.baseurl }}/assets/uswds/img/icon-dot-gov.svg" alt="Dot gov">
+        <div class="usa-media_block-body">
+          <p> <strong>The .gov means it’s official.</strong> <br> Federal government websites often end in .gov or .mil. Before sharing sensitive information, make sure you're on a federal government site. </p>
+        </div>
+      </div>
+      <div class="usa-banner-guidance-ssl usa-width-one-half"> <img class="usa-banner-icon usa-media_block-img" src="{{ site.baseurl }}/assets/uswds/img/icon-https.svg" alt="Https">
+        <div class="usa-media_block-body">
+          <p> <strong>The site is secure.</strong> <br> The <strong>https://</strong> ensures that you are connecting to the official website and that any information you provide is encrypted and transmitted securely. </p>
+        </div>
+      </div>
+    </div>
+  </div>
+</div>

data/_includes/components/footer--medium.html

@@ -0,0 +1,81 @@
+<footer class="usa-footer usa-footer-medium" role="contentinfo">
+
+  {% if site.show_last_updated_at %}
+    <div class="usa-grid">
+      <div class="usa-width-one-whole">
+        <p>Last updated: {{ page.last_modified_at | date: '%B %d, %Y at %I:%M %p' }}</p>
+      </div>
+    </div>
+  {% endif %}
+  
+  {% unless site.show_return_to_top == false %}
+    <div class="usa-grid usa-footer-return-to-top">
+      <a href="#main-content">Return to top</a>
+    </div>
+  {% endunless %}
+
+
+
+  {% if site.footer_nav %}
+  {% assign footer_links = site.footer_nav %}
+  {% assign _sizes = 'whole half third fourth sixth' | split: ' ' %}
+  {% assign _size = footer_links.size | minus: 1 %}
+  {% assign _size = _sizes[_size] | default: 'whole' %}
+  <div class="usa-footer-primary-section">
+    <div class="usa-grid">
+      <nav class="usa-footer-nav">
+        <ul class="usa-unstyled-list">
+          {% for _link in footer_links %}
+          <li class="usa-width-one-{{ _size }} usa-footer-primary-content">
+            <a class="usa-footer-primary-link" href="{% if _link.external == true %}{{ _link.href }}{% else %}{{ _link.href | relative_url }}{% endif %}">
+              {{ _link.text }}
+            </a>
+          </li>
+          {% endfor %}
+        </ul>
+      </nav>
+    </div>
+  </div>
+  {% endif %}
+
+  <div class="usa-footer-secondary_section">
+    <div class="usa-grid">
+      <div class="usa-footer-logo usa-width-one-half">
+        <div class="usa-footer-logo usa-width-one-half">
+          <img class="usa-footer-logo-img" src="{{ site.contact.agency_logo | default: '/assets/uswds/img/logo-img.png' | relative_url }}" alt="{{ site.contact.agency_logo_alt | default: 'A U.S. Government seal.' }}">
+          <h3 class="usa-footer-logo-heading">{{ site.contact.agency_name | default: 'Name of agency' }}</h3>
+        </div>
+      </div>
+
+      <div class="usa-footer-contact-links usa-width-one-half">
+        {% assign social_links = site.contact.social_links %}
+        {% if site.contact.contact_links %}
+          {% for _link in social_links %}
+            <a class="usa-link-{{ _link.type | default: 'generic' }}" href="{% if _link.external == true %}{{ _link.href }}{% else %}{{ _link.href | relative_url }}{% endif %}">
+              <span>{{ _link.text }}</span>
+            </a>
+          {% endfor %}
+        {% endif %}
+        <h3 class="usa-footer-contact-heading">{{ site.contact.heading | default: 'Agency contact center' }}</h3>
+        {% if site.contact.contact_links %}
+          <address>
+            {% assign contact_links = site.contact.contact_links %}
+            {% for _link in contact_links %}
+              <div class="usa-footer-primary-content usa-footer-contact_info">
+                <p>
+                  <a href="{% if _link.external == true %}{{ _link.href }}{% else %}{{ _link.href | relative_url }}{% endif %}">
+                    {{ _link.text }}
+                  </a>
+                </p>
+              </div>
+            {% endfor %}
+          </address>
+        {% endif %}
+      {% unless site.show_suggest_an_edit == false %}
+        <small><a href="https://github.com/{{ site.github.organization }}/{{ site.github.repository }}/edit/{{ site.github.default_branch }}/{{ page.path }}" class="usa-sidenav-edit" target="_blank">Edit this page</a></small>
+      {% endunless %}
+      </div>
+    </div>
+  </div>
+
+</footer>

data/_includes/components/graphic-list.html

@@ -0,0 +1,16 @@
+{% assign graphics = include.graphics %}
+{% if graphics %}
+<section class="usa-section usa-section-dark usa-graphic_list">
+  {% for graphic in graphics %}
+    {% cycle '<div class="usa-grid usa-graphic_list-row">', '' %}
+    <div class="usa-width-one-half usa-media_block">
+      <img class="usa-media_block-img"  src="{{ graphic.image.src | relative_url }}" alt="{{ graphic.image.alt }}">
+      <div class="usa-media_block-body">
+        {% if graphic.title %}<h3>{{ graphic.title }}</h3>{% endif %}
+        {{ graphic.description | markdownify }}
+      </div>
+    </div>
+    {% cycle '', '</div>' %}
+  {% endfor %}
+</section>
+{% endif %}

data/_includes/components/header--basic.html

@@ -0,0 +1,74 @@
+{% if header %}
+<header class="usa-header usa-header-basic" role="banner">
+
+  <div class="usa-nav-container">
+    <div class="usa-navbar">
+      <button class="usa-menu-btn">Menu</button>
+      <div class="usa-logo" id="logo">
+        <em class="usa-logo-text">
+          <a href="{% if header.href %}{{ header.href }}{% else %}{{ site.baseurl }}/{% endif %}" title="Home">
+            {{ header.title | default: site.title }}
+          </a>
+        </em>
+      </div>
+    </div>
+
+    <nav role="navigation" class="usa-nav">
+      <div class="usa-nav-inner">
+        <button class="usa-nav-close">
+          <img src="{{ site.baseurl }}/assets/uswds/img/close.svg" alt="close">
+        </button>
+
+        {% assign _primary = header.primary.links %}
+        {% assign primary_links = site.data.navigation[_primary] | default: _primary %}
+        {% if primary_links %}
+        <ul class="usa-nav-primary usa-accordion">
+          {% for _section in primary_links %}
+          <li>
+            {% if _section.links %}
+              {% assign section_links = site.data.navigation[_section.links] | default: _section.links %}
+              {% assign _section_id = _section.id %}
+              {% unless _section_id %}{% assign _section_id = 'nav-' | append: forloop.index %}{% endunless %}
+            <button class="usa-accordion-button usa-nav-link" aria-expanded="false" aria-controls="{{ _section_id }}">
+              <span>{{ _section.text }}</span>
+            </button>
+            <ul id="{{ _section_id }}" class="usa-nav-submenu" aria-hidden="true">
+              {% for _link in section_links %}
+              <li>
+                <a href="{% if _link.external %}{{ _link.href }}{% else %}{{ _link.href | relative_url }}{% endif %}">{{ _link.text }}</a>
+              </li>
+              {% endfor %}
+            </ul>
+            {% else %}
+              <a class="{% if _section.class %}{{ _section.class }}{% else %} usa-nav-link {% endif %} {% if _section.href == page.permalink %} usa-current{% endif %}" href="{% if _section.external %}{{ _section.href }}{% else %}{{ _section.href | relative_url }}{% endif %}">
+                <span>{{ _section.text }}</span>
+              </a>
+            {% endif %}
+          </li>
+          {% endfor %}
+        </ul>
+        {% endif %}
+
+        {% assign _secondary = header.secondary %}
+          {% if site.search_site_handle  %}
+            <form accept-charset="UTF-8" action="https://search.usa.gov/search" id="search_form" method="get" class="usa-search usa-search-small js-search-form">
+              <div style="margin:0;padding:0;display:inline">
+                <input name="utf8" type="hidden" value="&#x2713;" />
+              </div>
+              <input id="affiliate" name="affiliate" type="hidden" value="{{ site.search_site_handle }}" />
+              <div role="search">
+                <label for="query" class="usa-sr-only">Enter Search Term(s):</label>
+                <input autocomplete="off" class="usagov-search-autocomplete" id="query" name="query" type="search" />
+                <button type="submit" name="commit">
+                  <span class="usa-sr-only">Search</span>
+                </button>
+              </div>
+            </form>
+          {% endif %}
+        </div>
+      </div>
+    </nav>
+  </div>
+</header>
+<div class="usa-overlay"></div>
+{% endif %}

data/_includes/components/header--extended.html

@@ -0,0 +1,88 @@
+<header class="usa-header usa-header-extended" role="banner">
+
+  <div class="usa-navbar">
+    <button class="usa-menu-btn">Menu</button>
+    <div class="usa-logo" id="logo">
+      <em class="usa-logo-text">
+        <a href="{% if header.href %}{{ header.href }}{% else %}{{ site.baseurl }}/{% endif %}" title="Home">
+          {{ header.title | default: site.title }}
+        </a>
+      </em>
+    </div>
+  </div>
+
+  <nav role="navigation" class="usa-nav">
+    <div class="usa-nav-inner">
+      <button class="usa-nav-close">
+        <img src="{{ site.baseurl }}/assets/uswds/img/close.svg" alt="close">
+      </button>
+
+      {% assign _primary = header.primary.links %}
+      {% assign primary_links = site.data.navigation[_primary] | default: _primary %}
+      {% if primary_links %}
+      <ul class="usa-nav-primary usa-accordion">
+        {% for _section in primary_links %}
+        <li>
+          {% if _section.links %}
+            {% assign section_links = site.data.navigation[_section.links] | default: _section.links %}
+            {% assign _section_id = _section.id %}
+            {% unless _section_id %}{% assign _section_id = 'nav-' | append: forloop.index %}{% endunless %}
+          <button class="usa-accordion-button usa-nav-link" aria-expanded="false" aria-controls="{{ _section_id }}">
+            <span>{{ _section.text }}</span>
+          </button>
+          <ul id="{{ _section_id }}" class="usa-nav-submenu" aria-hidden="true">
+            {% for _link in section_links %}
+            <li>
+              <a href="{% if _link.external %}{{ _link.href }}{% else %}{{ _link.href | relative_url }}{% endif %}">{{ _link.text }}</a>
+            </li>
+            {% endfor %}
+          </ul>
+          {% else %}
+            <a class="{% if _section.class %}{{ _section.class }}{% else %} usa-nav-link {% endif %} {% if _section.href == page.permalink %} usa-current{% endif %}" href="{% if _section.external %}{{ _section.href }}{% else %}{{ _section.href | relative_url }}{% endif %}">
+              <span>{{ _section.text }}</span>
+            </a>
+          {% endif %}
+        </li>
+        {% endfor %}
+      </ul>
+      {% endif %}
+
+      <div class="usa-nav-secondary">
+        {% if site.search_site_handle  %}
+          <form accept-charset="UTF-8" action="https://search.usa.gov/search" id="search_form" method="get" class="usa-search usa-search-small js-search-form usa-sr-only">
+            <div style="margin:0;padding:0;display:inline">
+              <input name="utf8" type="hidden" value="&#x2713;" />
+            </div>
+            <input id="affiliate" name="affiliate" type="hidden" value="{{ site.search_site_handle }}" />
+            <div role="search">
+              <label for="query" class="usa-sr-only">Enter Search Term(s):</label>
+              <input autocomplete="off" class="usagov-search-autocomplete" id="query" name="query" type="search" />
+              <button type="submit" name="commit">
+                <span class="usa-sr-only">Search</span>
+              </button>
+            </div>
+          </form>
+        {% endif %}
+        <ul class="usa-unstyled-list usa-nav-secondary-links">
+          {% if site.search_site_handle %}
+          <li class="js-search-button-container">
+            <button class="usa-header-search-button js-search-button">Search</button>
+          </li>
+          {% endif %}
+          {% assign _link = site.download_report_button %}
+          <li>
+            <a
+              href="{% if _link.external %}{{ _link.href }}{% else %}{{ _link.href | default: '/assets/docs/sample-document.pdf' | relative_url }}{% endif %}"
+              class="{{ 'usa-button ' | append: _link.class }}"
+              role="button"
+            >
+              {{ _link.text | default: 'Download report' }}
+            </a>
+          </li>
+        </ul>
+      </div>
+
+    </div>
+  </nav>
+</header>
+<div class="usa-overlay"></div>