jekyll-cessda-docs 0.1.3 → 0.1.4.pre.ae3a878974c7d7040fd725d0640cd8f111d896ac

Sign up to get free protection for your applications and to get access to all the features.
Files changed (13) hide show
  1. checksums.yaml +4 -4
  2. data/{LICENSE.txt → LICENSE} +6 -6
  3. data/README.md +23 -17
  4. data/_config.yml +4 -2
  5. data/_includes/glossary.html +27 -0
  6. data/_includes/glossary_table.html +16 -0
  7. data/_includes/head.html +18 -2
  8. data/_layouts/default.html +1 -1
  9. data/_sass/cessda.scss +92 -92
  10. data/_sass/color_schemes/cessda.scss +1 -0
  11. data/_sass/custom/custom.scss +92 -92
  12. data/_sass/support/_variables.scss +2 -2
  13. metadata +23 -7
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 7f61bdfe1bb6604b17b512e3d0f26b0992093b5a2af54c1572f38609fd97dc84
4
- data.tar.gz: 6f45efe9deb89cf23d6c980e302e4062299a924eb4f7d61b2e652f0bee1f7972
3
+ metadata.gz: 59a98ce732c112829ce2365faa19fafd69f72094ab2d9434136160149e4f7472
4
+ data.tar.gz: 62880bcd379221d118d0db397b544d04dd4b8e2c1a7c548e367219e0eb07a3d0
5
5
  SHA512:
6
- metadata.gz: cceeb7c7c9893668beeabd277ec5aca15619639a4f06d7919c0e7dabc808b1b3143d3812e15210492f72ee8976e4cbb3cb7a67d67a88b36d77293cd8b723185a
7
- data.tar.gz: ab263be7f259bff1bda316e9f5c8503dba231a7271b850fea11d4bd2abdfbd81e0e3e71f35c6c75818d64503c7b1a170ec33e50868103e9c75cf7ded2a578381
6
+ metadata.gz: be22003ffe5ff819604d61e341b915bd0e3781c72a8269c83dc1b0719276e596aca76ef61e505a611ecc2f359ea79b38e5c2b1938ef3d27e917f94566c8d8afe
7
+ data.tar.gz: 8367487ae866aeeab945e2399ff58a6907d7b8c0e203acf9c6c92c14ff3f8c378643bdfaf7e1d388b8ddcb06225988723d7fc06e10adb1743e84c3e5b4c44b75
data/{LICENSE.txt → LICENSE} RENAMED
@@ -1,6 +1,6 @@
1
- The MIT License (MIT)
1
+ MIT License
2
2
 
3
- Copyright (c) 2020 openconcept
3
+ Copyright (c) 2020 CESSDA ERIC
4
4
 
5
5
  Permission is hereby granted, free of charge, to any person obtaining a copy
6
6
  of this software and associated documentation files (the "Software"), to deal
@@ -9,13 +9,13 @@ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
9
  copies of the Software, and to permit persons to whom the Software is
10
10
  furnished to do so, subject to the following conditions:
11
11
 
12
- The above copyright notice and this permission notice shall be included in
13
- all copies or substantial portions of the Software.
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
14
 
15
15
  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
16
  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
17
  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
18
  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
19
  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
- OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21
- THE SOFTWARE.
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
data/README.md CHANGED
@@ -1,13 +1,25 @@
1
1
  # jekyll-cessda-docs
2
2
 
3
- Welcome to your new Jekyll theme! In this directory, you'll find the files you need to be able to package up your theme into a gem. Put your layouts in `_layouts`, your includes in `_includes`, your sass files in `_sass` and any other assets in `assets`.
3
+ CESSDA theme for just-the-docs. These are the source files for building the gem.
4
4
 
5
- To experiment with this code, add some sample content and run `bundle exec jekyll serve` – this directory is setup just like a Jekyll site!
5
+ ## Building and pushing
6
6
 
7
- TODO: Delete this and the text above, and describe your gem
7
+ 1. set up git and RubyGems user. Instructions here: <https://jekyllrb.com/docs/themes/#publishing-your-theme>
8
+ 2. Update the file `jekyll-cessda-docs.gemspec` with the new version number, for example:
9
+ spec.version = "0.1.4"
10
+ 3. Build the gem:
8
11
 
12
+ ```sh
13
+ gem build jekyll-cessda-docs.gemspec
14
+ ```
9
15
 
10
- ## Installation
16
+ 4. Push to Rubygems.org:
17
+
18
+ ```sh
19
+ gem push jekyll-cessda-docs-*.gem
20
+ ```
21
+
22
+ ## Installing
11
23
 
