dss_tech_docs 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (151) hide show
  1. checksums.yaml +7 -0
  2. data/.editorconfig +29 -0
  3. data/.gitignore +37 -0
  4. data/.rspec +2 -0
  5. data/.rubocop.yml +11 -0
  6. data/.ruby-version +1 -0
  7. data/.travis.yml +9 -0
  8. data/CHANGELOG.md +274 -0
  9. data/CONTRIBUTING.md +9 -0
  10. data/Gemfile +4 -0
  11. data/LICENCE +21 -0
  12. data/README.md +89 -0
  13. data/Rakefile +13 -0
  14. data/docs/configuration.md +205 -0
  15. data/docs/core-layout-without-sidebar.png +0 -0
  16. data/docs/core-layout.png +0 -0
  17. data/docs/expired-page.png +0 -0
  18. data/docs/frontmatter.md +145 -0
  19. data/docs/last-reviewed-only.png +0 -0
  20. data/docs/last-reviewed-only.svg +1 -0
  21. data/docs/layout-layout.png +0 -0
  22. data/docs/not-expired-page.png +0 -0
  23. data/docs/page-expiry.md +85 -0
  24. data/dss_tech_docs.gemspec +46 -0
  25. data/example/.ruby-version +1 -0
  26. data/example/Gemfile +3 -0
  27. data/example/config.rb +9 -0
  28. data/example/config/hide-expiry.yml +51 -0
  29. data/example/config/tech-docs.yml +50 -0
  30. data/example/source/api-path.html.md +7 -0
  31. data/example/source/api-reference.html.md +5 -0
  32. data/example/source/child-of-expired-page.html.md +8 -0
  33. data/example/source/core-layout-without-sidebar.html.md.erb +7 -0
  34. data/example/source/core-layout.html.md.erb +12 -0
  35. data/example/source/expired-page-with-owner.html.md +10 -0
  36. data/example/source/expired-page.html.md +9 -0
  37. data/example/source/headings.html.md +11 -0
  38. data/example/source/index.html.md.erb +19 -0
  39. data/example/source/javascripts/application.js +1 -0
  40. data/example/source/not-expired-page.html.md +9 -0
  41. data/example/source/pets.yml +109 -0
  42. data/example/source/stylesheets/print.css.scss +3 -0
  43. data/example/source/stylesheets/screen-old-ie.css.scss +4 -0
  44. data/example/source/stylesheets/screen.css.scss +1 -0
  45. data/example/source/templates/proxy_template.html.md +8 -0
  46. data/lib/assets/javascripts/_analytics.js +58 -0
  47. data/lib/assets/javascripts/_govuk/modules.js +57 -0
  48. data/lib/assets/javascripts/_modules/anchored-headings.js +18 -0
  49. data/lib/assets/javascripts/_modules/collapsible-navigation.js +95 -0
  50. data/lib/assets/javascripts/_modules/in-page-navigation.js +132 -0
  51. data/lib/assets/javascripts/_modules/navigation.js +34 -0
  52. data/lib/assets/javascripts/_modules/page-expiry.js +15 -0
  53. data/lib/assets/javascripts/_modules/search.js +367 -0
  54. data/lib/assets/javascripts/_modules/table-of-contents.js +111 -0
  55. data/lib/assets/javascripts/_start-modules.js +13 -0
  56. data/lib/assets/javascripts/_vendor/fixedsticky.js +194 -0
  57. data/lib/assets/javascripts/_vendor/jquery.js +5 -0
  58. data/lib/assets/javascripts/_vendor/jquery.mark.js +1081 -0
  59. data/lib/assets/javascripts/_vendor/lodash.js +613 -0
  60. data/lib/assets/javascripts/_vendor/modernizr.js +3 -0
  61. data/lib/assets/javascripts/govuk_tech_docs.js +10 -0
  62. data/lib/assets/stylesheets/_accessibility.scss +9 -0
  63. data/lib/assets/stylesheets/_core.scss +71 -0
  64. data/lib/assets/stylesheets/_fonts.scss +29 -0
  65. data/lib/assets/stylesheets/_govuk_tech_docs.scss +2 -0
  66. data/lib/assets/stylesheets/_syntax-highlighting.scss +196 -0
  67. data/lib/assets/stylesheets/_variables.scss +12 -0
  68. data/lib/assets/stylesheets/govuk_frontend_toolkit/_colours.scss +2 -0
  69. data/lib/assets/stylesheets/govuk_frontend_toolkit/_conditionals.scss +81 -0
  70. data/lib/assets/stylesheets/govuk_frontend_toolkit/_css3.scss +90 -0
  71. data/lib/assets/stylesheets/govuk_frontend_toolkit/_device-pixels.scss +10 -0
  72. data/lib/assets/stylesheets/govuk_frontend_toolkit/_font_stack.scss +19 -0
  73. data/lib/assets/stylesheets/govuk_frontend_toolkit/_grid_layout.scss +136 -0
  74. data/lib/assets/stylesheets/govuk_frontend_toolkit/_helpers.scss +16 -0
  75. data/lib/assets/stylesheets/govuk_frontend_toolkit/_measurements.scss +14 -0
  76. data/lib/assets/stylesheets/govuk_frontend_toolkit/_shims.scss +55 -0
  77. data/lib/assets/stylesheets/govuk_frontend_toolkit/_typography.scss +249 -0
  78. data/lib/assets/stylesheets/govuk_frontend_toolkit/_url-helpers.scss +16 -0
  79. data/lib/assets/stylesheets/govuk_frontend_toolkit/colours/_organisation.scss +103 -0
  80. data/lib/assets/stylesheets/govuk_frontend_toolkit/colours/_palette.scss +77 -0
  81. data/lib/assets/stylesheets/govuk_frontend_toolkit/design-patterns/_alpha-beta.scss +66 -0
  82. data/lib/assets/stylesheets/govuk_frontend_toolkit/design-patterns/_breadcrumbs.scss +53 -0
  83. data/lib/assets/stylesheets/govuk_frontend_toolkit/design-patterns/_buttons.scss +141 -0
  84. data/lib/assets/stylesheets/govuk_frontend_toolkit/design-patterns/_media-player.scss +242 -0
  85. data/lib/assets/stylesheets/modules/_anchored-heading.scss +54 -0
  86. data/lib/assets/stylesheets/modules/_app-pane.scss +64 -0
  87. data/lib/assets/stylesheets/modules/_collapsible.scss +52 -0
  88. data/lib/assets/stylesheets/modules/_contribution-banner.scss +22 -0
  89. data/lib/assets/stylesheets/modules/_footer.scss +130 -0
  90. data/lib/assets/stylesheets/modules/_govuk-logo.scss +47 -0
  91. data/lib/assets/stylesheets/modules/_header.scss +290 -0
  92. data/lib/assets/stylesheets/modules/_page-review.scss +35 -0
  93. data/lib/assets/stylesheets/modules/_phase-banner.scss +22 -0
  94. data/lib/assets/stylesheets/modules/_search.scss +137 -0
  95. data/lib/assets/stylesheets/modules/_skip-link.scss +31 -0
  96. data/lib/assets/stylesheets/modules/_technical-documentation.scss +241 -0
  97. data/lib/assets/stylesheets/modules/_toc.scss +216 -0
  98. data/lib/assets/stylesheets/modules/_warning-text.scss +73 -0
  99. data/lib/assets/stylesheets/palette/_syntax-highlighting.scss +23 -0
  100. data/lib/assets/stylesheets/utilities/_fonts.scss +29 -0
  101. data/lib/assets/stylesheets/utilities/_printable.scss +13 -0
  102. data/lib/assets/stylesheets/vendor/_fixedsticky.scss +22 -0
  103. data/lib/dss_tech_docs.rb +121 -0
  104. data/lib/govuk_tech_docs/api_reference/api_reference_extension.rb +101 -0
  105. data/lib/govuk_tech_docs/api_reference/api_reference_renderer.rb +279 -0
  106. data/lib/govuk_tech_docs/api_reference/templates/api_reference_full.html.erb +19 -0
  107. data/lib/govuk_tech_docs/api_reference/templates/operation.html.erb +11 -0
  108. data/lib/govuk_tech_docs/api_reference/templates/parameters.html.erb +28 -0
  109. data/lib/govuk_tech_docs/api_reference/templates/path.html.erb +4 -0
  110. data/lib/govuk_tech_docs/api_reference/templates/responses.html.erb +33 -0
  111. data/lib/govuk_tech_docs/api_reference/templates/schema.html.erb +29 -0
  112. data/lib/govuk_tech_docs/contribution_banner.rb +62 -0
  113. data/lib/govuk_tech_docs/meta_tags.rb +67 -0
  114. data/lib/govuk_tech_docs/page_review.rb +52 -0
  115. data/lib/govuk_tech_docs/pages.rb +32 -0
  116. data/lib/govuk_tech_docs/redirects.rb +39 -0
  117. data/lib/govuk_tech_docs/table_of_contents/heading.rb +30 -0
  118. data/lib/govuk_tech_docs/table_of_contents/heading_tree.rb +27 -0
  119. data/lib/govuk_tech_docs/table_of_contents/heading_tree_builder.rb +41 -0
  120. data/lib/govuk_tech_docs/table_of_contents/heading_tree_renderer.rb +46 -0
  121. data/lib/govuk_tech_docs/table_of_contents/headings_builder.rb +39 -0
  122. data/lib/govuk_tech_docs/table_of_contents/helpers.rb +79 -0
  123. data/lib/govuk_tech_docs/tech_docs_html_renderer.rb +34 -0
  124. data/lib/govuk_tech_docs/unique_identifier_extension.rb +13 -0
  125. data/lib/govuk_tech_docs/unique_identifier_generator.rb +72 -0
  126. data/lib/govuk_tech_docs/version.rb +3 -0
  127. data/lib/govuk_tech_docs/warning_text_extension.rb +23 -0
  128. data/lib/source/api/pages.json.erb +1 -0
  129. data/lib/source/favicon.ico +0 -0
  130. data/lib/source/images/anchored-heading-icon-2x.png +0 -0
  131. data/lib/source/images/anchored-heading-icon.png +0 -0
  132. data/lib/source/images/gov.uk_logotype_crown-2x.png +0 -0
  133. data/lib/source/images/gov.uk_logotype_crown.png +0 -0
  134. data/lib/source/images/gov.uk_logotype_crown_invert_trans.png +0 -0
  135. data/lib/source/images/govuk-crest-2x.png +0 -0
  136. data/lib/source/images/govuk-crest.png +0 -0
  137. data/lib/source/images/govuk-icn-close.png +0 -0
  138. data/lib/source/images/govuk-icn-close@2x.png +0 -0
  139. data/lib/source/images/govuk-icn-numbered-list.png +0 -0
  140. data/lib/source/images/govuk-icn-numbered-list@2x.png +0 -0
  141. data/lib/source/images/open-government-licence.png +0 -0
  142. data/lib/source/images/open-government-licence_2x.png +0 -0
  143. data/lib/source/images/search-result-caret.svg +13 -0
  144. data/lib/source/layouts/_analytics.erb +15 -0
  145. data/lib/source/layouts/_footer.erb +10 -0
  146. data/lib/source/layouts/_header.erb +44 -0
  147. data/lib/source/layouts/_page_review.erb +22 -0
  148. data/lib/source/layouts/_search.erb +16 -0
  149. data/lib/source/layouts/core.erb +82 -0
  150. data/lib/source/layouts/layout.erb +18 -0
  151. metadata +474 -0
