Fix all broken links and add link checker

source/amend_project/configuration/index.html.md.erb

@@ -7,4 +7,229 @@ review_in: 1 day
 
 # Configuration options
 
-<%= gem_docs 'configuration.md' %>
+You can configure the site using `config/tech-docs.yml`. [See the PaaS tech docs for an example](https://github.com/alphagov/paas-tech-docs/blob/master/config/tech-docs.yml).
+
+These are all the available options:
+
+## `ga_tracking_id`
+
+Tracking ID from Google Analytics
+
+```yaml
+ga_tracking_id: UA-XXXX-Y
+```
+
+## `github_repo`
+
+Your repository. Required if [show_contribution_banner](#show-contribution-banner) is true.
+
+```yaml
+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.
+
+```yaml
+google_site_verification: TvDTuyvdstyusadrCSDrctyd
+```
+
+## `enable_search`
+
+Enables search functionality. This indexes pages only and is not recommended for single-page sites.
+
+```yaml
+enable_search: true
+```
+
+## `header_links`
+
+Right hand side navigation.
+
+Example:
+
+```yaml
+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).
+
+Example:
+
+```yaml
+host: https://docs.cloud.service.gov.uk
+```
+
+## `collapsible_nav`
+
+Enable collapsible navigation in the sidebar. Defaults to false;
+
+```yaml
+collapsible_nav: true
+```
+
+## `multipage_nav`
+
+Enable multipage navigation in the sidebar. Defaults to false;
+
+```yaml
+multipage_nav: true
+```
+
+## `max_toc_heading_level`
+
+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.
+
+```yaml
+max_toc_heading_level: 6
+```
+
+## `phase`
+
+```yaml
+phase: "Beta"
+```
+
+## `prevent_indexing`
+
+Prevent robots from indexing (e.g. whilst in development)
+
+```yaml
+prevent_indexing: false
+```
+
+## `redirects`
+
+A list of redirects, from old to new location. Use this to set up external
+redirects or if [setting `old_paths` in the frontmatter](docs/frontmatter.md#old_paths) doesn't work.
+
+```yaml
+redirects:
+  /old-page.html: https://example.org/something-else.html
+  /another/old-page.html: /another/new-page.html
+```
+
+## `service_name`
+
+The service name in the header.
+
+Example:
+
+```yaml
+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.
+
+default: '/'
+
+```yaml
+service_link: "/"
+```
+
+## `show_contribution_banner`
+
+Show a block at the bottom of the page that links to the page source, so readers
+can easily contribute back to the documentation. If turned on [github_repo](#github-repo) is
+required.
+
+Off by default.
+
+```yaml
+show_contribution_banner: true
+github_repo: alphagov/example-repo
+```
+
+## `source_urls`
+
+Customise the URLs that the contribution banner links to. Only useful if
+[show_contribution_banner](#show_contribution_banner) is turned on. By default, "Report issue" links
+to raising a GitHub issue but by modifying the `report_issue_url` it can link to an email address
+or another page.
+
+```yaml
+source_urls:
+  report_issue_url: mailto:[email protected]
+```
+
+## `show_govuk_logo`
+
+Whether to show the GOV.UK crown logo.
+
+default: `true`
+
+```yaml
+show_govuk_logo: true
+```
+
+## `api_path`
+
+Define a path to an Open API V3 spec file. This can be a relative file path or a URI to a raw file.
+
+```yaml
+api_path: ./source/pets.yml
+```
+
+## `owner_slack_workspace` and `default_owner_slack`
+
+These attributes are used to specify the owner of a page.  See the separate
+[documentation for page expiry][expiry] for more details.
+
+## `show_expiry`
+
+Decides whether or not to show a red banner when the page needs to be reviewed.
+
+If not present or set to `true`, the red banner will appear when the page needs to be reviewed. This is the default behaviour.
+
+If set to `false`, the red banner will not appear when the page needs to be reviewed.
+
+See the separate [documentation for page expiry][expiry] for more details.
+
+[expiry]: https://tdt-documentation.london.cloudapps.digital/page-expiry.html#page-expiry-and-review
+
+## `show_review_banner`
+
+Decides whether or not to display the page review banner, regardless of whether the page needs to be reviewed or not.
+
+If not present or set to `true`, the banner will be displayed on the page. This is the default behaviour.
+
+If set to `false`, the banner will not be displayed.
+
+See the separate [documentation for page expiry][expiry] for more details.
+
+[expiry]: https://tdt-documentation.london.cloudapps.digital/page-expiry.html#page-expiry-and-review

source/frontmatter.html.md.erb

@@ -4,4 +4,157 @@ title: "Frontmatter"
 
 # Frontmatter
 
-<%= gem_docs 'frontmatter.md' %>
+"Frontmatter" allows page-specific variables to be included at the top of a template using YAML. For a general introduction on frontmatter, see the [Middleman frontmatter docs][mm].
+
+## `last_reviewed_on` and `review_in`
+
+These attributes determine the date when the page needs to be reviewed next.
+See the separate [documentation for page expiry][expiry] for more details.
+
+[expiry]: https://tdt-documentation.london.cloudapps.digital/page-expiry.html#page-expiry-and-review
+
+Example:
+
+You can use this in combination with [owner_slack](#owner-slack) to set an owner for the page.
+
+## `layout`
+
+The layout of the page.
+
+```yaml
+---
+layout: core
+---
+```
+
+There are 2 available page layouts.
+
+### The `layout` layout (default)
+
+By default, pages will use the `layout` layout. This layout will parse the page and generate a sidebar with a table of contents consisting of each `h2`, `h3`, `h4` heading.
+
+```md
+---
+layout: layout
+---
+
+# The title
+
+## A subheader
+
+### A h3 subheader
+
+## Another subheader
+```
+
+Will generate a page with the headings from the content in the sidebar.
+
+![](layout-layout.png)
+
+### `core` layout
+
+If you want more control about the layout, use `core` layout. This allows you to specify the sidebar manually with a `content_for` block.
+
+```rb
+---
+layout: core
+---
+
+<% content_for :sidebar do %>
+  You can put anything in the sidebar.
+<% end %>
+
+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.
+
+Example:
+
+```yaml
+---
+old_paths:
+  - /some-old-page.html
+---
+```
+
+## `owner_slack`
+
+The Slack username or channel of the page owner. This can be used to appoint an individual or team as responsible for keeping the page up to date.
+
+```yaml
+---
+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.
+
+```yaml
+---
+title: My beautiful page
+---
+```
+
+## `weight`
+
+Affects the order a page is displayed in the sidebar navigation tree. Lower
+weights float to the top. Higher weights sink to the bottom.
+
+```yaml
+---
+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.
+
+```yaml
+---
+parent: shaving-yaks.html
+---
+```
+
+[mm]: https://middlemanapp.com/basics/frontmatter