12
24
  Add this line to your Jekyll site's `Gemfile`:
13
25
 
@@ -23,19 +35,15 @@ theme: jekyll-cessda-docs
23
35
 
24
36
  And then execute:
25
37
 
26
- $ bundle
38
+ ```sh
39
+ bundle
40
+ ```
27
41
 
28
42
  Or install it yourself as:
29
43
 
30
- $ gem install jekyll-cessda-docs
31
-
32
- ## Usage
33
-
34
- TODO: Write usage instructions here. Describe your available layouts, includes, sass and/or assets.
35
-
36
- ## Contributing
37
-
38
- Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/hello. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
44
+ ```sh
45
+ gem install jekyll-cessda-docs
46
+ ```
39
47
 
40
48
  ## Development
41
49
 
@@ -43,10 +51,8 @@ To set up your environment to develop this theme, run `bundle install`.
43
51
 
44
52
  Your theme is setup just like a normal Jekyll site! To test your theme, run `bundle exec jekyll serve` and open your browser at `http://localhost:4000`. This starts a Jekyll server using your theme. Add pages, documents, data, etc. like normal to test your theme's contents. As you make modifications to your theme and to your content, your site will regenerate and you should see the changes in the browser after a refresh, just like normal.
45
53
 
46
- When your theme is released, only the files in `_layouts`, `_includes`, `_sass` and `assets` tracked with Git will be bundled.
47
- To add a custom directory to your theme-gem, please edit the regexp in `jekyll-cessda-docs.gemspec` accordingly.
54
+ When your theme is released, only the files in `_layouts`, `_includes`, `_sass` and `assets` tracked with Git will be bundled. To add a custom directory to your theme-gem, please edit the regexp in `jekyll-cessda-docs.gemspec` accordingly.
48
55
 
49
56
  ## License
50
57
 
51
58
  The theme is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
52
-
data/_config.yml CHANGED
@@ -4,13 +4,15 @@
4
4
  title: CESSDA Technical Guidelines
5
5
  baseurl: /
6
6
  logo: assets/CESSDA.png
7
- color_scheme: cessda
7
+ color_scheme: light
8
8
 
9
9
  # Theme
10
10
  #theme: just-the-docs
11
- theme: jekyll-cessda-docs
12
11
  search_enabled: true
13
12
 
13
+ plugins:
14
+ - jekyll-seo-tag
15
+
14
16
  defaults:
15
17
  -
16
18
  scope:
data/_includes/glossary.html ADDED
@@ -0,0 +1,27 @@
1
+ {%- comment -%}
2
+ This file adds a link to the glossary page with optional mouseover,
3
+ if an expansion of the abbreviation can be found in data/glossary.yml.
4
+ Note the excessive use of whitespace hiding!
5
+ {%- endcomment -%}
6
+ {%- unless include.text -%}
7
+ {%- assign display_string = include.entry -%}
8
+ {%- else -%}
9
+ {%- assign display_string = include.text -%}
10
+ {%- endunless %}
11
+ {%- assign mouseover = "" -%}
12
+ {%- for gl_entry in site.data.glossary -%}
13
+ {%- if gl_entry.entry == include.entry -%}
14
+ {%- capture mouseover %}{{ gl_entry.title }} -- {{ gl_entry.description }}{% endcapture -%}
15
+ {%- endif -%}
16
+ {%- endfor -%}
17
+ {%- comment -%}
18
+ If we don't have matching abbriviation, try the full title!
19
+ {%- endcomment -%}
20
+ {%- if mouseover == "" -%}
21
+ {%- for gl_entry in site.data.glossary -%}
22
+ {%- if gl_entry.title == include.entry -%}
23
+ {%- capture mouseover %}{{ gl_entry.description }}{% endcapture -%}
24
+ {%- endif -%}
25
+ {%- endfor -%}
26
+ {% endif -%}
27
+ <span class="glossary_entry" title="{{ mouseover }}">[{{ display_string }}]({% link glossary.md %})</span>{{- -}}
data/_includes/glossary_table.html ADDED
@@ -0,0 +1,16 @@
1
+ <table summary="CESSDA Glossary">
2
+ <thead>
3
+ <tr>
4
+ <th scope="col">Acronym</th>
5
+ <th scope="col">Expansion</th>
6
+ <th scope="col">Description</th>
7
+ </tr>
8
+ </thead>
9
+ <tbody>
10
+ {% for row in site.data.glossary %}
11
+ {% tablerow pair in row %}
12
+ {{ pair[1] }}
13
+ {% endtablerow %}
14
+ {% endfor %}
15
+ </tbody>
16
+ </table>
data/_includes/head.html CHANGED
@@ -33,8 +33,24 @@
33
33
 
