govuk_tech_docs 2.4.1 → 2.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 80dfd8a946033705eb3157cb70319a30860ca096e85ec4e8cf47a04b5c001d38
-  data.tar.gz: 553772f54e1b4afbd0db8c3eb40d60460df35104b570b8be13c527cecf71ff54
+  metadata.gz: b52d6e8aa198588eb1483b68997af30d2ead1179addc62110cfdab7d1d117920
+  data.tar.gz: ae9fb52fb1ca0929cc5be15f74ca32d6acd159eb248f397b976f963d8a00ca76
 SHA512:
-  metadata.gz: d35acab5b3b497aa48fe880e838b817d584a6545b5881ef5f9ceeee40030366e15a4b183fa409b647b3ab4f64a81d478584787e68cf62d97e84be32a26c24802
-  data.tar.gz: 3f495169c4f98cf79f69ee8a33ff3440908a861fcd3ff2aa823f000dda28cfc2da0f5559c22851cbd4a456eb560b50f5af06598212b5c5a08be8ea72aa948022
+  metadata.gz: f0b288f32a3adf1c974d525186efd8839b71372eed7425a1e31dc13f6a27b840e00536d481dca6218d303bdfea281299672b409080a53ab40c7b483968cfda84
+  data.tar.gz: 18de4113f809ff2c8ef69f399d20e0781241242eaf0660cd2668d023d3e136114abada7e783087b4bf8e19149c4d1ba570fe161fb7798ec33ff49e8bbc1de6dc

data/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## Unreleased
 
+## 2.4.2
+
+- [#251 Fix missing `<ul>` in single page navigation](https://github.com/alphagov/tech-docs-gem/pull/251)
+
 ## 2.4.1
 
 - [#248: Remove IE8 fallback PNG with broken image reference](https://github.com/alphagov/tech-docs-gem/pull/248)

data/example/config/tech-docs.yml

@@ -13,6 +13,7 @@ header_links:
   Expired page: /expired-page.html
   Expired with owner: /expired-page-with-owner.html
   Not expired page: /not-expired-page.html
+  Single page nav: /single-page-nav.html
 
 footer_links:
   Accessibility: /hidden-page.html

data/example/source/single-page-nav.html.md

@@ -0,0 +1,13 @@
+---
+layout: layout
+multipage_nav: false
+hide_in_navigation: true
+---
+
+# A page that does not use multi-page navigation
+
+## A subheader
+
+### A h3 subheader
+
+## Another subheader

data/lib/govuk_tech_docs/table_of_contents/helpers.rb

@@ -8,14 +8,11 @@ module GovukTechDocs
   module TableOfContents
     module Helpers
       def single_page_table_of_contents(html, url: "", max_level: nil)
-        headings = HeadingsBuilder.new(html, url).headings
-
-        if headings.none? { |heading| heading.size == 1 }
-          raise "No H1 tag found. You have to at least add one H1 heading to the page: " + url
-        end
+        output = "<ul>\n"
+        output += list_items_from_headings(html, url: url, max_level: max_level)
+        output += "</ul>\n"
 
-        tree = HeadingTreeBuilder.new(headings).tree
-        HeadingTreeRenderer.new(tree, max_level: max_level).html
+        output
       end
 
       def multi_page_table_of_contents(resources, current_page, config, current_page_html = nil)
@@ -28,6 +25,17 @@ module GovukTechDocs
         render_page_tree(resources, current_page, config, current_page_html)
       end
 
+      def list_items_from_headings(html, url: "", max_level: nil)
+        headings = HeadingsBuilder.new(html, url).headings
+
+        if headings.none? { |heading| heading.size == 1 }
+          raise "No H1 tag found. You have to at least add one H1 heading to the page: " + url
+        end
+
+        tree = HeadingTreeBuilder.new(headings).tree
+        HeadingTreeRenderer.new(tree, max_level: max_level).html
+      end
+
       def render_page_tree(resources, current_page, config, current_page_html)
         # Sort by weight frontmatter
         resources = resources
@@ -69,7 +77,7 @@ module GovukTechDocs
             output += "</li>\n"
           else
             output +=
-              single_page_table_of_contents(
+              list_items_from_headings(
                 content,
                 url: resource.url,
                 max_level: config[:tech_docs][:max_toc_heading_level],

data/lib/govuk_tech_docs/version.rb

@@ -1,3 +1,3 @@
 module GovukTechDocs
-  VERSION = "2.4.1".freeze
+  VERSION = "2.4.2".freeze
 end

data/lib/source/layouts/layout.erb

@@ -4,8 +4,10 @@ wrap_layout :core do
 
   content_for(:toc_module, "in-page-navigation")
 
+  use_multipage_nav = current_page.data.fetch(:multipage_nav, config[:tech_docs][:multipage_nav])
+
   content_for :sidebar do
-    if config[:tech_docs][:multipage_nav] %>
+    if use_multipage_nav %>
       <%= multi_page_table_of_contents(sitemap.resources, current_page, config, html) %>
     <% else %>
       <%= single_page_table_of_contents(html, max_level: config[:tech_docs][:max_toc_heading_level]) %>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk_tech_docs
 version: !ruby/object:Gem::Version
-  version: 2.4.1
+  version: 2.4.2
 platform: ruby
 authors:
 - Government Digital Service
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-07-28 00:00:00.000000000 Z
+date: 2021-07-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: autoprefixer-rails
@@ -309,6 +309,7 @@ files:
 - example/source/not-expired-page.html.md
 - example/source/pets.yml
 - example/source/prevent-index-page.html.md
+- example/source/single-page-nav.html.md
 - example/source/stylesheets/print.css.scss
 - example/source/stylesheets/screen-old-ie.css.scss
 - example/source/stylesheets/screen.css.scss