govuk_tech_docs 2.1.0 → 2.3.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.

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/.nvmrc +1 -1
  4. data/.ruby-version +1 -1
  5. data/.travis.yml +5 -0
  6. data/CHANGELOG.md +41 -2
  7. data/README.md +15 -22
  8. data/example/.ruby-version +1 -1
  9. data/govuk_tech_docs.gemspec +2 -7
  10. data/lib/assets/javascripts/_modules/search.js +13 -2
  11. data/lib/assets/javascripts/_modules/table-of-contents.js +9 -14
  12. data/lib/assets/stylesheets/_govuk_tech_docs.scss +9 -10
  13. data/lib/assets/stylesheets/modules/_page-review.scss +3 -5
  14. data/lib/assets/stylesheets/modules/_search.scss +50 -24
  15. data/lib/assets/stylesheets/modules/_technical-documentation.scss +11 -2
  16. data/lib/assets/stylesheets/modules/_toc.scss +23 -13
  17. data/lib/govuk_tech_docs/api_reference/api_reference_extension.rb +0 -1
  18. data/lib/govuk_tech_docs/api_reference/api_reference_renderer.rb +70 -186
  19. data/lib/govuk_tech_docs/api_reference/templates/api_reference_full.html.erb +3 -2
  20. data/lib/govuk_tech_docs/api_reference/templates/operation.html.erb +1 -1
  21. data/lib/govuk_tech_docs/api_reference/templates/parameters.html.erb +1 -1
  22. data/lib/govuk_tech_docs/api_reference/templates/responses.html.erb +1 -1
  23. data/lib/govuk_tech_docs/api_reference/templates/schema.html.erb +12 -12
  24. data/lib/govuk_tech_docs/tech_docs_html_renderer.rb +75 -1
  25. data/lib/govuk_tech_docs/version.rb +1 -1
  26. data/lib/source/images/search-button.png +0 -0
  27. data/lib/source/layouts/_search.erb +10 -4
  28. data/lib/source/layouts/core.erb +4 -4
  29. data/package-lock.json +358 -288
  30. data/package.json +2 -2
  31. metadata +48 -65
data/package.json CHANGED
@@ -6,10 +6,10 @@
6
6
  "lint": "standard"
7
7
  },
8
8
  "dependencies": {
9
- "govuk-frontend": "^3.6.0"
9
+ "govuk-frontend": "^3.12.0"
10
10
  },
11
11
  "devDependencies": {
12
- "standard": "^14.3.0"
12
+ "standard": "^14.3.4"
13
13
  },