34
34
  <meta name="viewport" content="width=device-width, initial-scale=1">
35
35
 
36
-
36
+ {% seo %}
37
37
 
38
38
  {% include head_custom.html %}
39
-
39
+ {% if site.matomo != false %}
40
+ <!-- Matomo -->
41
+ <script type="text/javascript">
42
+ var _paq = window._paq = window._paq || [];
43
+ /* tracker methods like "setCustomDimension" should be called before "trackPageView" */
44
+ _paq.push(['trackPageView']);
45
+ _paq.push(['enableLinkTracking']);
46
+ (function() {
47
+ var u="//analytics.cessda.eu/";
48
+ _paq.push(['setTrackerUrl', u+'matomo.php']);
49
+ _paq.push(['setSiteId', '5']);
50
+ var d=document, g=d.createElement('script'), s=d.getElementsByTagName('script')[0];
51
+ g.type='text/javascript'; g.async=true; g.src=u+'matomo.js'; s.parentNode.insertBefore(g,s);
52
+ })();
53
+ </script>
54
+ <!-- End Matomo Code -->
55
+ {% endif %}
40
56
  </head>
data/_layouts/default.html CHANGED
@@ -41,7 +41,7 @@ layout: table_wrappers
41
41
  </svg>
42
42
  <div class="bg-grey-dk-200 topcont">
43
43
  <div class="topbar">
44
- <a href="https://www.cessda.eu">Consortium of Social Science Data Archives</a>
44
+ <a href="https://www.cessda.eu">Consortium of European Social Science Data Archives</a>
45
45
  </div>
46
46
  </div>
47
47
  <div class="maincont">
data/_sass/cessda.scss CHANGED
@@ -1,93 +1,93 @@
1
-
2
- a {
3
- transition: all 0.3s;
4
- }
5
- .topcont {
6
- height: 30px;
7
- width:100%;
8
- z-index:3;
9
- position:fixed;
10
- top:0;
11
- left:0;
12
-
13
- }
14
- .topbar {
15
-
16
- max-width:1080px;
17
- margin: 0 auto;
18
- height:30px;
19
- }
20
-
21
-
22
- .topbar a {
23
- color: white;
24
- text-decoration:none;
25
- display:inline-block;
26
- line-height:30px;
27
- padding:0 10px;
28
- font-size: 14px;
29
- background-image: none;
30
- }
31
-
32
- .topbar a:hover {
33
- background-color:rgba(255,255,255,0.1);
34
- }
35
-
36
- .main-header {
37
-
38
- margin-top:30px;
39
- }
40
-
41
-
42
-
43
- .site-footer {
44
-
45
- z-index:4;
46
- position: fixed;
47
- display:block;
48
- bottom:0px;
49
- height:40px;
50
- width:100%;
51
- }
52
- #footerlogo {
53
- height: 24px;
54
- width:auto;
55
- margin: 8px 20px 0 10px;
56
- display:block;
57
- position:absolute;
58
- left:0;
59
- top:2px;
60
- }
61
-
62
- .bottombar {
63
-
64
- max-width:1080px;
65
- margin: 0 auto;
66
- height:40px;
67
- position:relative;
68
- text-align:center;
69
- }
70
-
71
- .site-footer a {
72
- display:inline-block;
73
- color:white;
74
- padding:0 10px;
75
- font-size:14px;
76
- background:transparent;
77
- line-height:40px;
78
- height:40px;
79
- margin:0;
80
- }
81
- .nav-list-top {
82
- margin-bottom:50px;
83
-
84
- }
85
-
86
- @media only screen and (max-width: 711px) {
87
- .site-header {
88
- padding-top:30px;
89
- }
90
- #footerlogo {
91
- display:none;
92
- }
1
+
2
+ a {
3
+ transition: all 0.3s;
4
+ }
5
+ .topcont {
6
+ height: 30px;
7
+ width:100%;
8
+ z-index:3;
9
+ position:fixed;
10
+ top:0;
11
+ left:0;
12
+
13
+ }
14
+ .topbar {
15
+
16
+ max-width:1080px;
17
+ margin: 0 auto;
18
+ height:30px;
19
+ }
20
+
21
+
22
+ .topbar a {
23
+ color: white;
24
+ text-decoration:none;
25
+ display:inline-block;
26
+ line-height:30px;
27
+ padding:0 10px;
28
+ font-size: 14px;
29
+ background-image: none;
30
+ }
31
+
32
+ .topbar a:hover {
33
+ background-color:rgba(255,255,255,0.1);
34
+ }
35
+
36
+ .main-header {
37
+
38
+ margin-top:30px;
39
+ }
40
+
41
+
42
+
43
+ .site-footer {
44
+
45
+ z-index:4;
46
+ position: fixed;
47
+ display:block;
48
+ bottom:0px;
49
+ height:40px;
50
+ width:100%;
51
+ }
52
+ #footerlogo {
53
+ height: 24px;
54
+ width:auto;
55
+ margin: 8px 20px 0 10px;
56
+ display:block;
57
+ position:absolute;
58
+ left:0;
59
+ top:2px;
60
+ }
61
+
62
+ .bottombar {
63
+
64
+ max-width:1080px;
65
+ margin: 0 auto;
66
+ height:40px;
67
+ position:relative;
68
+ text-align:center;
69
+ }
70
+
71
+ .site-footer a {
72
+ display:inline-block;
73
+ color:white;
74
+ padding:0 10px;
75
+ font-size:14px;
76
+ background:transparent;
77
+ line-height:40px;
78
+ height:40px;
79
+ margin:0;
80
+ }
81
+ .nav-list-top {
82
+ margin-bottom:50px;
83
+
84
+ }
85
+
86
+ @media only screen and (max-width: 711px) {
87
+ .site-header {
88
+ padding-top:30px;
89
+ }
90
+ #footerlogo {
91
+ display:none;
92
+ }
93
93
  }
