govuk_tech_docs 1.6.3 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1f0f042e89dd2774679d8d8d70770fb1e3461bd3
-  data.tar.gz: 07fe865a8c26f33a99ae3a6e862a2956fbe59a84
+  metadata.gz: 91db307ff64061428101567559e520a7569e08d6
+  data.tar.gz: eb45e58f2e33c2ec079e9e0a8e430b511a2f9670
 SHA512:
-  metadata.gz: d291b20386539989f85965837d3437297a2827764927144d313270abdb899ed8bc785b25266e5013c9b58f906df3a3e762d54877a048be56ab9ab0ebdb6fad82
-  data.tar.gz: a6877abc54925e65093fb4c3a09c5bcccf7ac5fba9af86e848d6d3a0f6a3bbd716618b46e386bf643c7b2a3a329853611c9849b7e1764554d34245e39274157d
+  metadata.gz: 95cffa6f1db00a76baaa405be058d259920ad2a405867be77351e9960e8a2a23dc656a74c5881f5400c9e136ce2e5bed50dfa6fe27a767712a2f8792a1e50816
+  data.tar.gz: 42f5bcb4c5273f29072b1b5f85794852d75224d7ac3f580bdbd729ff94cf7d4ec984bfb17dfd38c9835ab1611810aed7f84ecedcae492e2fb16deceae13b2520

data/.travis.yml

@@ -3,3 +3,14 @@ rvm:
   - 2.4.2
 script:
   - bundle exec rake
+before_install:
+  - rvm @global do gem uninstall bundler -a -x
+  - rvm @global do gem install bundler -v 1.17.3
+deploy:
+  provider: rubygems
+  gem: govuk_tech_docs
+  api_key:
+    secure: CY9C+IUqUeYWqXSyQgfF5swdYw1rRtYi0ai1xasD3R5rwARF6Qr8CnmdSBjfT2S84fXQiMza45Jto4w1jiy3o4wpxuKN68xEB7J4W/YEpFcZectzsmXwcMJH+DXh720KFIX2xiHaG5N0nWzAoV+6zgw6Vq24IXYE33wO6BgCmTe3vtO+Apg0+wDRAOuJ4T5XfSyWUvG8JqLRb81t+WbrsOLcUgZn24DHvs+lrjXTDDTzrgwTuKeaKd+h+mfxlHZD+Xxbcy624qop5ICwOOP0koRXCdVmTOSZ4mNI10+loCyA1B5Tryj/2wweyc8CanqRMniF8p/BxLV1sAwihpCmCpuWUyxq2pTPSgjF1A1f5hXwkAT/HiaXLzXKyO1REnbtLHYvre10EIYIII4nDAtCZP0YLYvPoKQUrAydeWiQ4jL+cyEeN/8Dznx2OPrhcwxazsElMm0yOZDNXERNIf3IVnQshxMFxQfGW3NTG8XR4l5PHAI2XqKy/O/VGbiRcNV3EYVG5w/KumB698BGDGV2QPOlh3JOEkebXTGDsMJj/gzZik2BtvAqYatwgx7oiYzvhEPz0m9o/DTS7Gf/5Hkj3iV2mpcNtRMc0HKmS7bwkv8Cl6dWECt7PWQ8Kz5ttrCKRmTCJDgra2xLFuV8kbBISPkKKv87KCXzxthM8ps94WE=
+  on:
+    repo: alphagov/tech-docs-gem
+    branch: master

data/CHANGELOG.md

@@ -1,6 +1,10 @@
 # Changelog
 