14
14
  "standard": {
15
15
  "globals": [
metadata CHANGED
@@ -1,29 +1,29 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: govuk_tech_docs
3
3
  version: !ruby/object:Gem::Version
4
- version: 2.1.0
4
+ version: 2.3.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: 2020-09-07 00:00:00.000000000 Z
11
+ date: 2021-05-18 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
- name: activesupport
14
+ name: autoprefixer-rails
15
15
  requirement: !ruby/object:Gem::Requirement
16
16
  requirements:
17
- - - ">="
17
+ - - "~>"
18
18
  - !ruby/object:Gem::Version
19
- version: '0'
19
+ version: '10.2'
20
20
  type: :runtime
21
21
  prerelease: false
22
22
  version_requirements: !ruby/object:Gem::Requirement
23
23
  requirements:
24
- - - ">="
24
+ - - "~>"
25
25
  - !ruby/object:Gem::Version
26
- version: '0'
26
+ version: '10.2'
27
27
  - !ruby/object:Gem::Dependency
28
28
  name: chronic
29
29
  requirement: !ruby/object:Gem::Requirement
@@ -156,28 +156,14 @@ dependencies:
156
156
  requirements:
157
157
  - - "~>"
158
158
  - !ruby/object:Gem::Version
159
- version: 0.5.0
159
+ version: 0.9.0
160
160
  type: :runtime
161
161
  prerelease: false
162
162
  version_requirements: !ruby/object:Gem::Requirement
163
163
  requirements:
164
164
  - - "~>"
165
165
  - !ruby/object:Gem::Version
166
- version: 0.5.0
167
- - !ruby/object:Gem::Dependency
168
- name: pry
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'
166
+ version: 0.9.0
181
167
  - !ruby/object:Gem::Dependency
182
168
  name: redcarpet
183
169
  requirement: !ruby/object:Gem::Requirement
@@ -192,48 +178,6 @@ dependencies:
192
178
  - - "~>"
193
179
  - !ruby/object:Gem::Version
194
180
  version: 3.5.0
195
- - !ruby/object:Gem::Dependency
196
- name: sass
197
- requirement: !ruby/object:Gem::Requirement
198
- requirements:
199
- - - ">="
200
- - !ruby/object:Gem::Version
201
- version: '0'
202
- type: :runtime
203
- prerelease: false
204
- version_requirements: !ruby/object:Gem::Requirement
205
- requirements:
206
- - - ">="
207
- - !ruby/object:Gem::Version
208
- version: '0'
209
- - !ruby/object:Gem::Dependency
210
- name: sprockets
211
- requirement: !ruby/object:Gem::Requirement
212
- requirements:
213
- - - "~>"
214
- - !ruby/object:Gem::Version
215
- version: 4.0.0
216
- type: :runtime
217
- prerelease: false
218
- version_requirements: !ruby/object:Gem::Requirement
219
- requirements:
220
- - - "~>"
221
- - !ruby/object:Gem::Version
222
- version: 4.0.0
223
- - !ruby/object:Gem::Dependency
224
- name: bundler
225
- requirement: !ruby/object:Gem::Requirement
226
- requirements:
227
- - - "~>"
228
- - !ruby/object:Gem::Version
229
- version: 2.1.4
230
- type: :development
231
- prerelease: false
232
- version_requirements: !ruby/object:Gem::Requirement
233
- requirements:
234
- - - "~>"
235
- - !ruby/object:Gem::Version
236
- version: 2.1.4
237
181
  - !ruby/object:Gem::Dependency
238
182
  name: byebug
239
183
  requirement: !ruby/object:Gem::Requirement
@@ -327,6 +271,7 @@ extensions: []
327
271
  extra_rdoc_files: []
328
272
  files:
329
273
  - ".editorconfig"
274
+ - ".github/pull_request_template.md"
330
275
  - ".gitignore"
331
276
  - ".nvmrc"
332
277
  - ".rspec"
@@ -433,6 +378,7 @@ files:
433
378
  - lib/source/images/govuk-icn-close@2x.png
434
379
  - lib/source/images/govuk-icn-numbered-list.png
435
380
  - lib/source/images/govuk-icn-numbered-list@2x.png
381
+ - lib/source/images/search-button.png
436
382
  - lib/source/images/search-result-caret.svg
437
383
  - lib/source/layouts/_analytics.erb
438
384
  - lib/source/layouts/_footer.erb
@@ -442,6 +388,7 @@ files:
442
388
  - lib/source/layouts/core.erb
443
389
  - lib/source/layouts/layout.erb
444
390
  - lib/source/stylesheets/manifest.css
391
+ - node_modules/govuk-frontend/govuk/_base.scss
445
392
  - node_modules/govuk-frontend/govuk/all-ie8.scss
446
393
  - node_modules/govuk-frontend/govuk/all.js
447
394
  - node_modules/govuk-frontend/govuk/all.scss
@@ -462,42 +409,76 @@ files:
462
409
  - node_modules/govuk-frontend/govuk/common.js
463
410
  - node_modules/govuk-frontend/govuk/components/_all.scss
464
411
  - node_modules/govuk-frontend/govuk/components/accordion/_accordion.scss
412
+ - node_modules/govuk-frontend/govuk/components/accordion/_index.scss
465
413
  - node_modules/govuk-frontend/govuk/components/accordion/accordion.js
466
414
  - node_modules/govuk-frontend/govuk/components/back-link/_back-link.scss
415
+ - node_modules/govuk-frontend/govuk/components/back-link/_index.scss
467
416
  - node_modules/govuk-frontend/govuk/components/breadcrumbs/_breadcrumbs.scss
417
+ - node_modules/govuk-frontend/govuk/components/breadcrumbs/_index.scss
468
418
  - node_modules/govuk-frontend/govuk/components/button/_button.scss
419
+ - node_modules/govuk-frontend/govuk/components/button/_index.scss
469
420
  - node_modules/govuk-frontend/govuk/components/button/button.js
470
421
  - node_modules/govuk-frontend/govuk/components/character-count/_character-count.scss
422
+ - node_modules/govuk-frontend/govuk/components/character-count/_index.scss
471
423
  - node_modules/govuk-frontend/govuk/components/character-count/character-count.js
472
424
  - node_modules/govuk-frontend/govuk/components/checkboxes/_checkboxes.scss
425
+ - node_modules/govuk-frontend/govuk/components/checkboxes/_index.scss
473
426
  - node_modules/govuk-frontend/govuk/components/checkboxes/checkboxes.js
427
+ - node_modules/govuk-frontend/govuk/components/cookie-banner/_cookie-banner.scss
428
+ - node_modules/govuk-frontend/govuk/components/cookie-banner/_index.scss
474
429
  - node_modules/govuk-frontend/govuk/components/date-input/_date-input.scss
430
+ - node_modules/govuk-frontend/govuk/components/date-input/_index.scss
475
431
  - node_modules/govuk-frontend/govuk/components/details/_details.scss
432
+ - node_modules/govuk-frontend/govuk/components/details/_index.scss
476
433
  - node_modules/govuk-frontend/govuk/components/details/details.js
477
434
  - node_modules/govuk-frontend/govuk/components/error-message/_error-message.scss
435
+ - node_modules/govuk-frontend/govuk/components/error-message/_index.scss
478
436
  - node_modules/govuk-frontend/govuk/components/error-summary/_error-summary.scss
437
+ - node_modules/govuk-frontend/govuk/components/error-summary/_index.scss
479
438
  - node_modules/govuk-frontend/govuk/components/error-summary/error-summary.js
480
439
  - node_modules/govuk-frontend/govuk/components/fieldset/_fieldset.scss
440
+ - node_modules/govuk-frontend/govuk/components/fieldset/_index.scss
481
441
  - node_modules/govuk-frontend/govuk/components/file-upload/_file-upload.scss
442
+ - node_modules/govuk-frontend/govuk/components/file-upload/_index.scss
482
443
  - node_modules/govuk-frontend/govuk/components/footer/_footer.scss
444
+ - node_modules/govuk-frontend/govuk/components/footer/_index.scss
483
445
  - node_modules/govuk-frontend/govuk/components/header/_header.scss
446
+ - node_modules/govuk-frontend/govuk/components/header/_index.scss
484
447
  - node_modules/govuk-frontend/govuk/components/header/header.js
485
448
  - node_modules/govuk-frontend/govuk/components/hint/_hint.scss
449
+ - node_modules/govuk-frontend/govuk/components/hint/_index.scss
450
+ - node_modules/govuk-frontend/govuk/components/input/_index.scss
486
451
  - node_modules/govuk-frontend/govuk/components/input/_input.scss
452
+ - node_modules/govuk-frontend/govuk/components/inset-text/_index.scss
487
453
  - node_modules/govuk-frontend/govuk/components/inset-text/_inset-text.scss
454
+ - node_modules/govuk-frontend/govuk/components/label/_index.scss
488
455
  - node_modules/govuk-frontend/govuk/components/label/_label.scss
456
+ - node_modules/govuk-frontend/govuk/components/notification-banner/_index.scss
457
+ - node_modules/govuk-frontend/govuk/components/notification-banner/_notification-banner.scss
458
+ - node_modules/govuk-frontend/govuk/components/notification-banner/notification-banner.js
459
+ - node_modules/govuk-frontend/govuk/components/panel/_index.scss
489
460
  - node_modules/govuk-frontend/govuk/components/panel/_panel.scss
461
+ - node_modules/govuk-frontend/govuk/components/phase-banner/_index.scss
490
462
  - node_modules/govuk-frontend/govuk/components/phase-banner/_phase-banner.scss
463
+ - node_modules/govuk-frontend/govuk/components/radios/_index.scss
491
464
  - node_modules/govuk-frontend/govuk/components/radios/_radios.scss
492
465
  - node_modules/govuk-frontend/govuk/components/radios/radios.js
466
+ - node_modules/govuk-frontend/govuk/components/select/_index.scss
493
467
  - node_modules/govuk-frontend/govuk/components/select/_select.scss
468
+ - node_modules/govuk-frontend/govuk/components/skip-link/_index.scss
494
469
  - node_modules/govuk-frontend/govuk/components/skip-link/_skip-link.scss
470
+ - node_modules/govuk-frontend/govuk/components/summary-list/_index.scss
495
471
  - node_modules/govuk-frontend/govuk/components/summary-list/_summary-list.scss
472
+ - node_modules/govuk-frontend/govuk/components/table/_index.scss
496
473
  - node_modules/govuk-frontend/govuk/components/table/_table.scss
474
+ - node_modules/govuk-frontend/govuk/components/tabs/_index.scss
497
475
  - node_modules/govuk-frontend/govuk/components/tabs/_tabs.scss
498
476
  - node_modules/govuk-frontend/govuk/components/tabs/tabs.js
477
+ - node_modules/govuk-frontend/govuk/components/tag/_index.scss
499
478
  - node_modules/govuk-frontend/govuk/components/tag/_tag.scss
479
+ - node_modules/govuk-frontend/govuk/components/textarea/_index.scss
500
480
  - node_modules/govuk-frontend/govuk/components/textarea/_textarea.scss
481
+ - node_modules/govuk-frontend/govuk/components/warning-text/_index.scss
501
482
  - node_modules/govuk-frontend/govuk/components/warning-text/_warning-text.scss
502
483
  - node_modules/govuk-frontend/govuk/core/_all.scss
503
484
  - node_modules/govuk-frontend/govuk/core/_global-styles.scss
@@ -520,6 +501,7 @@ files:
520
501
  - node_modules/govuk-frontend/govuk/helpers/_typography.scss
521
502
  - node_modules/govuk-frontend/govuk/helpers/_visually-hidden.scss
522
503
  - node_modules/govuk-frontend/govuk/objects/_all.scss
504
+ - node_modules/govuk-frontend/govuk/objects/_button-group.scss
523
505
  - node_modules/govuk-frontend/govuk/objects/_form-group.scss
524
506
  - node_modules/govuk-frontend/govuk/objects/_grid.scss
525
507
  - node_modules/govuk-frontend/govuk/objects/_main-wrapper.scss
@@ -537,6 +519,7 @@ files:
537
519
  - node_modules/govuk-frontend/govuk/settings/_compatibility.scss
538
520
  - node_modules/govuk-frontend/govuk/settings/_global-styles.scss
539
521
  - node_modules/govuk-frontend/govuk/settings/_ie8.scss
522
+ - node_modules/govuk-frontend/govuk/settings/_links.scss
540
523
  - node_modules/govuk-frontend/govuk/settings/_measurements.scss
541
524
  - node_modules/govuk-frontend/govuk/settings/_media-queries.scss
542
525
  - node_modules/govuk-frontend/govuk/settings/_spacing.scss