govuk_tech_docs 1.7.0 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 91db307ff64061428101567559e520a7569e08d6
-  data.tar.gz: eb45e58f2e33c2ec079e9e0a8e430b511a2f9670
+  metadata.gz: 8b9d4a186f0bd8cc5f21f4af532c4af40a8151ba
+  data.tar.gz: 5ca815110a5ffe5dcf14e51a230d47745f2c14b2
 SHA512:
-  metadata.gz: 95cffa6f1db00a76baaa405be058d259920ad2a405867be77351e9960e8a2a23dc656a74c5881f5400c9e136ce2e5bed50dfa6fe27a767712a2f8792a1e50816
-  data.tar.gz: 42f5bcb4c5273f29072b1b5f85794852d75224d7ac3f580bdbd729ff94cf7d4ec984bfb17dfd38c9835ab1611810aed7f84ecedcae492e2fb16deceae13b2520
+  metadata.gz: 8c055c974e0b83cb30347a310ce3eeaaf646b5ab421fb1f8572d5b7edc1bb26f6051c21943966cb287ce68ec5a03ab754c915516ec3f818b1f38bbfd5d3fb957
+  data.tar.gz: c4a41a135993f461faddf1ef0f09513a0c7672f9e78213a0b34cc3ceec903fe47bb49b7572522041960b292fad553850c4f2d47528aa321691f50e953c58d4da

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 1.8.0
+
+🎉 Our first contributor from outside of GDS. Thanks [@timja](https://github.com/timja) from [HMCTS](https://hmcts.github.io)! 🤝
+
+New features: you can now configure a different GitHub branch for the repo to generate the "View source" link in the footer. Use `github_branch` in your config file (#71). You can also specify a `full_service_name` in the config, which is used in the browser title and meta tags (#72).
+
+This version also fixes a bug with unclickable links (#74 - reported in [alphagov/tech-docs-template#123](https://github.com/alphagov/tech-docs-template/issues/123)).
+
 ## 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).

data/docs/configuration.md

@@ -20,6 +20,14 @@ Your repository. Required if [show_contribution_banner](#show-contribution-banne
 github_repo: alphagov/example-repo
 ```
 
+## `github_branch`
+
+Your github branch name. Useful if your default branch is not named master.
+
+```yaml
+github_branch: source
+```
+
 ## `google_site_verification`
 
 Adds a [Google Site Verification code](https://support.google.com/webmasters/answer/35179?hl=en) to the meta tags.
@@ -116,6 +124,16 @@ Example:
 service_name: "Platform as a Service"
 ```
 
+## `full_service_name`
+
+The full service name (maybe with GOV.UK)
+
+Example:
+
+```yaml
+full_service_name: "GOV.UK Pay"
+```
+
 ## `service_link`
 
 What the service name in the header links to.

data/example/config/tech-docs.yml

@@ -38,6 +38,7 @@ enable_search: true
 show_contribution_banner: true
 
 github_repo: alphagov/example-repo
+github_branch: source
 
 redirects:
   /something/old.html: /index.html

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

@@ -1,5 +1,8 @@
 // Adds combination of margin and padding to headings to make them appear
 // correctly when they're linked to as anchors, and scale them on mobile
+// TODO: Headings are hidden underneath the sticky 'table of contents' on mobile
+// when following a link to them
+
 @mixin heading-offset($tabletTopMargin) {
   // Scale margins with font size on mobile (16/19ths)
   $mobileTopMargin: ceil($tabletTopMargin * (16 / 19));
@@ -7,18 +10,6 @@
   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;
-
-  // 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.
-  .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);
     margin-top: max(0, $tabletTopMargin - $gutter);

data/lib/govuk_tech_docs.rb

@@ -52,8 +52,8 @@ module GovukTechDocs
 
     context.configure :build do
       activate :autoprefixer
-      activate :minify_css
-      activate :minify_javascript
+      activate :minify_css, ignore: ['/raw_assets/*']
+      activate :minify_javascript, ignore: ['/raw_assets/*']
     end
 
     context.config[:tech_docs] = YAML.load_file('config/tech-docs.yml').with_indifferent_access

data/lib/govuk_tech_docs/contribution_banner.rb

@@ -26,6 +26,10 @@ module GovukTechDocs
       "https://github.com/#{config[:tech_docs][:github_repo]}"
     end
 
+    def repo_branch
+      config[:tech_docs][:github_branch] || 'master'
+    end
+
   private
 
     # If a `page` local exists, see if it has a `source_url`. This is used by the
@@ -42,7 +46,7 @@ module GovukTechDocs
 
     # As the last fallback link to the source file in this repository.
     def source_from_file
-      "#{repo_url}/blob/master/source/#{current_page.file_descriptor[:relative_path]}"
+      "#{repo_url}/blob/#{repo_branch}/source/#{current_page.file_descriptor[:relative_path]}"
     end
 
     def locals

data/lib/govuk_tech_docs/meta_tags.rb

@@ -41,7 +41,7 @@ module GovukTechDocs
     end
 
     def site_name
-      config[:tech_docs][:service_name]
+      config[:tech_docs][:full_service_name] || config[:tech_docs][:service_name]
     end
 
     def page_description

data/lib/govuk_tech_docs/version.rb

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

data/lib/source/layouts/_header.erb

@@ -2,7 +2,7 @@
   <div class="header__container">
     <div class="header__brand">
       <% if config[:tech_docs][:service_link] %>
-        <a href="<%= config[:tech_docs][:service_link] %>">
+        <a href="<%= url_for config[:tech_docs][:service_link] %>">
       <% else %>
         <span>
       <% end %>
@@ -33,7 +33,7 @@
           <ul>
             <% config[:tech_docs][:header_links].each do |title, path| %>
               <li<% if active_page(path) %> class="active"<% end %>>
-                <a href="<%= path %>"><%= title %></a>
+                <a href="<%= url_for path %>"><%= title %></a>
               </li>
             <% end %>
           </ul>

data/lib/source/layouts/core.erb

@@ -29,7 +29,7 @@
     <%= yield_content :head %>
   </head>
 
-  <body <%= 'class="has-sidebar"' if content_for? :sidebar %>>
+  <body>
     <div class="app-pane">
       <div class="app-pane__header toc-open-disabled">
         <a href="#content" class="skip-link">Skip to main content</a>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk_tech_docs
 version: !ruby/object:Gem::Version
-  version: 1.7.0
+  version: 1.8.0
 platform: ruby
 authors:
 - Government Digital Service
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-01-17 00:00:00.000000000 Z
+date: 2019-02-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport