Work in progress

18F · Aug 5, 2016 · 632159b · 632159b
1 parent 2e5edc4
commit 632159b
Show file tree

Hide file tree

Showing 40 changed files with 2,097 additions and 24 deletions.
diff --git a/_config.yml b/_config.yml
@@ -30,15 +30,24 @@ collections:
     output: true
     permalink: /:path/
 
+defaults:
+  -
+    scope:
+      path: ""
+      type: "pages"
+    values:
+      layout: "page"
+
 # Navigation
 # List links that should appear in the site sidebar here
 navigation:
-- text: Introduction
-  url: index.html
-  internal: true
 - text: Content principles
   url: content-principles/
   internal: true
+  children:
+  - text: Easy to read
+    url: easy-to-read/
+    internal: true
 - text: Acronyms and abbreviations
   url: acronyms-and-abbreviations/
   internal: true
@@ -69,7 +78,7 @@ navigation:
 - text: Images
   url: images/
   internal: true
-- text: Interface and technical writing
+- text: Technical and interface writing
   url: technical-and-interface-writing/
   internal: true
 - text: Legal and technical terms
@@ -96,12 +105,12 @@ navigation:
 - text: URLs and filenames
   url: urls-and-filenames/
   internal: true
-- text: Voice and tone
-  url: voice-and-tone/
-  internal: true
 - text: References
   url: references/
   internal: true
+- text: Voice and tone
+  url: Voice-and-tone/
+  internal: true
 
 repos:
 - name: 18F Content Guide
@@ -114,13 +123,6 @@ back_link:
   url: "https://pages.18f.gov/guides/"
   text: Read more 18F Guides
 
-defaults:
-  -
-    scope:
-      path: ""
-    values:
-      layout: "guides_style_18f_default"
-
 # Configuration for jekyll_pages_api_search plugin gem.
 jekyll_pages_api_search:
   # Uncomment this to speed up site generation while developing.

