govuk_tech_docs 2.0.11 → 2.2.0

Sign up to get free protection for your applications and to get access to all the features.

Potentially problematic release.

This version of govuk_tech_docs might be problematic. Click here for more details.

Files changed (31) hide show
  1. checksums.yaml +4 -4
  2. data/.github/pull_request_template.md +1 -0
  3. data/.rubocop.yml +1 -1
  4. data/.ruby-version +1 -1
  5. data/.travis.yml +3 -0
  6. data/CHANGELOG.md +53 -1
  7. data/README.md +15 -22
  8. data/Rakefile +1 -0
  9. data/example/.ruby-version +1 -1
  10. data/example/source/index.html.md.erb +1 -0
  11. data/example/source/prevent-index-page.html.md +10 -0
  12. data/govuk_tech_docs.gemspec +12 -12
  13. data/lib/assets/javascripts/_modules/search.js +13 -2
  14. data/lib/assets/javascripts/_modules/table-of-contents.js +9 -14
  15. data/lib/assets/stylesheets/modules/_page-review.scss +3 -5
  16. data/lib/assets/stylesheets/modules/_search.scss +43 -9
  17. data/lib/assets/stylesheets/modules/_technical-documentation.scss +11 -2
  18. data/lib/assets/stylesheets/modules/_toc.scss +12 -2
  19. data/lib/assets/stylesheets/palette/_syntax-highlighting.scss +1 -1
  20. data/lib/govuk_tech_docs/api_reference/api_reference_extension.rb +1 -1
  21. data/lib/govuk_tech_docs/meta_tags.rb +28 -9
  22. data/lib/govuk_tech_docs/tech_docs_html_renderer.rb +75 -1
  23. data/lib/govuk_tech_docs/version.rb +1 -1
  24. data/lib/source/images/search-button.png +0 -0
  25. data/lib/source/layouts/_footer.erb +1 -1
  26. data/lib/source/layouts/_header.erb +2 -2
  27. data/lib/source/layouts/_search.erb +10 -4
  28. data/lib/source/layouts/core.erb +7 -10
  29. data/package-lock.json +526 -358
  30. data/package.json +2 -2
  31. metadata +66 -64
data/package.json CHANGED
@@ -6,10 +6,10 @@
6
6
  "lint": "standard"
7
7
  },
8
8
  "dependencies": {
9
- "govuk-frontend": "^3.1.0"
9
+ "govuk-frontend": "^3.6.0"
10
10
  },
11
11
  "devDependencies": {
12
- "standard": "^13.0.2"
12
+ "standard": "^14.3.0"
13
13
  },
14
14
  "standard": {
15
15
  "globals": [
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: govuk_tech_docs
3
3
  version: !ruby/object:Gem::Version
4
- version: 2.0.11
4
+ version: 2.2.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Government Digital Service
8
8
  autorequire:
9
9
  bindir: exe
10
10
  cert_chain: []
11
- date: 2019-11-25 00:00:00.000000000 Z
11
+ date: 2021-03-12 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: activesupport
@@ -58,14 +58,14 @@ dependencies:
58
58
  requirements:
59
59
  - - "~>"
60
60
  - !ruby/object:Gem::Version
61
- version: 2.7.0
61
+ version: 2.10.0
62
62
  type: :runtime
63
63
  prerelease: false
64
64
  version_requirements: !ruby/object:Gem::Requirement
65
65
  requirements:
66
66
  - - "~>"
67
67
  - !ruby/object:Gem::Version
68
- version: 2.7.0
68
+ version: 2.10.0
69
69
  - !ruby/object:Gem::Dependency
70
70
  name: middleman-compass
71
71
  requirement: !ruby/object:Gem::Requirement
@@ -94,6 +94,20 @@ dependencies:
94
94
  - - ">="
95
95
  - !ruby/object:Gem::Version
96
96
  version: '0'
97
+ - !ruby/object:Gem::Dependency
98
+ name: middleman-search-gds
99
+ requirement: !ruby/object:Gem::Requirement
100
+ requirements:
101
+ - - ">="
102
+ - !ruby/object:Gem::Version
103
+ version: '0'
104
+ type: :runtime
105
+ prerelease: false
106
+ version_requirements: !ruby/object:Gem::Requirement
107
+ requirements:
108
+ - - ">="
109
+ - !ruby/object:Gem::Version
110
+ version: '0'
97
111
  - !ruby/object:Gem::Dependency
98
112
  name: middleman-sprockets
99
113
  requirement: !ruby/object:Gem::Requirement
@@ -109,21 +123,21 @@ dependencies:
109
123
  - !ruby/object:Gem::Version
110
124
  version: 4.0.0
111
125
  - !ruby/object:Gem::Dependency
112
- name: sprockets
126
+ name: middleman-syntax
113
127
  requirement: !ruby/object:Gem::Requirement
114
128
  requirements:
115
- - - '='
129
+ - - "~>"
116
130
  - !ruby/object:Gem::Version
117
- version: 4.0.0.beta10
131
+ version: 3.2.0
118
132
  type: :runtime
119
133
  prerelease: false
120
134
  version_requirements: !ruby/object:Gem::Requirement
121
135
  requirements:
122
- - - '='
136
+ - - "~>"
123
137
  - !ruby/object:Gem::Version
124
- version: 4.0.0.beta10
138
+ version: 3.2.0
125
139
  - !ruby/object:Gem::Dependency
126
- name: sass
140
+ name: nokogiri
127
141
  requirement: !ruby/object:Gem::Requirement
128
142
  requirements:
129
143
  - - ">="
@@ -137,35 +151,21 @@ dependencies:
137
151
  - !ruby/object:Gem::Version
138
152
  version: '0'
139
153
  - !ruby/object:Gem::Dependency
140
- name: middleman-syntax
154
+ name: openapi3_parser
141
155
  requirement: !ruby/object:Gem::Requirement
142
156
  requirements:
143
157
  - - "~>"
144
158
  - !ruby/object:Gem::Version
145
- version: 3.0.0
159
+ version: 0.5.0
146
160
  type: :runtime
147
161
  prerelease: false
148
162
  version_requirements: !ruby/object:Gem::Requirement
149
163
  requirements:
150
164
  - - "~>"
151
165
  - !ruby/object:Gem::Version
152
- version: 3.0.0
153
- - !ruby/object:Gem::Dependency
154
- name: middleman-search-gds
155
- requirement: !ruby/object:Gem::Requirement
156
- requirements:
157
- - - ">="
158
- - !ruby/object:Gem::Version
159
- version: '0'
160
- type: :runtime
161
- prerelease: false
162
- version_requirements: !ruby/object:Gem::Requirement
163
- requirements:
164
- - - ">="
165
- - !ruby/object:Gem::Version
166
- version: '0'
166
+ version: 0.5.0
167
167
  - !ruby/object:Gem::Dependency
168
- name: nokogiri
168
+ name: pry
169
169
  requirement: !ruby/object:Gem::Requirement
170
170
  requirements:
171
171
  - - ">="
@@ -184,140 +184,140 @@ dependencies:
184
184
  requirements:
185
185
  - - "~>"
186
186
  - !ruby/object:Gem::Version
187
- version: 3.3.2
187
+ version: 3.5.0
188
188
  type: :runtime
189
189
  prerelease: false
190
190
  version_requirements: !ruby/object:Gem::Requirement
191
191
  requirements:
192
192
  - - "~>"
193
193
  - !ruby/object:Gem::Version
194
- version: 3.3.2
194
+ version: 3.5.0
195
195
  - !ruby/object:Gem::Dependency
196
- name: openapi3_parser
196
+ name: sass
197
197
  requirement: !ruby/object:Gem::Requirement
198
198
  requirements:
199
- - - "~>"
199
+ - - ">="
200
200
  - !ruby/object:Gem::Version
201
- version: 0.5.0
201
+ version: '0'
202
202
  type: :runtime
203
203
  prerelease: false
204
204
  version_requirements: !ruby/object:Gem::Requirement
205
205
  requirements:
206
- - - "~>"
206
+ - - ">="
207
207
  - !ruby/object:Gem::Version
208
- version: 0.5.0
208
+ version: '0'
209
209
  - !ruby/object:Gem::Dependency
210
- name: pry
210
+ name: sprockets
211
211
  requirement: !ruby/object:Gem::Requirement
212
212
  requirements:
213
- - - ">="
213
+ - - "~>"
214
214
  - !ruby/object:Gem::Version
215
- version: '0'
215
+ version: 4.0.0
216
216
  type: :runtime
217
217
  prerelease: false
218
218
  version_requirements: !ruby/object:Gem::Requirement
219
219
  requirements:
220
- - - ">="
220
+ - - "~>"
221
221
  - !ruby/object:Gem::Version
222
- version: '0'
222
+ version: 4.0.0
223
223
  - !ruby/object:Gem::Dependency
224
224
  name: bundler
225
225
  requirement: !ruby/object:Gem::Requirement
226
226
  requirements:
227
227
  - - "~>"
228
228
  - !ruby/object:Gem::Version
229
- version: 2.0.1
229
+ version: 2.2.0
230
230
  type: :development
231
231
  prerelease: false
232
232
  version_requirements: !ruby/object:Gem::Requirement
233
233
  requirements:
234
234
  - - "~>"
235
235
  - !ruby/object:Gem::Version
236
- version: 2.0.1
236
+ version: 2.2.0
237
237
  - !ruby/object:Gem::Dependency
238
- name: rake
238
+ name: byebug
239
239
  requirement: !ruby/object:Gem::Requirement
240
240
  requirements:
241
- - - "~>"
241
+ - - ">="
242
242
  - !ruby/object:Gem::Version
243
- version: '10.0'
243
+ version: '0'
244
244
  type: :development
245
245
  prerelease: false
246
246
  version_requirements: !ruby/object:Gem::Requirement
247
247
  requirements:
248
- - - "~>"
248
+ - - ">="
249
249
  - !ruby/object:Gem::Version
250
- version: '10.0'
250
+ version: '0'
251
251
  - !ruby/object:Gem::Dependency
252
252
  name: capybara
253
253
  requirement: !ruby/object:Gem::Requirement
254
254
  requirements:
255
255
  - - "~>"
256
256
  - !ruby/object:Gem::Version
257
- version: 2.18.0
257
+ version: '3.32'
258
258
  type: :development
259
259
  prerelease: false
260
260
  version_requirements: !ruby/object:Gem::Requirement
261
261
  requirements:
262
262
  - - "~>"
263
263
  - !ruby/object:Gem::Version
264
- version: 2.18.0
264
+ version: '3.32'
265
265
  - !ruby/object:Gem::Dependency
266
- name: rubocop-govuk
266
+ name: jasmine
267
267
  requirement: !ruby/object:Gem::Requirement
268
268
  requirements:
269
269
  - - "~>"
270
270
  - !ruby/object:Gem::Version
271
- version: 1.0.0
271
+ version: 3.5.0
272
272
  type: :development
273
273
  prerelease: false
274
274
  version_requirements: !ruby/object:Gem::Requirement
275
275
  requirements:
276
276
  - - "~>"
277
277
  - !ruby/object:Gem::Version
278
- version: 1.0.0
278
+ version: 3.5.0
279
279
  - !ruby/object:Gem::Dependency
280
- name: jasmine
280
+ name: rake
281
281
  requirement: !ruby/object:Gem::Requirement
282
282
  requirements:
283
283
  - - "~>"
284
284
  - !ruby/object:Gem::Version
285
- version: 3.1.0
285
+ version: '13.0'
286
286
  type: :development
287
287
  prerelease: false
288
288
  version_requirements: !ruby/object:Gem::Requirement
289
289
  requirements:
290
290
  - - "~>"
291
291
  - !ruby/object:Gem::Version
292
- version: 3.1.0
292
+ version: '13.0'
293
293
  - !ruby/object:Gem::Dependency
294
294
  name: rspec
295
295
  requirement: !ruby/object:Gem::Requirement
296
296
  requirements:
297
297
  - - "~>"
298
298
  - !ruby/object:Gem::Version
299
- version: 3.7.0
299
+ version: 3.9.0
300
300
  type: :development
301
301
  prerelease: false
302
302
  version_requirements: !ruby/object:Gem::Requirement
303
303
  requirements:
304
304
  - - "~>"
305
305
  - !ruby/object:Gem::Version
306
- version: 3.7.0
306
+ version: 3.9.0
307
307
  - !ruby/object:Gem::Dependency
308
- name: byebug
308
+ name: rubocop-govuk
309
309
  requirement: !ruby/object:Gem::Requirement
310
310
  requirements:
311
- - - ">="
311
+ - - "~>"
312
312
  - !ruby/object:Gem::Version
313
- version: '0'
313
+ version: 3.5.0
314
314
  type: :development
315
315
  prerelease: false
316
316
  version_requirements: !ruby/object:Gem::Requirement
317
317
  requirements:
318
- - - ">="
318
+ - - "~>"
319
319
  - !ruby/object:Gem::Version
320
- version: '0'
320
+ version: 3.5.0
321
321
  description: Gem to distribute the GOV.UK Tech Docs Template. See https://github.com/alphagov/tech-docs-gem
322
322
  for the project.
323
323
  email:
@@ -327,6 +327,7 @@ extensions: []
327
327
  extra_rdoc_files: []
328
328
  files:
329
329
  - ".editorconfig"
330
+ - ".github/pull_request_template.md"
330
331
  - ".gitignore"
331
332
  - ".nvmrc"
332
333
  - ".rspec"
@@ -363,6 +364,7 @@ files:
363
364
  - example/source/nested-page/index.html.md
364
365
  - example/source/not-expired-page.html.md
365
366
  - example/source/pets.yml
367
+ - example/source/prevent-index-page.html.md
366
368
  - example/source/stylesheets/print.css.scss
367
369
  - example/source/stylesheets/screen-old-ie.css.scss
368
370
  - example/source/stylesheets/screen.css.scss
@@ -432,6 +434,7 @@ files:
432
434
  - lib/source/images/govuk-icn-close@2x.png
433
435
  - lib/source/images/govuk-icn-numbered-list.png
434
436
  - lib/source/images/govuk-icn-numbered-list@2x.png
437
+ - lib/source/images/search-button.png
435
438
  - lib/source/images/search-result-caret.svg
436
439
  - lib/source/layouts/_analytics.erb
437
440
  - lib/source/layouts/_footer.erb
@@ -588,8 +591,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
588
591
  - !ruby/object:Gem::Version
589
592
  version: '0'
590
593
  requirements: []
591
- rubyforge_project:
592
- rubygems_version: 2.7.7
594
+ rubygems_version: 3.0.8
593
595
  signing_key:
594
596
  specification_version: 4
595
597
  summary: Gem to distribute the GOV.UK Tech Docs Template