govuk_tech_docs 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 02e41ba09a532d75fa642d0eb9ab0b1960fc83d6
+  data.tar.gz: 676133bd3cf4b436638be2699b60a62530101ba0
+SHA512:
+  metadata.gz: 820f02328cc40233559cf3f4cfc1757bc194706e123729cb927856da064a700c5d8bf00c1dc030d444560cc7aec794fc7fc030cd8e342c857759a46aa274f471
+  data.tar.gz: c7ea93749ef1bf236eac5e58865406278313a7ce068b2aed51236997803f3c30bfab5daf7c0f810e7b82a69b9587e1ae0a876c6a3d5ac8ec486f7d74ea586a5f

data/.editorconfig

@@ -0,0 +1,29 @@
+# EditorConfig is awesome: http://EditorConfig.org
+# https://gds-way.cloudapps.digital/manuals/programming-languages/editorconfig
+
+# top-most EditorConfig file
+root = true
+
+[*.java]
+indent_style: space
+indent_size: 4
+end_of_line: lf
+charset: utf-8
+insert_final_newline: true
+continuation_indent_size: 8
+
+[*.{scss,erb}]
+charset = utf-8
+end_of_line = lf
+indent_style = space
+indent_size = 2
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.{js,json}]
+charset = utf-8
+end_of_line = lf
+indent_style = space
+indent_size = 2
+insert_final_newline = true
+trim_trailing_whitespace = true

data/.gitignore

@@ -0,0 +1,34 @@
+### Ruby ###
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+/example/build
+/example/.sass-cache
+
+Gemfile.lock

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 2.4.2
+script:
+  - bundle exec rake

data/CHANGELOG.md