@@ -0,0 +1,22 @@
1
+ <% if current_page_review.under_review? %>
2
+ <div data-module='page-expiry' data-last-reviewed-on="<%= current_page_review.review_by %>">
3
+ <div class='page-expiry--<%= current_page_review.show_expiry? ? "not-expired" : "default" %>'>
4
+ This page was last reviewed on <%= format_date current_page_review.last_reviewed_on %>.
5
+
6
+ <% if current_page_review.show_expiry? %>
7
+ It needs to be reviewed again on <%= format_date current_page_review.review_by %>
8
+ <% if current_page_review.owner_slack %>
9
+ by the page owner <%= link_to current_page_review.owner_slack, current_page_review.owner_slack_url %>
10
+ <% end %>.
11
+ <% end %>
12
+ </div>
13
+
14
+ <% if current_page_review.show_expiry? %>
15
+ <div class='page-expiry--expired'>
16
+ This page was set to be reviewed before <%= format_date current_page_review.review_by %><% if current_page_review.owner_slack %>
17
+ by the page owner <%= link_to current_page_review.owner_slack, current_page_review.owner_slack_url %><% end %>.
18
+ This might mean the content is out of date.
19
+ </div>
20
+ <% end %>
21
+ </div>
22
+ <% end %>
@@ -0,0 +1,16 @@
1
+ <% if config[:tech_docs][:enable_search] %>
2
+ <div class="search" data-module="search">
3
+ <form action="https://www.google.co.uk/search" method="get" role="search">
4
+ <input type="hidden" name="as_sitesearch" value="<%= config[:tech_docs][:host] %>"/>
5
+ <label for="search" class="search__label">Search (via Google)</label>
6
+ <input type="text" id="search" name="q" placeholder="Search" aria-controls="search-results" class="form-control" />
7
+ </form>
8
+ <div id="search-results" class="search-results" aria-hidden="true" role="dialog" aria-labelledby="search-results-title">
9
+ <div class="search-results__inner">
10
+ <button class="search-results__close">Close<span class="search-results__close-label"> search results</span></button>
11
+ <h2 id="search-results-title" class="search-results__title" aria-live="polite">Results</h2>
12
+ <div class="search-results__content"></div>
13
+ </div>
14
+ </div>
15
+ </div>
16
+ <% end %>
@@ -0,0 +1,82 @@
1
+ <!doctype html>
2
+ <html lang="en" class="no-js">
3
+ <head>
4
+ <meta content="IE=edge" http-equiv="X-UA-Compatible">
5
+ <meta charset="utf-8">
6
+ <meta content="width=device-width,initial-scale=1.0,minimum-scale=1.0,maximum-scale=1.0,user-scalable=no" name="viewport">
7
+ <% if config[:tech_docs][:prevent_indexing] %>
8
+ <meta name="robots" content="noindex">
9
+ <% end %>
10
+
11
+ <title><%= meta_tags.browser_title %></title>
12
+
13
+ <!--[if gt IE 8]><!--><%= stylesheet_link_tag :screen, media: 'screen' %><!--<![endif]-->
14
+ <!--[if lte IE 8]><%= stylesheet_link_tag 'screen-old-ie', media: 'screen' %><![endif]-->
15
+
16
+ <link rel="canonical" href="<%= meta_tags.canonical_url %>">
17
+
18
+ <% if config[:tech_docs][:google_site_verification] %>
19
+ <meta name="google-site-verification" content="<%= config[:tech_docs][:google_site_verification] %>" />
20
+ <% end %>
21
+
22
+ <%= stylesheet_link_tag :print, media: 'print' %>
23
+ <%= javascript_include_tag :application %>
24
+
25
+ <% meta_tags.tags.each do |property, content| %>
26
+ <%= tag :meta, property: property, content: content %>
27
+ <% end %>
28
+
29
+ <%= yield_content :head %>
30
+ </head>
31
+
32
+ <body>
33
+ <div class="app-pane">
34
+ <div class="app-pane__header toc-open-disabled">
35
+ <a href="#content" class="skip-link">Skip to main content</a>
36
+
37
+ <%= partial 'layouts/header' %>
38
+ </div>
39
+
40
+ <% if content_for? :sidebar %>
41
+ <div id="toc-heading" class="toc-show fixedsticky">
42
+ <a href="#toc" class="toc-show__label js-toc-show" aria-controls="toc">
43
+ Table of contents <span class="toc-show__icon"></span>
44
+ </a>
45
+ </div>
46
+ <% end %>
47
+
48
+ <div class="app-pane__body"<%= " data-module=\"#{yield_content(:toc_module)}\"" if content_for? :toc_module %>>
49
+ <% if content_for? :sidebar %>
50
+ <div class="app-pane__toc">
51
+ <div class="toc" data-module="table-of-contents">
52
+ <%= partial "layouts/search" %>
53
+ <a href="#" class="toc__close js-toc-close" aria-controls="toc" aria-label="Hide table of contents"></a>
54
+ <nav id="toc" class="js-toc-list toc__list" aria-labelledby="toc-heading"<%= " data-module=\"collapsible-navigation\"" if config[:tech_docs][:collapsible_nav] %>>
55
+ <%= yield_content :sidebar %>
56
+ </nav>
57
+ </div>
58
+ </div>
59
+ <% end %>
60
+
61
+ <div class="app-pane__content toc-open-disabled">
62
+ <main id="content" class="technical-documentation" data-module="anchored-headings">
63
+ <%= yield %>
64
+ <%= partial "layouts/page_review" %>
65
+ </main>
66
+
67
+ <% if config[:tech_docs][:show_contribution_banner] %>
68
+ <ul class="contribution-banner">
69
+ <li><%= link_to "View source", source_urls.view_source_url %></li>
70
+ <li><%= link_to "Report problem", source_urls.report_issue_url %></li>
71
+ <li><%= link_to "GitHub Repo", source_urls.repo_url %></li>
72
+ </ul>
73
+ <% end %>
74
+
75
+ <%= partial "layouts/footer" %>
76
+ </div>
77
+ </div>
78
+ </div>
79
+
80
+ <%= partial 'layouts/analytics' %>
81
+ </body>
82
+ </html>
@@ -0,0 +1,18 @@
1
+ <%
2
+ wrap_layout :core do
3
+ html = yield
4
+
5
+ content_for(:toc_module, "in-page-navigation")
6
+
7
+ content_for :sidebar do
8
+ if config[:tech_docs][:multipage_nav] %>
9
+ <%= multi_page_table_of_contents(sitemap.resources, current_page, config, html) %>
10
+ <% else %>
11
+ <%= single_page_table_of_contents(html, max_level: config[:tech_docs][:max_toc_heading_level]) %>
12
+ <% end %>
13
+ <%
14
+ end
15
+
16
+ html
17
+ end
18
+ %>
metadata ADDED
@@ -0,0 +1,474 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: dss_tech_docs
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - Digital Shared Services
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2019-05-12 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: activesupport
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - ">="
18
+ - !ruby/object:Gem::Version
19
+ version: '0'
20
+ type: :runtime
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - ">="
25
+ - !ruby/object:Gem::Version
26
+ version: '0'
27
+ - !ruby/object:Gem::Dependency
28
+ name: chronic
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: 0.10.2
34
+ type: :runtime
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: 0.10.2
41
+ - !ruby/object:Gem::Dependency
42
+ name: middleman
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: '4.0'
48
+ type: :runtime
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: '4.0'
55
+ - !ruby/object:Gem::Dependency
56
+ name: middleman-autoprefixer
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - "~>"
60
+ - !ruby/object:Gem::Version
61
+ version: 2.7.0
62
+ type: :runtime
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - "~>"
67
+ - !ruby/object:Gem::Version
68
+ version: 2.7.0
69
+ - !ruby/object:Gem::Dependency
70
+ name: middleman-compass
71
+ requirement: !ruby/object:Gem::Requirement
72
+ requirements:
73
+ - - ">="
74
+ - !ruby/object:Gem::Version
75
+ version: 4.0.0
76
+ type: :runtime
77
+ prerelease: false
78
+ version_requirements: !ruby/object:Gem::Requirement
79
+ requirements:
80
+ - - ">="
81
+ - !ruby/object:Gem::Version
82
+ version: 4.0.0
83
+ - !ruby/object:Gem::Dependency
84
+ name: middleman-livereload
85
+ requirement: !ruby/object:Gem::Requirement
86
+ requirements:
87
+ - - ">="
88
+ - !ruby/object:Gem::Version
89
+ version: '0'
90
+ type: :runtime
91
+ prerelease: false
92
+ version_requirements: !ruby/object:Gem::Requirement
93
+ requirements:
94
+ - - ">="
95
+ - !ruby/object:Gem::Version
96
+ version: '0'
97
+ - !ruby/object:Gem::Dependency
98
+ name: middleman-sprockets
99
+ requirement: !ruby/object:Gem::Requirement
100
+ requirements:
101
+ - - "~>"
102
+ - !ruby/object:Gem::Version
103
+ version: 4.0.0
104
+ type: :runtime
105
+ prerelease: false
106
+ version_requirements: !ruby/object:Gem::Requirement
107
+ requirements:
108
+ - - "~>"
109
+ - !ruby/object:Gem::Version
110
+ version: 4.0.0
111
+ - !ruby/object:Gem::Dependency
112
+ name: middleman-syntax
113
+ requirement: !ruby/object:Gem::Requirement
114
+ requirements:
115
+ - - "~>"
116
+ - !ruby/object:Gem::Version
117
+ version: 3.0.0
118
+ type: :runtime
119
+ prerelease: false
120
+ version_requirements: !ruby/object:Gem::Requirement
121
+ requirements:
122
+ - - "~>"
123
+ - !ruby/object:Gem::Version
124
+ version: 3.0.0
125
+ - !ruby/object:Gem::Dependency
126
+ name: middleman-search-gds
127
+ requirement: !ruby/object:Gem::Requirement
128
+ requirements:
129
+ - - "~>"
130
+ - !ruby/object:Gem::Version
131
+ version: 0.11.0a
132
+ type: :runtime
133
+ prerelease: false
134
+ version_requirements: !ruby/object:Gem::Requirement
135
+ requirements:
136
+ - - "~>"
137
+ - !ruby/object:Gem::Version
138
+ version: 0.11.0a
139
+ - !ruby/object:Gem::Dependency
140
+ name: nokogiri
141
+ requirement: !ruby/object:Gem::Requirement
142
+ requirements:
143
+ - - ">="
144
+ - !ruby/object:Gem::Version
145
+ version: '0'
146
+ type: :runtime
147
+ prerelease: false
148
+ version_requirements: !ruby/object:Gem::Requirement
149
+ requirements:
150
+ - - ">="
151
+ - !ruby/object:Gem::Version
152
+ version: '0'
153
+ - !ruby/object:Gem::Dependency
154
+ name: redcarpet
155
+ requirement: !ruby/object:Gem::Requirement
156
+ requirements:
157
+ - - "~>"
158
+ - !ruby/object:Gem::Version
159
+ version: 3.3.2
160
+ type: :runtime
161
+ prerelease: false
162
+ version_requirements: !ruby/object:Gem::Requirement
163
+ requirements:
164
+ - - "~>"
165
+ - !ruby/object:Gem::Version
166
+ version: 3.3.2
167
+ - !ruby/object:Gem::Dependency
168
+ name: openapi3_parser
169
+ requirement: !ruby/object:Gem::Requirement
170
+ requirements:
171
+ - - ">="
172
+ - !ruby/object:Gem::Version
173
+ version: '0'
174
+ type: :runtime
175
+ prerelease: false
176
+ version_requirements: !ruby/object:Gem::Requirement
177
+ requirements:
178
+ - - ">="
179
+ - !ruby/object:Gem::Version
180
+ version: '0'
181
+ - !ruby/object:Gem::Dependency
182
+ name: pry
183
+ requirement: !ruby/object:Gem::Requirement
184
+ requirements:
185
+ - - ">="
186
+ - !ruby/object:Gem::Version
187
+ version: '0'
188
+ type: :runtime
189
+ prerelease: false
190
+ version_requirements: !ruby/object:Gem::Requirement
191
+ requirements:
192
+ - - ">="
193
+ - !ruby/object:Gem::Version
194
+ version: '0'
195
+ - !ruby/object:Gem::Dependency
196
+ name: bundler
197
+ requirement: !ruby/object:Gem::Requirement
198
+ requirements:
199
+ - - "~>"
200
+ - !ruby/object:Gem::Version
201
+ version: 2.0.1
202
+ type: :development
203
+ prerelease: false
204
+ version_requirements: !ruby/object:Gem::Requirement
205
+ requirements:
206
+ - - "~>"
207
+ - !ruby/object:Gem::Version
208
+ version: 2.0.1
209
+ - !ruby/object:Gem::Dependency
210
+ name: rake
211
+ requirement: !ruby/object:Gem::Requirement
212
+ requirements:
213
+ - - "~>"
214
+ - !ruby/object:Gem::Version
215
+ version: '10.0'
216
+ type: :development
217
+ prerelease: false
218
+ version_requirements: !ruby/object:Gem::Requirement
219
+ requirements:
220
+ - - "~>"
221
+ - !ruby/object:Gem::Version
222
+ version: '10.0'
223
+ - !ruby/object:Gem::Dependency
224
+ name: capybara
225
+ requirement: !ruby/object:Gem::Requirement
226
+ requirements:
227
+ - - "~>"
228
+ - !ruby/object:Gem::Version
229
+ version: 2.18.0
230
+ type: :development
231
+ prerelease: false
232
+ version_requirements: !ruby/object:Gem::Requirement
233
+ requirements:
234
+ - - "~>"
235
+ - !ruby/object:Gem::Version
236
+ version: 2.18.0
237
+ - !ruby/object:Gem::Dependency
238
+ name: govuk-lint
239
+ requirement: !ruby/object:Gem::Requirement
240
+ requirements:
241
+ - - "~>"
242
+ - !ruby/object:Gem::Version
243
+ version: 3.7.0
244
+ type: :development
245
+ prerelease: false
246
+ version_requirements: !ruby/object:Gem::Requirement
247
+ requirements:
248
+ - - "~>"
249
+ - !ruby/object:Gem::Version
250
+ version: 3.7.0
251
+ - !ruby/object:Gem::Dependency
252
+ name: jasmine
253
+ requirement: !ruby/object:Gem::Requirement
254
+ requirements:
255
+ - - "~>"
256
+ - !ruby/object:Gem::Version
257
+ version: 3.1.0
258
+ type: :development
259
+ prerelease: false
260
+ version_requirements: !ruby/object:Gem::Requirement
261
+ requirements:
262
+ - - "~>"
263
+ - !ruby/object:Gem::Version
264
+ version: 3.1.0
265
+ - !ruby/object:Gem::Dependency
266
+ name: rspec
267
+ requirement: !ruby/object:Gem::Requirement
268
+ requirements:
269
+ - - "~>"
270
+ - !ruby/object:Gem::Version
271
+ version: 3.7.0
272
+ type: :development
273
+ prerelease: false
274
+ version_requirements: !ruby/object:Gem::Requirement
275
+ requirements:
276
+ - - "~>"
277
+ - !ruby/object:Gem::Version
278
+ version: 3.7.0
279
+ - !ruby/object:Gem::Dependency
280
+ name: byebug
281
+ requirement: !ruby/object:Gem::Requirement
282
+ requirements:
283
+ - - ">="
284
+ - !ruby/object:Gem::Version
285
+ version: '0'
286
+ type: :development
287
+ prerelease: false
288
+ version_requirements: !ruby/object:Gem::Requirement
289
+ requirements:
290
+ - - ">="
291
+ - !ruby/object:Gem::Version
292
+ version: '0'
293
+ description: Gem to distribute the DSS Tech Docs Template. See https://github.com/dof-dss/tech-docs-gem
294
+ for the project.
295
+ email:
296
+ - stephen.patterson@finance-ni.gov.uk
297
+ executables: []
298
+ extensions: []
299
+ extra_rdoc_files: []
300
+ files:
301
+ - ".editorconfig"
302
+ - ".gitignore"
303
+ - ".rspec"
304
+ - ".rubocop.yml"
305
+ - ".ruby-version"
306
+ - ".travis.yml"
307
+ - CHANGELOG.md
308
+ - CONTRIBUTING.md
309
+ - Gemfile
310
+ - LICENCE
311
+ - README.md
312
+ - Rakefile
313
+ - docs/configuration.md
314
+ - docs/core-layout-without-sidebar.png
315
+ - docs/core-layout.png
316
+ - docs/expired-page.png
317
+ - docs/frontmatter.md
318
+ - docs/last-reviewed-only.png
319
+ - docs/last-reviewed-only.svg
320
+ - docs/layout-layout.png
321
+ - docs/not-expired-page.png
322
+ - docs/page-expiry.md
323
+ - dss_tech_docs.gemspec
324
+ - example/.ruby-version
325
+ - example/Gemfile
326
+ - example/config.rb
327
+ - example/config/hide-expiry.yml
328
+ - example/config/tech-docs.yml
329
+ - example/source/api-path.html.md
330
+ - example/source/api-reference.html.md
331
+ - example/source/child-of-expired-page.html.md
332
+ - example/source/core-layout-without-sidebar.html.md.erb
333
+ - example/source/core-layout.html.md.erb
334
+ - example/source/expired-page-with-owner.html.md
335
+ - example/source/expired-page.html.md
336
+ - example/source/headings.html.md
337
+ - example/source/index.html.md.erb
338
+ - example/source/javascripts/application.js
339
+ - example/source/not-expired-page.html.md
340
+ - example/source/pets.yml
341
+ - example/source/stylesheets/print.css.scss
342
+ - example/source/stylesheets/screen-old-ie.css.scss
343
+ - example/source/stylesheets/screen.css.scss
344
+ - example/source/templates/proxy_template.html.md
345
+ - lib/assets/javascripts/_analytics.js
346
+ - lib/assets/javascripts/_govuk/modules.js
347
+ - lib/assets/javascripts/_modules/anchored-headings.js
348
+ - lib/assets/javascripts/_modules/collapsible-navigation.js
349
+ - lib/assets/javascripts/_modules/in-page-navigation.js
350
+ - lib/assets/javascripts/_modules/navigation.js
351
+ - lib/assets/javascripts/_modules/page-expiry.js
352
+ - lib/assets/javascripts/_modules/search.js
353
+ - lib/assets/javascripts/_modules/table-of-contents.js
354
+ - lib/assets/javascripts/_start-modules.js
355
+ - lib/assets/javascripts/_vendor/fixedsticky.js
356
+ - lib/assets/javascripts/_vendor/jquery.js
357
+ - lib/assets/javascripts/_vendor/jquery.mark.js
358
+ - lib/assets/javascripts/_vendor/lodash.js
359
+ - lib/assets/javascripts/_vendor/modernizr.js
360
+ - lib/assets/javascripts/govuk_tech_docs.js
361
+ - lib/assets/stylesheets/_accessibility.scss
362
+ - lib/assets/stylesheets/_core.scss
363
+ - lib/assets/stylesheets/_fonts.scss
364
+ - lib/assets/stylesheets/_govuk_tech_docs.scss
365
+ - lib/assets/stylesheets/_syntax-highlighting.scss
366
+ - lib/assets/stylesheets/_variables.scss
367
+ - lib/assets/stylesheets/govuk_frontend_toolkit/_colours.scss
368
+ - lib/assets/stylesheets/govuk_frontend_toolkit/_conditionals.scss
369
+ - lib/assets/stylesheets/govuk_frontend_toolkit/_css3.scss
370
+ - lib/assets/stylesheets/govuk_frontend_toolkit/_device-pixels.scss
371
+ - lib/assets/stylesheets/govuk_frontend_toolkit/_font_stack.scss
372
+ - lib/assets/stylesheets/govuk_frontend_toolkit/_grid_layout.scss
373
+ - lib/assets/stylesheets/govuk_frontend_toolkit/_helpers.scss
374
+ - lib/assets/stylesheets/govuk_frontend_toolkit/_measurements.scss
375
+ - lib/assets/stylesheets/govuk_frontend_toolkit/_shims.scss
376
+ - lib/assets/stylesheets/govuk_frontend_toolkit/_typography.scss
377
+ - lib/assets/stylesheets/govuk_frontend_toolkit/_url-helpers.scss
378
+ - lib/assets/stylesheets/govuk_frontend_toolkit/colours/_organisation.scss
379
+ - lib/assets/stylesheets/govuk_frontend_toolkit/colours/_palette.scss
380
+ - lib/assets/stylesheets/govuk_frontend_toolkit/design-patterns/_alpha-beta.scss
381
+ - lib/assets/stylesheets/govuk_frontend_toolkit/design-patterns/_breadcrumbs.scss
382
+ - lib/assets/stylesheets/govuk_frontend_toolkit/design-patterns/_buttons.scss
383
+ - lib/assets/stylesheets/govuk_frontend_toolkit/design-patterns/_media-player.scss
384
+ - lib/assets/stylesheets/modules/_anchored-heading.scss
385
+ - lib/assets/stylesheets/modules/_app-pane.scss
386
+ - lib/assets/stylesheets/modules/_collapsible.scss
387
+ - lib/assets/stylesheets/modules/_contribution-banner.scss
388
+ - lib/assets/stylesheets/modules/_footer.scss
389
+ - lib/assets/stylesheets/modules/_govuk-logo.scss
390
+ - lib/assets/stylesheets/modules/_header.scss
391
+ - lib/assets/stylesheets/modules/_page-review.scss
392
+ - lib/assets/stylesheets/modules/_phase-banner.scss
393
+ - lib/assets/stylesheets/modules/_search.scss
394
+ - lib/assets/stylesheets/modules/_skip-link.scss
395
+ - lib/assets/stylesheets/modules/_technical-documentation.scss
396
+ - lib/assets/stylesheets/modules/_toc.scss
397
+ - lib/assets/stylesheets/modules/_warning-text.scss
398
+ - lib/assets/stylesheets/palette/_syntax-highlighting.scss
399
+ - lib/assets/stylesheets/utilities/_fonts.scss
400
+ - lib/assets/stylesheets/utilities/_printable.scss
401
+ - lib/assets/stylesheets/vendor/_fixedsticky.scss
402
+ - lib/dss_tech_docs.rb
403
+ - lib/govuk_tech_docs/api_reference/api_reference_extension.rb
404
+ - lib/govuk_tech_docs/api_reference/api_reference_renderer.rb
405
+ - lib/govuk_tech_docs/api_reference/templates/api_reference_full.html.erb
406
+ - lib/govuk_tech_docs/api_reference/templates/operation.html.erb
407
+ - lib/govuk_tech_docs/api_reference/templates/parameters.html.erb
408
+ - lib/govuk_tech_docs/api_reference/templates/path.html.erb
409
+ - lib/govuk_tech_docs/api_reference/templates/responses.html.erb
410
+ - lib/govuk_tech_docs/api_reference/templates/schema.html.erb
411
+ - lib/govuk_tech_docs/contribution_banner.rb
412
+ - lib/govuk_tech_docs/meta_tags.rb
413
+ - lib/govuk_tech_docs/page_review.rb
414
+ - lib/govuk_tech_docs/pages.rb
415
+ - lib/govuk_tech_docs/redirects.rb
416
+ - lib/govuk_tech_docs/table_of_contents/heading.rb
417
+ - lib/govuk_tech_docs/table_of_contents/heading_tree.rb
418
+ - lib/govuk_tech_docs/table_of_contents/heading_tree_builder.rb
419
+ - lib/govuk_tech_docs/table_of_contents/heading_tree_renderer.rb
420
+ - lib/govuk_tech_docs/table_of_contents/headings_builder.rb
421
+ - lib/govuk_tech_docs/table_of_contents/helpers.rb
422
+ - lib/govuk_tech_docs/tech_docs_html_renderer.rb
423
+ - lib/govuk_tech_docs/unique_identifier_extension.rb
424
+ - lib/govuk_tech_docs/unique_identifier_generator.rb
425
+ - lib/govuk_tech_docs/version.rb
426
+ - lib/govuk_tech_docs/warning_text_extension.rb
427
+ - lib/source/api/pages.json.erb
428
+ - lib/source/favicon.ico
429
+ - lib/source/images/anchored-heading-icon-2x.png
430
+ - lib/source/images/anchored-heading-icon.png
431
+ - lib/source/images/gov.uk_logotype_crown-2x.png
432
+ - lib/source/images/gov.uk_logotype_crown.png
433
+ - lib/source/images/gov.uk_logotype_crown_invert_trans.png
434
+ - lib/source/images/govuk-crest-2x.png
435
+ - lib/source/images/govuk-crest.png
436
+ - lib/source/images/govuk-icn-close.png
437
+ - lib/source/images/govuk-icn-close@2x.png
438
+ - lib/source/images/govuk-icn-numbered-list.png
439
+ - lib/source/images/govuk-icn-numbered-list@2x.png
440
+ - lib/source/images/open-government-licence.png
441
+ - lib/source/images/open-government-licence_2x.png
442
+ - lib/source/images/search-result-caret.svg
443
+ - lib/source/layouts/_analytics.erb
444
+ - lib/source/layouts/_footer.erb
445
+ - lib/source/layouts/_header.erb
446
+ - lib/source/layouts/_page_review.erb
447
+ - lib/source/layouts/_search.erb
448
+ - lib/source/layouts/core.erb
449
+ - lib/source/layouts/layout.erb
450
+ homepage: https://github.com/dof-dss/tech-docs-gem
451
+ licenses:
452
+ - MIT
453
+ metadata: {}
454
+ post_install_message:
455
+ rdoc_options: []
456
+ require_paths:
457
+ - lib
458
+ required_ruby_version: !ruby/object:Gem::Requirement
459
+ requirements:
460
+ - - ">="
461
+ - !ruby/object:Gem::Version
462
+ version: '0'
463
+ required_rubygems_version: !ruby/object:Gem::Requirement
464
+ requirements:
465
+ - - ">="
466
+ - !ruby/object:Gem::Version
467
+ version: '0'
468
+ requirements: []
469
+ rubyforge_project:
470
+ rubygems_version: 2.6.13
471
+ signing_key:
472
+ specification_version: 4
473
+ summary: Gem to distribute the DSS Tech Docs Template
474
+ test_files: []