jekyll-cessda-docs 0.1.4 → 0.1.5.pre.c8c720a2d5d981d7a0c823c57e579379f502d827

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 89d310ea1a2f0725be92024bd06a32aa2e3b12d9370cd6c3890c3c400d0bb67c
4
- data.tar.gz: 3c251ba8dfc9cb99df09c09e0addda6353001a527301fdca54cc08451decf594
3
+ metadata.gz: 8d62b54ab677f2117302a6cf97508de83a4886f65d778aafdf0b578ebecdf817
4
+ data.tar.gz: 985fcbb63fe266c946aed886158bc08755832d98b4d0792bc6f82584836f4c41
5
5
  SHA512:
6
- metadata.gz: 6fe818f21c5f33aab2cdb4da125496984f43e6baf4916e99ab0c3a8f0083b51a57f77884e9fc2fb93678869727714a10c221ca6b62bc2cd75cb22fd0c5574846
7
- data.tar.gz: 5e7b3c39449f6c5c910862a5926687a6b1206975f146da75afacd8c4628eff0cdd887d10ee4cd7a0d7bf056a76fab9feee01c85d1d40b7227d9a0a8afbc8e641
6
+ metadata.gz: c17f4375c2b3a827bfb0d90ad2350f0e54f9a301faa7a4ebe3f62b256199ceaad8ef922dd327447b3898191654ac2829d3ae6084356748c2d265c235aa0a1be7
7
+ data.tar.gz: e5a6510258ecb7ba8942ac7fc93196399d89c3f1b60a7b0195429d86efd13afdd6bf06d34fae5f250dfe95b13c6ac8aac8027c56f5e4ccb23093c53c65d894ac
@@ -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,17 @@ 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
44
+ ```sh
45
+ gem install jekyll-cessda-docs
46
+ ```
37
47
 
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.
48
+ See the [CESSDA documentation](https://docs.tech.cessda.eu/platform/documentation_tooling.html) for more details.
39
49
 
40
50
  ## Development
41
51
 
@@ -43,10 +53,8 @@ To set up your environment to develop this theme, run `bundle install`.
43
53
 
44
54
  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
55
 
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.
56
+ 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
57
 
49
58
  ## License
50
59
 
51
60
  The theme is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
52
-
@@ -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>{{- -}}
@@ -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>
@@ -26,7 +26,7 @@
26
26
 
27
27
  {% endif %}
28
28
 
29
- {% if site.search_enabled != false %}
29
+ {% if site.search_enabled == true %}
30
30
  <script type="text/javascript" src="{{ '/assets/js/vendor/lunr.min.js' | relative_url }}"></script>
31
31
  {% endif %}
32
32
  <script type="text/javascript" src="{{ '/assets/js/just-the-docs.js' | relative_url }}"></script>
@@ -36,7 +36,7 @@
36
36
  {% seo %}
37
37
 
38
38
  {% include head_custom.html %}
39
- {% if site.matomo != false %}
39
+ {% if site.matomo_siteid and site.matomo_siteid != "" and site.matomo_siteid != nil %}
40
40
  <!-- Matomo -->
41
41
  <script type="text/javascript">
42
42
  var _paq = window._paq = window._paq || [];
@@ -46,7 +46,7 @@
46
46
  (function() {
47
47
  var u="//analytics.cessda.eu/";
48
48
  _paq.push(['setTrackerUrl', u+'matomo.php']);
49
- _paq.push(['setSiteId', '5']);
49
+ _paq.push(['setSiteId', '{{ site.matomo_siteid }}']);
50
50
  var d=document, g=d.createElement('script'), s=d.getElementsByTagName('script')[0];
51
51
  g.type='text/javascript'; g.async=true; g.src=u+'matomo.js'; s.parentNode.insertBefore(g,s);
52
52
  })();
@@ -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
  }
@@ -0,0 +1 @@
1
+ $link-color: #2B5A9B;
@@ -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
  }
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.4
4
+ version: 0.1.5.pre.c8c720a2d5d981d7a0c823c57e579379f502d827
5
5
  platform: ruby
6
6
  authors:
7
7
  - openconcept
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2020-11-25 00:00:00.000000000 Z
11
+ date: 2020-11-30 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: jekyll
@@ -45,12 +45,14 @@ executables: []
45
45
  extensions: []
46
46
  extra_rdoc_files: []
47
47
  files:
48
- - LICENSE.txt
48
+ - LICENSE
49
49
  - README.md
50
50
  - _config.yml
51
51
  - _includes/css/custom.scss.liquid
52
52
  - _includes/css/just-the-docs.scss.liquid
53
53
  - _includes/fix_linenos.html
54
+ - _includes/glossary.html
55
+ - _includes/glossary_table.html
54
56
  - _includes/head.html
55
57
  - _includes/head_custom.html
56
58
  - _includes/js/custom.js
@@ -68,6 +70,7 @@ files:
68
70
  - _sass/buttons.scss
69
71
  - _sass/cessda.scss
70
72
  - _sass/code.scss
73
+ - _sass/color_schemes/cessda.scss
71
74
  - _sass/color_schemes/dark.scss
72
75
  - _sass/color_schemes/light.scss
73
76
  - _sass/content.scss
@@ -108,7 +111,8 @@ files:
108
111
  homepage: https://cessda.eu
109
112
  licenses:
110
113
  - MIT
111
- metadata: {}
114
+ metadata:
115
+ documentation_uri: https://docs.tech.cessda.eu/platform/documentation_tooling.html
112
116
  post_install_message:
113
117
  rdoc_options: []
114
118
  require_paths:
@@ -120,12 +124,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
120
124
  version: '0'
121
125
  required_rubygems_version: !ruby/object:Gem::Requirement
122
126
  requirements:
123
- - - ">="
127
+ - - ">"
124
128
  - !ruby/object:Gem::Version
125
- version: '0'
129
+ version: 1.3.1
126
130
  requirements: []
127
131
  rubygems_version: 3.1.4
128
132
  signing_key:
129
133
  specification_version: 4
130
- summary: Chrome for CESSDA tech docs
134
+ summary: Jekyll theme for CESSDA documentation sites
131
135
  test_files: []