@@ -0,0 +1,36 @@
+# Changelog
+
+## 1.0.0
+
+The first release of the template as a gem. Most CSS, JS, images and layouts are
+now imported from the gem and can be removed from your project.
+
+The following script upgrades your project. This will work if you've not made
+any modifications to the files distributed by the template. If you have, you'll
+need to port your changes back in.
+
+```sh
+rm -rf lib source/images source/layouts source/favicon.ico source/javascripts/* source/stylesheets/*
+
+echo "//= require govuk_tech_docs" > source/javascripts/application.js
+echo "@import 'govuk_tech_docs';" > source/stylesheets/screen.css.scss
+
+echo '$is-print: true;
+
+@import "govuk_tech_docs";' > source/stylesheets/print.css.scss
+
+echo '$is-ie: true;
+$ie-version: 8;
+
+@import "govuk_tech_docs";' > source/stylesheets/screen-old-ie.css.scss
+
+echo "require 'govuk_tech_docs'
+
+TechDocs.configure(self)" > config.rb
+
+echo "source 'https://rubygems.org'
+
+gem 'govuk_tech_docs', path: '../govuk_tech_docs'" > Gemfile
+
+bundle install
+```

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in govuk_tech_docs.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Crown Copyright (Government Digital Service)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,47 @@
+# Tech Docs Template - gem
+
+This repo is part of the [tech-docs-template](https://github.com/alphagov/tech-docs-template).
+
+## Usage
+
+To [generate a new site with the template](https://github.com/alphagov/tech-docs-template#creating-a-new-documentation-project), see the tech-docs-template repo.
+
+## Developing locally
+
+There are 2 ways to develop with this gem.
+
+The first is to point your site's Gemfile to your local checkout, and use it normally. This is good for if you want to see what effect your changes have to the actual site.
+
+```rb
+gem 'govuk_tech_docs', path: '../tech-docs-gem'
+```
+
+The second is to use the example app in this repo. You can start it by
+
+```
+git clone git@github.com:alphagov/tech-docs-gem.git
+cd tech-docs-gem/example
+bundle install
+bundle exec middleman serve
+```
+
+Your site will appear on <http://localhost:4567>.
+
+## Tests
+
+We have some automated JavaScript tests that use [Jasmine][jas] as a test
+framework.
+
+To run the tests on your machine:
+
+- Run `bundle exec rake jasmine`
+- Navigate to `http://localhost:8888` in a browser of your choosing
+- Peruse the output of your tests
+
+Or, on the command line, run `bundle exec rake jasmine:ci`.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](LICENSE.md).
+
+[jas]: https://jasmine.github.io/

data/Rakefile

@@ -0,0 +1,9 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'jasmine'
+
+RSpec::Core::RakeTask.new(:spec)
+
+load 'jasmine/tasks/jasmine.rake'
+
+task default: ['spec', 'jasmine:ci']

data/example/.ruby-version

@@ -0,0 +1 @@
+2.4.2

data/example/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gem 'govuk_tech_docs', path: '..'

data/example/config.rb

@@ -0,0 +1,3 @@
+require 'govuk_tech_docs'
+
+GovukTechDocs.configure(self)

data/example/config/tech-docs.yml

@@ -0,0 +1,23 @@
+# Host to use for canonical URL generation (without trailing slash)
+host:
+
+# Header-related options
+show_govuk_logo: true
+service_name: My First Service
+service_link: /
+phase: Beta
+
+# Links to show on right-hand-side of header
+header_links:
+  Documentation: /
+
+# Tracking ID from Google Analytics (e.g. UA-XXXX-Y)
+ga_tracking_id:
+
+# Table of contents depth – how many levels to include in the table of contents.
+# If your ToC is too long, reduce this number and we'll only show higher-level
+# headings.
+max_toc_heading_level: 6
+
+# Prevent robots from indexing (e.g. whilst in development)
+prevent_indexing: false

data/example/source/index.html.md.erb

@@ -0,0 +1,17 @@
+---
+title: GOV.UK Documentation Example
+---
+
+# Hello, World!
+
+## Edit Me!
+
+Open `source/documentation/index.md` in your favourite text editor and start editing!
+
+You can write content in [Markdown](https://daringfireball.net/projects/markdown/) using **all** of the _usual_ syntax that you're used to!
+
+To change the title of the page or include additional files you'll need to edit `source/index.html.md.erb`.
+
+If you want slightly more control, you can always use <strong>HTML</strong>.
+
+For more detail and troubleshooting, take a look at the `README.md` file in the root of this project.

data/example/source/javascripts/application.js

@@ -0,0 +1 @@
+//= require govuk_tech_docs

data/example/source/stylesheets/print.css.scss

@@ -0,0 +1,3 @@
+$is-print: true;
+
+@import "govuk_tech_docs";

data/example/source/stylesheets/screen-old-ie.css.scss

@@ -0,0 +1,4 @@
+$is-ie: true;
+$ie-version: 8;
+
+@import "govuk_tech_docs";

data/example/source/stylesheets/screen.css.scss

@@ -0,0 +1 @@
+@import "govuk_tech_docs";

data/govuk_tech_docs.gemspec

@@ -0,0 +1,38 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "govuk_tech_docs/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "govuk_tech_docs"
+  spec.version       = GovukTechDocs::VERSION
+  spec.authors       = ["Government Digital Service"]
+  spec.email         = ["govuk-dev@digital.cabinet-office.gov.uk"]
+
+  spec.summary       = %q{Gem to distribute the GOV.UK Tech Docs Template}
+  spec.description   = %q{Gem to distribute the GOV.UK Tech Docs Template. See https://github.com/alphagov/govuk-tech-docs for the project.}
+  spec.homepage      = "https://github.com/alphagov/govuk-tech-docs"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "middleman", "~> 4.0"
+  spec.add_dependency "middleman-autoprefixer", "~> 2.7.0"
+  spec.add_dependency "middleman-compass", ">= 4.0.0"
+  spec.add_dependency "middleman-livereload"
+  spec.add_dependency "middleman-sprockets", "~> 4.0.0"
+  spec.add_dependency "middleman-syntax", "~> 3.0.0"
+  spec.add_dependency "nokogiri"
+  spec.add_dependency "redcarpet", "~> 3.3.2"
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "capybara", "~> 2.18.0"
+  spec.add_development_dependency "jasmine", "~> 3.1.0"
+  spec.add_development_dependency "rspec", "~> 3.7.0"
+end

data/lib/assets/javascripts/_analytics.js

@@ -0,0 +1,31 @@
+(function($) {
+  function trackLinkClick(action, $element) {
+    var linkText = $.trim($element.text());
+    var linkURL = $element.attr('href');
+    var label = linkText + '|' + linkURL;
+
+    ga(
+      'send',
+      'event',
+      'SM Technical Documentation', // Event Category
+      action, // Event Action
+      label // Event Label
+    );
+  }
+
+  function linkTrackingEventHandler(action) {
+    return function() {
+      trackLinkClick(action, $(this));
+    };
+  };
+
+  $(document).on('ready', function() {
+    if (typeof ga === 'undefined') {
+      return;
+    }
+
+    $('.technical-documentation a').on('click', linkTrackingEventHandler('inTextClick'));
+    $('.header a').on('click', linkTrackingEventHandler('topNavigationClick'));
+    $('.toc a').on('click', linkTrackingEventHandler('tableOfContentsNavigationClick'));
+  });
+})(jQuery);

data/lib/assets/javascripts/_govuk/modules.js

@@ -0,0 +1,57 @@
+(function($, root) {
+  "use strict";
+  root.GOVUK = root.GOVUK || {};
+  GOVUK.Modules = GOVUK.Modules || {};
+
+  GOVUK.modules = {
+    find: function(container) {
+      var modules,
+          moduleSelector = '[data-module]',
+          container = container || $('body');
+
+      modules = container.find(moduleSelector);
+
+      // Container could be a module too
+      if (container.is(moduleSelector)) {
+        modules = modules.add(container);
+      }
+
+      return modules;
+    },
+
+    start: function(container) {
+      var modules = this.find(container);
+
+      for (var i = 0, l = modules.length; i < l; i++) {
+        var module,
+            element = $(modules[i]),
+            type = camelCaseAndCapitalise(element.data('module')),
+            started = element.data('module-started');
+
+
+        if (typeof GOVUK.Modules[type] === "function" && !started) {
+          module = new GOVUK.Modules[type]();
+          module.start(element);
+          element.data('module-started', true);
+        }
+      }
+
+      // eg selectable-table to SelectableTable
+      function camelCaseAndCapitalise(string) {
+        return capitaliseFirstLetter(camelCase(string));
+      }
+
+      // http://stackoverflow.com/questions/6660977/convert-hyphens-to-camel-case-camelcase
+      function camelCase(string) {
+        return string.replace(/-([a-z])/g, function (g) {
+          return g[1].toUpperCase();
+        });
+      }
+
+      // http://stackoverflow.com/questions/1026069/capitalize-the-first-letter-of-string-in-javascript
+      function capitaliseFirstLetter(string) {
+        return string.charAt(0).toUpperCase() + string.slice(1);
+      }
+    }
+  }
+})(jQuery, window);

data/lib/assets/javascripts/_modules/anchored-headings.js

@@ -0,0 +1,18 @@
+(function($, Modules) {
+  'use strict';
+
+  Modules.AnchoredHeadings = function() {
+    this.start = function($element) {
+      var headings = $element.find('h1, h2, h3, h4, h5, h6');
+      headings.each(injectAnchor);
+    };
+
+    function injectAnchor() {
+      var $this = $(this);
+      $this.addClass('anchored-heading');
+      $this.prepend(
+        '<a href="#' + $this.attr('id') + '" class="anchored-heading__icon" aria-hidden="true"></a>'
+      );
+    };
+  };
+})(jQuery, window.GOVUK.Modules);

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

@@ -0,0 +1,124 @@
+(function($, Modules) {
+  'use strict';
+
+  Modules.InPageNavigation = function InPageNavigation() {
+    var $tocPane;
+    var $contentPane;
+    var $tocItems;
+    var $targets;
+
+    this.start = function start($element) {
+      $tocPane = $element.find('.app-pane__toc');
+      $contentPane = $element.find('.app-pane__content');
+      $tocItems = $('.js-toc-list').find('a');
+      $targets = $contentPane.find('[id]');
+
+      $contentPane.on('scroll', _.debounce(handleScrollEvent, 100, { maxWait: 100 }));
+
+      if (Modernizr.history) {
+        // Popstate is triggered when using the back button to navigate 'within'
+        // the page, i.e. changing the anchor part of the URL.
+        $(window).on('popstate', function (event) {
+          restoreScrollPosition(event.originalEvent.state);
+        });
+
+        if (history.state && history.state.scrollTop) {
+          // Restore existing state when e.g. using the back button to return to
+          // this page
+          restoreScrollPosition(history.state);
+        } else {
+          // Store the initial position so that we can restore it even if we
+          // never scroll.
+          handleInitialLoadEvent();
+        }
+      }
+    };
+
+    function restoreScrollPosition(state) {
+      if (state && typeof state.scrollTop !== 'undefined') {
+        $contentPane.scrollTop(state.scrollTop);
+      }
+    }
+
+    function handleInitialLoadEvent() {
+      var fragment = fragmentForTargetElement();
+
+      if (!fragment) {
+        fragment = fragmentForFirstElementInView();
+      }
+
+      handleChangeInActiveItem(fragment);
+    }
+
+    function handleScrollEvent() {
+      handleChangeInActiveItem(fragmentForFirstElementInView());
+    }
+
+    function handleChangeInActiveItem(fragment) {
+      storeCurrentPositionInHistoryApi(fragment);
+      highlightActiveItemInToc(fragment);
+    }
+
+    function storeCurrentPositionInHistoryApi(fragment) {
+      if (Modernizr.history && fragment) {
+        history.replaceState(
+          { scrollTop: $contentPane.scrollTop() },
+          "",
+          fragment
+        );
+      }
+    }
+
+    function highlightActiveItemInToc(fragment) {
+      var $activeTocItem = $tocItems.filter('[href="' + fragment + '"]');
+
+      if ($activeTocItem.get(0)) {
+        $tocItems.removeClass('toc-link--in-view');
+        $activeTocItem.addClass('toc-link--in-view');
+        scrollTocToActiveItem($activeTocItem);
+      }
+    }
+
+    function scrollTocToActiveItem($activeTocItem) {
+      var paneHeight = $tocPane.height();
+      var linkTop = $activeTocItem.position().top;
+      var linkBottom = linkTop + $activeTocItem.outerHeight();
+
+      var offset = null;
+
+      if (linkTop < 0) {
+        offset = linkTop;
+      } else if (linkBottom >= paneHeight) {
+        offset = -(paneHeight - linkBottom);
+      } else {
+        return;
+      }
+
+      var newScrollTop = $tocPane.scrollTop() + offset;
+
+      $tocPane.scrollTop(newScrollTop);
+    }
+
+    function fragmentForTargetElement() {
+      return window.location.hash;
+    }
+
+    function fragmentForFirstElementInView() {
+      var result = null;
+
+      $($targets.get().reverse()).each(function checkIfInView(index) {
+        if (result) {
+          return;
+        }
+
+        var $this = $(this);
+
+        if (Math.floor($this.position().top) <= 0) {
+          result = $this;
+        }
+      });
+
+      return result ? '#' + result.attr('id') : false;
+    }
+  };
+})(jQuery, window.GOVUK.Modules);