uswds-jekyll 5.0.0 → 5.0.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (4) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +19 -10
  3. data/_includes/analytics.html +1 -1
  4. metadata +6 -6
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: e5e338726e8357ad03b9947d7ddd0b977b5658671627d2f068fe6a05cb22002f
4
- data.tar.gz: 42f04fbefa5c026573c1190baecbbb79065917375f9f8e41ad8aab3377b0430b
3
+ metadata.gz: 552f833b8c33993f2f5b0c670b2e29e375b3ab4f9484154ca4487bfb3c907160
4
+ data.tar.gz: 357f8e3b7448a757997279b3bae773b372d2413977f0f4cfbd4e19f27bd7d9c0
5
5
  SHA512:
6
- metadata.gz: 33fa5198894809d8031f7c1fa9923502c124f930e32463fdb8d7330b6ac18d0211aa42620be8b2b27c288135c05fc376f8a90eac379a6509c5f7621b0ae2c88d
7
- data.tar.gz: f826137b0b11b0c427866588c610e0ff35462363d3e255cdcffeb128faf183124935bdf309413978092dc888ab547cb93e3b2d7a85b85a9c47667e233f6a23ea
6
+ metadata.gz: a88852b3c1997c9660e55dc3dfb1b436facc3526ea4adca8a58fc06d20bd6b11a36847d3c39a798cc625286a8ec7a3a784f4021f68e02e2053a60a3e29a2e7bd
7
+ data.tar.gz: e4d77d84905057cd33a187f8f5a05eee25c1f1112ee3cc4941b8aff33b01980a600a83e9a6e9ae7b69045ccc0ebe51acbf154380c7db77f0b05d5939252f0be1
data/README.md CHANGED
@@ -38,7 +38,7 @@ This is a [Jekyll theme](https://jekyllrb.com/docs/themes/) for the
38
38
  - [Post](#layout-post)
39
39
  - [Project](#layout-project)
40
40
  - [Team member](#layout-team-member)
41
- 1. [Migrating from earlier versions](#migrating-from-earlier-versions)
41
+ 1. [Migration guide](#migration)
42
42
  1. [Development](#development)
43
43
 
44
44
  ## Installation
@@ -47,7 +47,7 @@ This is a [Jekyll theme](https://jekyllrb.com/docs/themes/) for the
47
47
  like so:
48
48
 
49
49
  ```ruby
50
- gem 'uswds-jekyll', :git => 'https://github.com/18F/uswds-jekyll.git', :branch => 'update-uswds-2.0'
50
+ gem 'uswds-jekyll'
51
51
  ```
52
52
 
53
53
  1. Fetch and update your bundled gems by running:
@@ -74,7 +74,7 @@ You will need to restart your Jekyll server to see the effects.
74
74
  1. Replace the default `gem "minima", "~> 2.0"` gem with the `uswds-jekyll` gem in your `Gemfile`:
75
75
 
76
76
  ```ruby
77
- gem 'uswds-jekyll', :git => 'https://github.com/18F/uswds-jekyll.git', :branch => 'update-uswds-2.0'
77
+ gem 'uswds-jekyll'
78
78
  ```
79
79
 
80
80
  1. Set the `theme` in your site's Jekyll configuration,
@@ -101,7 +101,7 @@ To reference a specific version of this theme:
101
101
  1. Specify the version in your `Gemfile`.
102
102
 
103
103
  ```ruby
104
- gem 'uswds-jekyll', '5.0.0'
104
+ gem 'uswds-jekyll', '~> 5.0'
105
105
  ```
106
106
 
107
107
  ## Configuration
@@ -286,11 +286,14 @@ You can add Google Analytics to your site by uncommenting the `google_analytics_
286
286
 
287
287
  #### Digital Analytics Program (DAP)
288
288
 
289
- You can add DAP to your site by uncommenting the `dap_agency` line and, if need be, replacing `GSA` with the appropriate agency key. For more information visit <https://www.digitalgov.gov/services/dap/>
289
+ You can add DAP to your site by uncommenting the `dap_agency` line and, if need be, replacing `GSA` with the appropriate agency key.
290
+ And optionally, `dap_subagency` may also be specified.
291
+ For more information visit <https://www.digitalgov.gov/services/dap/>
290
292
 
291
293
  ```
292
294
  # Configuration for DAP, add your agency ID here:
293
295
  # dap_agency: GSA
296
+ # dap_subagency: TTS
294
297
  ```
295
298
 
296
299
  ### Last modified date
@@ -535,25 +538,31 @@ To show a listing of team members on a page add `{% include team-list.html %} to
535
538
  [jekyll sass]: https://jekyllrb.com/docs/assets/#sassscss
536
539
  [front matter]: https://jekyllrb.com/docs/frontmatter/
537
540
 
538
- ## Migrating from earlier versions
541
+ ## Migration
539
542
 
540
- **Note:** `uswds-jekyll 5.0.0` is only compatible with Jekyll 4.0 and higher.
543
+ ### From [guides_style_18f](https://github.com/18F/guides-style)
544
+
545
+ See [this example pull request](https://github.com/18F/before-you-ship/pull/458).
546
+
547
+ ### From from earlier versions
548
+
549
+ **Note:** `uswds-jekyll` 5.x is only compatible with Jekyll 4.0 and higher.
541
550
 
542
551
  1. Update your `uswds-jekyll` gem in your project's Gemfile. Replace the current `gem 'uswds-jekyll'` line with:
543
552
 
544
553
  ```ruby
545
- gem 'uswds-jekyll', '5.0.0'
554
+ gem 'uswds-jekyll', '~> 5.0'
546
555
  ```
547
556
 
548
557
  Then, in the terminal, run
549
558
 
550
- ```
559
+ ```sh
551
560
  bundle update uswds-jekyll
552
561
  ```
553
562
 
554
563
  1. Add any custom styles to `/_sass/custom/`
555
564
  1. `_sass` folder needs to be at the root level, not in assets.
556
- 1. Convert manual values to tokenzied values using the guidance on the [USWDS migration page](https://designsystem.digital.gov/documentation/migration/#spacing-units).
565
+ 1. Convert manual values to tokenized values using the guidance on the [USWDS migration page](https://designsystem.digital.gov/documentation/migration/#spacing-units).
557
566
  1. Don't duplicate the `h1` in the body content of `page` template pages. (This is automatically inserted at the top with the content of `page.title`.)
558
567
  1. Check that certain data keys exist
559
568
 
@@ -13,5 +13,5 @@
13
13
 
14
14
  {% if site.dap_agency %}
15
15
  <!-- Digital Analytics Program roll-up, see https://analytics.usa.gov for data -->
16
- <script id="_fed_an_ua_tag" src="https://dap.digitalgov.gov/Universal-Federated-Analytics-Min.js?agency={{ site.dap_agency }}"></script>
16
+ <script id="_fed_an_ua_tag" src="https://dap.digitalgov.gov/Universal-Federated-Analytics-Min.js?agency={{ site.dap_agency }}{% if site.dap_subagency %}&subagency={{ site.dap_subagency }}{% endif %}"></script>
17
17
  {% endif %}
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: uswds-jekyll
3
3
  version: !ruby/object:Gem::Version
4
- version: 5.0.0
4
+ version: 5.0.1
5
5
  platform: ruby
6
6
  authors:
7
7
  - Shawn Allen
@@ -9,10 +9,10 @@ authors:
9
9
  - Brian Hurst
10
10
  - Scott Weber
11
11
  - Dan O. Williams
12
- autorequire:
12
+ autorequire:
13
13
  bindir: bin
14
14
  cert_chain: []
15
- date: 2020-07-28 00:00:00.000000000 Z
15
+ date: 2020-09-15 00:00:00.000000000 Z
16
16
  dependencies:
17
17
  - !ruby/object:Gem::Dependency
18
18
  name: jekyll
@@ -62,7 +62,7 @@ dependencies:
62
62
  - - ">="
63
63
  - !ruby/object:Gem::Version
64
64
  version: '0'
65
- description:
65
+ description:
66
66
  email:
67
67
  - daniel.williams@gsa.gov
68
68
  executables: []
@@ -640,7 +640,7 @@ homepage: https://designsystem.digital.gov/
640
640
  licenses:
641
641
  - CC0-1.0
642
642
  metadata: {}
643
- post_install_message:
643
+ post_install_message:
644
644
  rdoc_options: []
645
645
  require_paths:
646
646
  - lib
@@ -656,7 +656,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
656
656
  version: '0'
657
657
  requirements: []
658
658
  rubygems_version: 3.1.4
659
- signing_key:
659
+ signing_key:
660
660
  specification_version: 4
661
661
  summary: A Jekyll theme for the U.S. Web Design System.
662
662
  test_files: []