-## Unreleased
+## 1.7.0
+
+New features: this release adds support for a full-width page (#63) and adding HTML to the `head` of the page (#64).
+
+This release also makes sure that all pages are returned in the `/api/pages.json` endpoint (#66).
 
 ## 1.6.3
 

data/README.md

@@ -48,11 +48,9 @@ Or, on the command line, run `bundle exec rake jasmine:ci`.
 
 ## Releasing new versions
 
-At the moment this gem has to be released manually. There's a [story on the Reliability Engineering backlog](https://trello.com/c/gRQ8OnBl) to automate this.
-
 To release a new version, create a new Pull Request that updates [version.rb](lib/govuk_tech_docs/version.rb) and [CHANGELOG.md](CHANGELOG.md). Don't mix this in with other changes - this makes it easier to find out what was released when. See [this PR to release a new version as an example](https://github.com/alphagov/tech-docs-gem/pull/15).
 
-[Owners of the Rubygem](https://rubygems.org/gems/govuk_tech_docs#gem__owners) can then run `rake release` to release a new version.
+Travis will automatically release a [new version to Rubygems.org](https://rubygems.org/gems/govuk_tech_docs).
 
 ## License
 

data/docs/frontmatter.md

@@ -65,6 +65,18 @@ This page has a configurable sidebar that is independent of the content.
 
 ![](core-layout.png)
 
+If you do not specify a sidebar, you will get a simple one-column layout without one.
+
+```rb
+---
+layout: core
+---
+
+This page does not have a sidebar.
+```
+
+![](core-layout-without-sidebar.png)
+
 ## `old_paths`
 
 Any paths of pages that should redirect to this page.
@@ -88,6 +100,17 @@ owner_slack: "#operations-teams"
 ---
 ```
 
+## `source_url`
+
+If the contribution banner is turned on, you can override the "View source" link
+using `source_url`.
+
+Example:
+
+```yaml
+source_url: http://example.org/source.md
+```
+
 ## `title`
 
 The browser title of the page.

data/example/source/core-layout-without-sidebar.html.md.erb

@@ -0,0 +1,7 @@
+---
+layout: core
+---
+
+# Core layout, no sidebar
+
+This page does not have a sidebar.

data/example/source/core-layout.html.md.erb

@@ -7,6 +7,6 @@ layout: core
 <% end %>
 
 
-# Hello!
+# Core layout, alternative sidebar
 
 This page has a configurable sidebar that is independent of the content.

data/lib/assets/javascripts/_modules/in-page-navigation.js

@@ -70,7 +70,11 @@
     }
 
     function highlightActiveItemInToc(fragment) {
-      var $activeTocItem = $tocItems.filter('[href="' + window.location.pathname + fragment + '"]');
+      // Navigation items for single page navigation don't necessarily include the path name, but
+      // navigation items for multipage navigation items do include it. This checks for either case.
+      var $activeTocItem = $tocItems.filter(
+        '[href="' + window.location.pathname + fragment + '"],[href="' + fragment + '"]'
+      );
       // Navigation items with children don't contain fragments in their url
       // Check to see if any nav items contain just the path name.
       if(!$activeTocItem.get(0)) {

data/lib/assets/stylesheets/modules/_technical-documentation.scss

@@ -4,6 +4,9 @@
   // Scale margins with font size on mobile (16/19ths)
   $mobileTopMargin: ceil($tabletTopMargin * (16 / 19));
 
+  padding-top: min($mobileTopMargin, $gutter-half);
+  margin-top: max(0, $mobileTopMargin - $gutter-half);
+
   // Offset headings down on mobile so that linking to anchors they appear after
   // the sticky 'table of contents' element
   $stickyTocOffset: 20px + $gutter-half + 10px + 1px;
@@ -11,8 +14,10 @@
   // Pad the heading so that when linking to an anchor there is at most a
   // $gutter-half (mobile) or $gutter (tablet and above) sized gap between the
   // top of the viewport and the heading.
-  padding-top: min($mobileTopMargin, $gutter-half) + $stickyTocOffset;
-  margin-top: max(0, $mobileTopMargin - $gutter-half) - $stickyTocOffset;
+  .has-sidebar & {
+    padding-top: min($mobileTopMargin, $gutter-half) + $stickyTocOffset;
+    margin-top: max(0, $mobileTopMargin - $gutter-half) - $stickyTocOffset;
+  }
 
   @include media(tablet) {
     padding-top: min($tabletTopMargin, $gutter);

data/lib/govuk_tech_docs/pages.rb

@@ -26,7 +26,7 @@ module GovukTechDocs
     end
 
     def pages
-      sitemap.resources.select { |page| page.url.end_with?('.html') && page.data.title }
+      sitemap.resources.select { |page| page.data.title }
     end
   end
 end

data/lib/govuk_tech_docs/version.rb

@@ -1,3 +1,3 @@
 module GovukTechDocs
-  VERSION = "1.6.3".freeze
+  VERSION = "1.7.0".freeze
 end

data/lib/source/layouts/core.erb

@@ -25,9 +25,11 @@
     <% meta_tags.tags.each do |property, content| %>
       <%= tag :meta, property: property, content: content %>
     <% end %>
+
+    <%= yield_content :head %>
   </head>
 
-  <body>
+  <body <%= 'class="has-sidebar"' if content_for? :sidebar %>>
     <div class="app-pane">
       <div class="app-pane__header toc-open-disabled">
         <a href="#content" class="skip-link">Skip to main content</a>
@@ -35,22 +37,26 @@
         <%= partial 'layouts/header' %>
       </div>
 
-      <div id="toc-heading" class="toc-show fixedsticky">
-        <a href="#toc" class="toc-show__label js-toc-show" aria-controls="toc">
-          Table of contents <span class="toc-show__icon"></span>
-        </a>
-      </div>
+      <% if content_for? :sidebar %>
+        <div id="toc-heading" class="toc-show fixedsticky">
+          <a href="#toc" class="toc-show__label js-toc-show" aria-controls="toc">
+            Table of contents <span class="toc-show__icon"></span>
+          </a>
+        </div>
+      <% end %>
 
       <div class="app-pane__body"<%= " data-module=\"#{yield_content(:toc_module)}\"" if content_for? :toc_module %>>
-        <div class="app-pane__toc">
-          <div class="toc" data-module="table-of-contents">
-            <%= partial "layouts/search" %>
-            <a href="#" class="toc__close js-toc-close" aria-controls="toc" aria-label="Hide table of contents"></a>
-            <nav id="toc" class="js-toc-list toc__list" aria-labelledby="toc-heading"<%= " data-module=\"collapsible-navigation\"" if config[:tech_docs][:collapsible_nav] %>>
-              <%= yield_content :sidebar %>
-            </nav>
+        <% if content_for? :sidebar %>
+          <div class="app-pane__toc">
+            <div class="toc" data-module="table-of-contents">
+              <%= partial "layouts/search" %>
+              <a href="#" class="toc__close js-toc-close" aria-controls="toc" aria-label="Hide table of contents"></a>
+              <nav id="toc" class="js-toc-list toc__list" aria-labelledby="toc-heading"<%= " data-module=\"collapsible-navigation\"" if config[:tech_docs][:collapsible_nav] %>>
+                <%= yield_content :sidebar %>
+              </nav>
+            </div>
           </div>
-        </div>
+        <% end %>
 
         <div class="app-pane__content toc-open-disabled">
           <main id="content" class="technical-documentation" data-module="anchored-headings">

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk_tech_docs
 version: !ruby/object:Gem::Version
-  version: 1.6.3
+  version: 1.7.0
 platform: ruby
 authors:
 - Government Digital Service
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-11-02 00:00:00.000000000 Z
+date: 2019-01-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -311,6 +311,7 @@ files:
 - README.md
 - Rakefile
 - docs/configuration.md
+- docs/core-layout-without-sidebar.png
 - docs/core-layout.png
 - docs/expired-page.png
 - docs/frontmatter.md
@@ -324,6 +325,7 @@ files:
 - example/source/api-path.html.md
 - example/source/api-reference.html.md
 - example/source/child-of-expired-page.html.md
+- example/source/core-layout-without-sidebar.html.md.erb
 - example/source/core-layout.html.md.erb
 - example/source/expired-page-with-owner.html.md
 - example/source/expired-page.html.md
@@ -459,7 +461,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: Gem to distribute the GOV.UK Tech Docs Template