data/_sass/color_schemes/cessda.scss ADDED
@@ -0,0 +1 @@
1
+ $link-color: #2B5A9B;
data/_sass/custom/custom.scss CHANGED
@@ -1,93 +1,93 @@
1
-
2
- a {
3
- transition: all 0.3s;
4
- }
5
- .topcont {
6
- height: 30px;
7
- width:100%;
8
- z-index:3;
9
- position:fixed;
10
- top:0;
11
- left:0;
12
-
13
- }
14
- .topbar {
15
-
16
- max-width:1080px;
17
- margin: 0 auto;
18
- height:30px;
19
- }
20
-
21
-
22
- .topbar a {
23
- color: white;
24
- text-decoration:none;
25
- display:inline-block;
26
- line-height:30px;
27
- padding:0 10px;
28
- font-size: 14px;
29
- background-image: none;
30
- }
31
-
32
- .topbar a:hover {
33
- background-color:rgba(255,255,255,0.1);
34
- }
35
-
36
- .main-header {
37
-
38
- margin-top:30px;
39
- }
40
-
41
-
42
-
43
- .site-footer {
44
-
45
- z-index:4;
46
- position: fixed;
47
- display:block;
48
- bottom:0px;
49
- height:40px;
50
- width:100%;
51
- }
52
- #footerlogo {
53
- height: 24px;
54
- width:auto;
55
- margin: 8px 20px 0 10px;
56
- display:block;
57
- position:absolute;
58
- left:0;
59
- top:2px;
60
- }
61
-
62
- .bottombar {
63
-
64
- max-width:1080px;
65
- margin: 0 auto;
66
- height:40px;
67
- position:relative;
68
- text-align:center;
69
- }
70
-
71
- .site-footer a {
72
- display:inline-block;
73
- color:white;
74
- padding:0 10px;
75
- font-size:14px;
76
- background:transparent;
77
- line-height:40px;
78
- height:40px;
79
- margin:0;
80
- }
81
- .nav-list-top {
82
- margin-bottom:90px;
83
-
84
- }
85
-
86
- @media only screen and (max-width: 711px) {
87
- .site-header {
88
- padding-top:30px;
89
- }
90
- #footerlogo {
91
- display:none;
92
- }
1
+
2
+ a {
3
+ transition: all 0.3s;
4
+ }
5
+ .topcont {
6
+ height: 30px;
7
+ width:100%;
8
+ z-index:3;
9
+ position:fixed;
10
+ top:0;
11
+ left:0;
12
+
13
+ }
14
+ .topbar {
15
+
16
+ max-width:1080px;
17
+ margin: 0 auto;
18
+ height:30px;
19
+ }
20
+
21
+
22
+ .topbar a {
23
+ color: white;
24
+ text-decoration:none;
25
+ display:inline-block;
26
+ line-height:30px;
27
+ padding:0 10px;
28
+ font-size: 14px;
29
+ background-image: none;
30
+ }
31
+
32
+ .topbar a:hover {
33
+ background-color:rgba(255,255,255,0.1);
34
+ }
35
+
36
+ .main-header {
37
+
38
+ margin-top:30px;
39
+ }
40
+
41
+
42
+
43
+ .site-footer {
44
+
45
+ z-index:4;
46
+ position: fixed;
47
+ display:block;
48
+ bottom:0px;
49
+ height:40px;
50
+ width:100%;
51
+ }
52
+ #footerlogo {
53
+ height: 24px;
54
+ width:auto;
55
+ margin: 8px 20px 0 10px;
56
+ display:block;
57
+ position:absolute;
58
+ left:0;
59
+ top:2px;
60
+ }
61
+
62
+ .bottombar {
63
+
64
+ max-width:1080px;
65
+ margin: 0 auto;
66
+ height:40px;
67
+ position:relative;
68
+ text-align:center;
69
+ }
70
+
71
+ .site-footer a {
72
+ display:inline-block;
73
+ color:white;
74
+ padding:0 10px;
75
+ font-size:14px;
76
+ background:transparent;
77
+ line-height:40px;
78
+ height:40px;
79
+ margin:0;
80
+ }
81
+ .nav-list-top {
82
+ margin-bottom:90px;
83
+
84
+ }
85
+
86
+ @media only screen and (max-width: 711px) {
87
+ .site-header {
88
+ padding-top:30px;
89
+ }
90
+ #footerlogo {
91
+ display:none;
92
+ }
93
93
  }
