govuk_tech_docs 2.0.3 → 2.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 110083c57f1c81b54874f4390c6c10387db8e216263a43bb4e686ff4479ae5a3
-  data.tar.gz: ce4970b96060994a031697e554387249ed1309ab976c5d6314f68c5cdcb438ca
+  metadata.gz: d94433dc8c529cf1fe8e1d5793f889026a6cfc67a25c3e23f25e6bdf7bfc3886
+  data.tar.gz: 034413e2c01e297f2fb469296621feebbde22b28959f85d43b679b0026764fec
 SHA512:
-  metadata.gz: 1cfc83d3ce995d7bf3c1fded81516b9abf72b13da7cb8482259688c7d39e588e32c07cf78a97fa21b84683922c0cf4c1e7bba4eee9c93596beaaca8447aaa415
-  data.tar.gz: fd703d31fa5f6a5e644cd447c9bc871e93ce7c72986a07c12985ed3e3fc1b381c79afafcfcdb46a3dab585699a455008ccacddc4f54c1e9f9884a17c95ce992e
+  metadata.gz: 6bd3abb0caff2bdc339409540f3d845d964815e84ac4fa85df937db112ed13e79f589b57b28a36ef948dda2dfd38ef22ea901c0fa989035f473cb429b6226e2c
+  data.tar.gz: 87558e6beeb2dd2d92c14f430de2306b6b58449f9557f80d83701b54e7558e43901b35f25080821e2183c22181e4ecddfb96bbd11e6044b9329a9384e20f9bda

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 2.0.4
+
+Adds `footer_links` option for displaying links in the footer and ability to hide pages from left hand navigation.
+
 ## 2.0.3
 
 Fixes a couple of styling issues: [#100](https://github.com/alphagov/tech-docs-gem/issues/100) and [#106](https://github.com/alphagov/tech-docs-gem/issues/106).

data/docs/configuration.md

@@ -55,6 +55,17 @@ header_links:
   Documentation: /
 ```
 
+## `footer_links`
+
+Links to show in footer.
+
+Example:
+
+```yaml
+footer_links:
+  Accessibility: /accessibility
+```
+
 ## `host`
 
 Host to use for canonical URL generation (without trailing slash).

data/docs/frontmatter.md

@@ -132,6 +132,17 @@ weight: 20
 ---
 ```
 
+## `hide_in_navigation`
+
+Set `hide_in_navigation: true` to prevent the page from being rendered in the
+main page tree navigation.
+
+```yaml
+---
+hide_in_navigation: true
+---
+```
+
 ## `parent`
 
 The page that should be highlighted as ‘active’ in the navigation.

data/example/config/tech-docs.yml

@@ -14,6 +14,10 @@ header_links:
   Expired with owner: /expired-page-with-owner.html
   Not expired page: /not-expired-page.html
 
+footer_links:
+  Accessibility: /hidden-page.html
+  Hidden Page: /hidden-page.html
+
 # Tracking ID from Google Analytics (e.g. UA-XXXX-Y)
 ga_tracking_id:
 

data/example/source/hidden-page.html.md

@@ -0,0 +1,10 @@
+---
+title: Hidden page
+hide_in_navigation: true
+---
+
+# This is a hidden page
+
+Sometimes you don't want a page to show up in main nagivation, for example,
+when you want to link to it from footer. Setting `hide_in_navigation: true`
+frontmatter will prevent a link being generated in the navigation.

data/lib/govuk_tech_docs/table_of_contents/helpers.rb

@@ -34,14 +34,16 @@ module GovukTechDocs
         .sort_by { |r| [r.data.weight ? 0 : 1, r.data.weight || 0] }
         output = '';
         resources.each do |resource|
+          # Skip from page tree if hide_in_navigation:true frontmatter
+          next if resource.data.hide_in_navigation
+
           # Reuse the generated content for the active page
           # If we generate it twice it increments the heading ids
-          content =
-            if current_page.url == resource.url && current_page_html
-              current_page_html
-            else
-              resource.render(layout: false)
-            end
+          content = if current_page.url == resource.url && current_page_html
+                      current_page_html
+                    else
+                      resource.render(layout: false)
+                    end
           # Avoid redirect pages
           next if content.include? "http-equiv=refresh"
 

data/lib/govuk_tech_docs/version.rb

@@ -1,3 +1,3 @@
 module GovukTechDocs
-  VERSION = "2.0.3".freeze
+  VERSION = "2.0.4".freeze
 end

data/lib/source/layouts/_footer.erb

@@ -2,6 +2,16 @@
   <div class="govuk-footer__meta">
     <div class="govuk-footer__meta-item govuk-footer__meta-item--grow">
 
+      <% if config[:tech_docs][:footer_links] %>
+        <ul class="govuk-footer__inline-list">
+          <% config[:tech_docs][:footer_links].each do |title, path| %>
+            <li class="govuk-footer__inline-list-item">
+              <a class="govuk-footer__link" href="<%= url_for path %>"><%= title %></a>
+            </li>
+          <% end %>
+        </ul>
+      <% end %>
+
       <svg
         role="presentation"
         focusable="false"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk_tech_docs
 version: !ruby/object:Gem::Version
-  version: 2.0.3
+  version: 2.0.4
 platform: ruby
 authors:
 - Government Digital Service
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-09-05 00:00:00.000000000 Z
+date: 2019-09-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -362,6 +362,7 @@ files:
 - example/source/expired-page-with-owner.html.md
 - example/source/expired-page.html.md
 - example/source/headings.html.md
+- example/source/hidden-page.html.md
 - example/source/index.html.md.erb
 - example/source/javascripts/application.js
 - example/source/not-expired-page.html.md