diff --git a/_includes/head.html b/_includes/head.html
@@ -0,0 +1,25 @@
+<head>
+  <meta charset="utf-8">
+  <meta http-equiv="X-UA-Compatible" content="IE=edge">
+  <meta name="viewport" content="width=device-width, initial-scale=1">
+
+  <title>18F Handbook - {% if page.title %}{{ page.title }}{% else %}{{ site.title }}{% endif %}</title>
+  <link rel="icon" type="image/png" href="/favicon-32x32.png" sizes="32x32" />
+  <link rel="icon" type="image/png" href="/favicon-16x16.png" sizes="16x16" />
+
+  <meta name="description" content="{% if page.excerpt %}{{ page.excerpt | strip_html | strip_newlines | truncate: 160 }}{% else %}{{ site.description }}{% endif %}">
+
+  <link href='https://fonts.googleapis.com/css?family=Merriweather:400,700,400italic,700italic,300italic,300|Source+Sans+Pro:200,300,300italic,400,400italic,600,600italic,900' rel='stylesheet' type='text/css'>
+
+  <script src="{{site.baseurl}}/javascripts/jquery-2.1.4.min.js"></script>
+  <script src="{{site.baseurl}}/javascripts/private-eye.js"></script>
+  <script src="{{site.baseurl}}/javascripts/application.js"></script>
+
+  <link rel="stylesheet" type="text/css" href="{{site.baseurl}}/stylesheets/reset.css">
+  <link rel="stylesheet" type="text/css" href="{{site.baseurl}}/stylesheets/screen.css">
+
+  <link rel="canonical" href="{{ page.url | replace:'index.html','' | prepend: site.baseurl | prepend: site.url }}">
+
+  <link rel="stylesheet" type="text/css" href="{{site.baseurl}}/stylesheets/search.css">
+
+</head>
diff --git a/_includes/site-footer.html b/_includes/site-footer.html
@@ -0,0 +1,22 @@
+<footer class="site-footer">
+  <div class="wrapper">
+    <span class="hub">This site is part of the 
+      <a href="https://hub.18f.gov/"><img src="{{site.baseurl}}/images/logo/18F-Logo-S.png" alt="18F">Hub</a>
+    </span>
+    <nav>
+      <a href="{{ site.baseurl}}/nav-tips/" class="button button-nav-tips">Navigation tips</a>
+      {% if page.slack-channel %}
+        <a href="https://{{ site.slack.organization }}.slack.com/messages/{{ page.slack-channel }}/" class="button">
+          Discuss this page in <span class="slack">Slack</span>
+        </a>
+      {% endif %}
+      {% unless page.hide_edit_link %}
+      <a class="button button-edit" href="https://github.com/{{ site.github.organization }}/{{ site.github.repository }}/edit/{{ site.github.default_branch }}/{{ page.path }}">Edit this page</a>{% endunless %}
+      <a class="button button-issue" href="https://github.com/{{ site.github.organization }}/{{ site.github.repository }}/issues/">File an issue</a>
+    </nav>          
+  </div>
+</footer>
+
+{% guides_style_18f_include analytics.html %}
+
+{% jekyll_pages_api_search_load %}
diff --git a/_includes/site-header.html b/_includes/site-header.html
@@ -0,0 +1,6 @@
+<header class="site-header">
+  <div class="wrapper">
+    <h1 class="logo"><a href="{{site.baseurl}}/">{{site.title}}</a></h1>
+    {% jekyll_pages_api_search_interface %}
+  </div>
+</header>
diff --git a/_layouts/page.html b/_layouts/page.html
@@ -0,0 +1,18 @@
+<!DOCTYPE html>
+<html lang="en">
+  {% include head.html %}
+  <body class="no-js layout-article layout-article-{{ page.title | slugify }}">
+    <a class="a-skip-to-main" href="#main">Skip to main content</a>
+    {% include site-header.html %}
+    {% if page.breadcrumbs %}{% guides_style_18f_include breadcrumbs.html %}{% endif %}
+    <main class="article" role="main" id="main">
+      <div class="page">
+        <div class="wrapper">
+          <h1 class="page-title">{{ page.title }}</h1>
+          {{ content }}
+        </div>
+      </div>
+    </main>
+    {% include site-footer.html %}
+  </body>
+</html>
diff --git a/_layouts/redirect.html b/_layouts/redirect.html
@@ -0,0 +1,41 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <meta charset="utf-8">
+  <meta http-equiv="X-UA-Compatible" content="IE=edge">
+  <meta name="viewport" content="width=device-width, initial-scale=1">
+
+  <title>18F - {% if page.title %}{{ page.title }}{% else %}{{ site.title }}{% endif %}</title>
+  <meta name="description" content="{% if page.excerpt %}{{ page.excerpt | strip_html | strip_newlines | truncate: 160 }}{% else %}{{ site.description }}{% endif %}">
+
+  <link href='https://fonts.googleapis.com/css?family=Merriweather:400,700,400italic,700italic,300italic,300|Source+Sans+Pro:200,300,300italic,400,400italic,600,600italic,900' rel='stylesheet' type='text/css'>
+
+  <script src="https://use.typekit.net/izz0lvj.js"></script>
+  <script>try{Typekit.load({ async: true });}catch(e){}</script>
+
+  <script src="{{site.baseurl}}/javascripts/jquery-2.1.4.min.js"></script>
+  <script src="{{site.baseurl}}/javascripts/application.js"></script>
+
+  <link rel="stylesheet" type="text/css" href="{{site.baseurl}}/stylesheets/reset.css">
+  <link rel="stylesheet" type="text/css" href="{{site.baseurl}}/stylesheets/screen.css">
+
+  <link rel="canonical" href="{{ page.url | replace:'index.html','' | prepend: site.baseurl | prepend: site.url }}">
+
+  <link rel="stylesheet" type="text/css" href="{{site.baseurl}}/stylesheets/search.css">
+  <meta http-equiv="refresh" content="0;URL='{{ page.url }}">
+
+</head>
+
+  <body class="no-js layout-article">
+    {% include site-header.html %}
+    {% if page.breadcrumbs %}{% guides_style_18f_include breadcrumbs.html %}{% endif %}
+    <main class="article">
+      <div class="page">
+        <div class="wrapper">
+          <h1>One moment, please&hellip;</h1>
+        </div>
+      </div>
+    </main>
+    {% include site-footer.html %}
+  </body>
+</html>
diff --git a/_layouts/search-results.html b/_layouts/search-results.html
@@ -0,0 +1,5 @@
+---
+layout: page
+hide_edit_link: true
+---
+{% jekyll_pages_api_search_results %}
diff --git a/_pages/abbreviations.md b/_pages/abbreviations.md
@@ -1,5 +1,6 @@
 ---
 title: Acronyms and abbreviations