data/_sass/support/_variables.scss CHANGED
@@ -51,7 +51,7 @@ $purple-300: #381885 !default;
51
51
 
52
52
  $blue-000: #2c84fa !default;
53
53
  $blue-100: #2869e6 !default;
54
- $blue-200: #264caf !default;
54
+ $blue-200: #2B5A9B !default;
55
55
  $blue-300: #2b5a9b !default;
56
56
 
57
57
  $green-000: #41d693 !default;
@@ -80,7 +80,7 @@ $body-text-color: $grey-dk-100 !default;
80
80
  $body-heading-color: $grey-dk-300 !default;
81
81
  $search-result-preview-color: $grey-dk-000 !default;
82
82
  $nav-child-link-color: $grey-dk-100 !default;
83
- $link-color: $purple-000 !default;
83
+ $link-color: $blue-200 !default;
84
84
  $btn-primary-color: $blue-300 !default;
85
85
  $base-button-color: #f7f7f7 !default;
86
86
 
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: jekyll-cessda-docs
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.1.3
4
+ version: 0.1.4.pre.ae3a878974c7d7040fd725d0640cd8f111d896ac
5
5
  platform: ruby
6
6
  authors:
7
7
  - openconcept
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2020-10-21 00:00:00.000000000 Z
11
+ date: 2020-11-27 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: jekyll
@@ -24,6 +24,20 @@ dependencies:
24
24
  - - "~>"
25
25
  - !ruby/object:Gem::Version
26
26
  version: '4.1'
27
+ - !ruby/object:Gem::Dependency
28
+ name: jekyll-seo-tag
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: '2.6'
34
+ type: :runtime
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: '2.6'
27
41
  description:
28
42
  email:
29
43
  - post@openconcept.no
@@ -31,12 +45,14 @@ executables: []
31
45
  extensions: []
32
46
  extra_rdoc_files: []
33
47
  files:
34
- - LICENSE.txt
48
+ - LICENSE
35
49
  - README.md
36
50
  - _config.yml
37
51
  - _includes/css/custom.scss.liquid
38
52
  - _includes/css/just-the-docs.scss.liquid
39
53
  - _includes/fix_linenos.html
54
+ - _includes/glossary.html
55
+ - _includes/glossary_table.html
40
56
  - _includes/head.html
41
57
  - _includes/head_custom.html
42
58
  - _includes/js/custom.js
@@ -54,6 +70,7 @@ files:
54
70
  - _sass/buttons.scss
55
71
  - _sass/cessda.scss
56
72
  - _sass/code.scss
73
+ - _sass/color_schemes/cessda.scss
57
74
  - _sass/color_schemes/dark.scss
58
75
  - _sass/color_schemes/light.scss
59
76
  - _sass/content.scss
@@ -106,12 +123,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
106
123
  version: '0'
107
124
  required_rubygems_version: !ruby/object:Gem::Requirement
108
125
  requirements:
109
- - - ">="
126
+ - - ">"
110
127
  - !ruby/object:Gem::Version
111
- version: '0'
128
+ version: 1.3.1
112
129
  requirements: []
113
- rubyforge_project:
114
- rubygems_version: 2.7.6.2
130
+ rubygems_version: 3.1.4
115
131
  signing_key:
116
132
  specification_version: 4
117
133
  summary: Chrome for CESSDA tech docs