+permalink: /acronyms-and-abbreviations/
 ---
 
 Abbreviations are any shortened or contracted word or phrase. For example, writing *St.* instead of *Street*, or *Rx* for *prescription*, or *D.C.* for *District of Columbia*. 

diff --git a/_pages/content-principles/easy-to-read.md b/_pages/content-principles/easy-to-read.md
@@ -0,0 +1,5 @@
+---
+title: Easy to read
+---
+
+Test
diff --git a/favicon-16x16.png b/favicon-16x16.png
diff --git a/favicon-32x32.png b/favicon-32x32.png
diff --git a/favicon.ico b/favicon.ico
diff --git a/index.md b/index.md
@@ -2,16 +2,54 @@
 permalink: /
 title: Introduction
 ---
-This guide helps writers create content that’s easy to understand and meets people where they’re at. Government websites often talk at readers rather than to them: As with other facets of its online presence, .gov writing tends to describe the government’s concerns in “governmentese,” leaving users frustrated by information that is neither actionable nor understandable.
 
-This guide takes that frustration into account, as well as several commonly supported guidelines about writing for the web. Using this guide can help content designers benefit from our experience to date, incorporate user feedback into the content design process, and engender trust by communicating in a consistent manner.
+<html lang="en">
+  {% include head.html %}
+  <body class="layout-table-of-contents">
+    <a class="a-skip-to-main" href="#main">Skip to main content</a>
+    <header role="banner" class="site-header">
+      <div class="wrapper">
+        <h1>{{site.title}}</h1>
+        <p>{{site.description}}</p>
+        {% jekyll_pages_api_search_interface %}
+      </div>
+    </header>
+    <main id="main" role="main">
+      <div class="wrapper">
 
-## How to use this guide 
+      <ol>
+        {% for nav in site.navigation %}
+          {% if nav.url == nil %}{% continue %}{% endif %}
+          <li>
+            <h1 id="{{ nav.url | remove:"/" }}">{{ nav.text }}</h1>
+            {% if nav.blurb %}<p>{{ nav.blurb }}</p>{% endif %}
 
-We created this guide for reference on an as-needed basis. It’s here when you’re wondering whether to capitalize the word federal, for instance, or when you’re wondering how to create a friendly, informational tone.
-
-To this end, we’ve structured the guide into descriptively named sections. Browse our table of contents to find the topic you’re looking for.
-
-We aren’t opposed if you’d like to read this guide start to finish, of course.
-
-Most importantly, we encourage you to make a copy of this document and adapt it to your organizational needs. This guide is just that: a guide. It’s not meant to provide the final opinion on any of the topics discussed. If a certain section isn’t relevant to you and your team, delete it. And if you feel the guide is missing a section, by all means, add it. This guide is yours to use, and we trust you’ll update it in the ways that best suit you.
+            {% unless nav.children == nil %}
+              <ol class="toc-nav-children">
+                {% for child in nav.children %}
+                  {% if child.children != nil %}
+                  <li id="{{ child.text | slugify }}" class="toc-nav-child-with-children {{ child.text | slugify }}">
+                    {{ child.text }}
+                    <ol class="toc-nav-grandchildren">
+                      {% for grandchild in child.children %}
+                        <li class="{{ grandchild.text | slugify }}">
+                          <a href="{{ site.baseurl }}/{{ grandchild.url }}">{{ grandchild.text }}</a>
+                        </li>
+                      {% endfor %}
+                    </ol>
+                  {% else %}
+                  <li class="{{ child.text | slugify }}">
+                    <a href="{{ site.baseurl }}/{{ child.url }}">{{ child.text }}</a>
+                  {% endif %}
+                  </li>
+                {% endfor %}
+              </ol>
+            {% endunless %}
+          </li>
+        {% endfor %}
+      </ol>
+      </div>
+    </main>
+    {% include site-footer.html %}
+  </body>
+</html>