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

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7f61bdfe1bb6604b17b512e3d0f26b0992093b5a2af54c1572f38609fd97dc84
-  data.tar.gz: 6f45efe9deb89cf23d6c980e302e4062299a924eb4f7d61b2e652f0bee1f7972
+  metadata.gz: 8d62b54ab677f2117302a6cf97508de83a4886f65d778aafdf0b578ebecdf817
+  data.tar.gz: 985fcbb63fe266c946aed886158bc08755832d98b4d0792bc6f82584836f4c41
 SHA512:
-  metadata.gz: cceeb7c7c9893668beeabd277ec5aca15619639a4f06d7919c0e7dabc808b1b3143d3812e15210492f72ee8976e4cbb3cb7a67d67a88b36d77293cd8b723185a
-  data.tar.gz: ab263be7f259bff1bda316e9f5c8503dba231a7271b850fea11d4bd2abdfbd81e0e3e71f35c6c75818d64503c7b1a170ec33e50868103e9c75cf7ded2a578381
+  metadata.gz: c17f4375c2b3a827bfb0d90ad2350f0e54f9a301faa7a4ebe3f62b256199ceaad8ef922dd327447b3898191654ac2829d3ae6084356748c2d265c235aa0a1be7
+  data.tar.gz: e5a6510258ecb7ba8942ac7fc93196399d89c3f1b60a7b0195429d86efd13afdd6bf06d34fae5f250dfe95b13c6ac8aac8027c56f5e4ccb23093c53c65d894ac

data/{LICENSE.txt → LICENSE}

@@ -1,6 +1,6 @@
-The MIT License (MIT)
+MIT License
 
-Copyright (c) 2020 openconcept
+Copyright (c) 2020 CESSDA ERIC
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 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
 copies of the Software, and to permit persons to whom the Software is
 furnished to do so, subject to the following conditions:
 
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
 
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -1,13 +1,25 @@
 # jekyll-cessda-docs
 
-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`.
+CESSDA theme for just-the-docs. These are the source files for building the gem.
 
-To experiment with this code, add some sample content and run `bundle exec jekyll serve` – this directory is setup just like a Jekyll site!
+## Building and pushing
 
-TODO: Delete this and the text above, and describe your gem
+1. set up git and RubyGems user. Instructions here: <https://jekyllrb.com/docs/themes/#publishing-your-theme>
+2. Update the file `jekyll-cessda-docs.gemspec` with the new version number, for example:
+spec.version       = "0.1.4"
+3. Build the gem:
 
+	```sh
+	gem build jekyll-cessda-docs.gemspec
+	```
 
-## Installation
+4. Push to Rubygems.org:
+
+	```sh
+	gem push jekyll-cessda-docs-*.gem
+	```
+
+## Installing
 
 Add this line to your Jekyll site's `Gemfile`:
 
@@ -23,19 +35,17 @@ theme: jekyll-cessda-docs
 
 And then execute:
 
-    $ bundle
+```sh
+bundle
+```
 
 Or install it yourself as:
 
-    $ gem install jekyll-cessda-docs
-
-## Usage
-
-TODO: Write usage instructions here. Describe your available layouts, includes, sass and/or assets.
-
-## Contributing
+```sh
+gem install jekyll-cessda-docs
+```
 
-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.
+See the [CESSDA documentation](https://docs.tech.cessda.eu/platform/documentation_tooling.html) for more details.
 
 ## Development
 
@@ -43,10 +53,8 @@ To set up your environment to develop this theme, run `bundle install`.
 
 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.
 
-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.
+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.
 
 ## License
 
 The theme is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
-

data/_config.yml

@@ -4,13 +4,15 @@
 title: CESSDA Technical Guidelines
 baseurl: /
 logo: assets/CESSDA.png
-color_scheme: cessda
+color_scheme: light
 
 # Theme
 #theme: just-the-docs
-theme: jekyll-cessda-docs
 search_enabled: true
 
+plugins:
+  - jekyll-seo-tag
+
 defaults:
  -
   scope:

data/_includes/glossary.html

@@ -0,0 +1,27 @@
+{%- comment -%}
+  This file adds a link to the glossary page with optional mouseover,
+  if an expansion of the abbreviation can be found in data/glossary.yml.
+  Note the excessive use of whitespace hiding!
+{%- endcomment -%}
+{%- unless include.text -%}
+{%- assign display_string = include.entry -%}
+{%- else -%}
+{%- assign display_string = include.text -%}
+{%- endunless %}
+{%- assign mouseover = "" -%}
+{%- for gl_entry in site.data.glossary -%}
+  {%- if gl_entry.entry == include.entry -%}
+    {%- capture mouseover %}{{ gl_entry.title }} -- {{ gl_entry.description }}{% endcapture -%}
+  {%- endif -%}
+{%- endfor -%}
+{%- comment -%}
+  If we don't have matching abbriviation, try the full title!
+{%- endcomment -%}
+{%- if mouseover == "" -%}
+  {%- for gl_entry in site.data.glossary -%}
+    {%- if gl_entry.title == include.entry -%}
+      {%- capture mouseover %}{{ gl_entry.description }}{% endcapture -%}
+    {%- endif -%}
+  {%- endfor -%}
+{% endif -%}
+<span class="glossary_entry" title="{{ mouseover }}">[{{ display_string }}]({% link glossary.md %})</span>{{- -}}

data/_includes/glossary_table.html

@@ -0,0 +1,16 @@
+<table summary="CESSDA Glossary">
+  <thead>
+    <tr>
+      <th scope="col">Acronym</th>
+      <th scope="col">Expansion</th>
+      <th scope="col">Description</th>
+    </tr>
+  </thead>
+  <tbody>
+  {% for row in site.data.glossary %}
+    {% tablerow pair in row %}
+      {{ pair[1] }}
+    {% endtablerow %}
+  {% endfor %}
+  </tbody>
+</table>

data/_includes/head.html

@@ -26,15 +26,31 @@
 
   {% endif %}
 
-  {% if site.search_enabled != false %}
+  {% if site.search_enabled == true %}
     <script type="text/javascript" src="{{ '/assets/js/vendor/lunr.min.js' | relative_url }}"></script>
   {% endif %}
   <script type="text/javascript" src="{{ '/assets/js/just-the-docs.js' | relative_url }}"></script>
 
   <meta name="viewport" content="width=device-width, initial-scale=1">
 
-
+  {% seo %}
 
   {% include head_custom.html %}
-
+  {% if site.matomo_siteid and site.matomo_siteid != "" and site.matomo_siteid != nil %}
+  <!-- Matomo -->
+<script type="text/javascript">
+  var _paq = window._paq = window._paq || [];
+  /* tracker methods like "setCustomDimension" should be called before "trackPageView" */
+  _paq.push(['trackPageView']);
+  _paq.push(['enableLinkTracking']);
+  (function() {
+    var u="//analytics.cessda.eu/";
+    _paq.push(['setTrackerUrl', u+'matomo.php']);
+    _paq.push(['setSiteId', '{{ site.matomo_siteid }}']);
+    var d=document, g=d.createElement('script'), s=d.getElementsByTagName('script')[0];
+    g.type='text/javascript'; g.async=true; g.src=u+'matomo.js'; s.parentNode.insertBefore(g,s);
+  })();
+</script>
+<!-- End Matomo Code -->
+{% endif %}
 </head>

data/_layouts/default.html

@@ -41,7 +41,7 @@ layout: table_wrappers
   </svg>
   <div class="bg-grey-dk-200 topcont">
     <div class="topbar">
-    <a href="https://www.cessda.eu">Consortium of Social Science Data Archives</a>
+    <a href="https://www.cessda.eu">Consortium of European Social Science Data Archives</a>
   </div>
   </div>
   <div class="maincont">

data/_sass/cessda.scss

@@ -1,93 +1,93 @@
-
-a {
-    transition: all 0.3s;
-    }
-    .topcont {
-      height: 30px;
-      width:100%;
-     z-index:3;
-  position:fixed;
-  top:0;
-  left:0;
-  
-    }
-    .topbar {
-  
-      max-width:1080px;
-      margin: 0 auto;
-    height:30px;
-      }
-  
-
-    .topbar a {
-        color: white;
-        text-decoration:none;
-        display:inline-block;
-        line-height:30px;
-        padding:0 10px;
-        font-size: 14px;
-        background-image: none;
-        }
-    
-        .topbar a:hover {
-           background-color:rgba(255,255,255,0.1);
-            }
-  
-  .main-header {
-  
-  margin-top:30px;
-  }
-  
-  
-  
-  .site-footer {
-    
-    z-index:4;
-    position: fixed;
-   display:block;
-   bottom:0px;
-   height:40px;
-   width:100%;
-  }
-  #footerlogo {
-  height: 24px;
-  width:auto;
-  margin: 8px 20px 0 10px;
-  display:block;
-  position:absolute;
-  left:0;
-  top:2px;
-  }
-
-  .bottombar {
-  
-    max-width:1080px;
-    margin: 0 auto;
-  height:40px;
-position:relative;
-text-align:center;
-  }
-
-  .site-footer a {
-display:inline-block;
-color:white;
-padding:0 10px;
-font-size:14px;
-background:transparent;
-line-height:40px;
-height:40px;
-margin:0;
-  }
-  .nav-list-top {
-  margin-bottom:50px;
-  
-  }
-  
-  @media only screen and (max-width: 711px) {
-  .site-header {
-    padding-top:30px;
-  }
-  #footerlogo {
-  display:none;
-    }
+
+a {
+    transition: all 0.3s;
+    }
+    .topcont {
+      height: 30px;
+      width:100%;
+     z-index:3;
+  position:fixed;
+  top:0;
+  left:0;
+  
+    }
+    .topbar {
+  
+      max-width:1080px;
+      margin: 0 auto;
+    height:30px;
+      }
+  
+
+    .topbar a {
+        color: white;
+        text-decoration:none;
+        display:inline-block;
+        line-height:30px;
+        padding:0 10px;
+        font-size: 14px;
+        background-image: none;
+        }
+    
+        .topbar a:hover {
+           background-color:rgba(255,255,255,0.1);
+            }
+  
+  .main-header {
+  
+  margin-top:30px;
+  }
+  
+  
+  
+  .site-footer {
+    
+    z-index:4;
+    position: fixed;
+   display:block;
+   bottom:0px;
+   height:40px;
+   width:100%;
+  }
+  #footerlogo {
+  height: 24px;
+  width:auto;
+  margin: 8px 20px 0 10px;
+  display:block;
+  position:absolute;
+  left:0;
+  top:2px;
+  }
+
+  .bottombar {
+  
+    max-width:1080px;
+    margin: 0 auto;
+  height:40px;
+position:relative;
+text-align:center;
+  }
+
+  .site-footer a {
+display:inline-block;
+color:white;
+padding:0 10px;
+font-size:14px;
+background:transparent;
+line-height:40px;
+height:40px;
+margin:0;
+  }
+  .nav-list-top {
+  margin-bottom:50px;
+  
+  }
+  
+  @media only screen and (max-width: 711px) {
+  .site-header {
+    padding-top:30px;
+  }
+  #footerlogo {
+  display:none;
+    }
   }

data/_sass/color_schemes/cessda.scss

@@ -0,0 +1 @@
+$link-color: #2B5A9B;

data/_sass/custom/custom.scss

@@ -1,93 +1,93 @@
-
-a {
-    transition: all 0.3s;
-    }
-    .topcont {
-      height: 30px;
-      width:100%;
-     z-index:3;
-  position:fixed;
-  top:0;
-  left:0;
-  
-    }
-    .topbar {
-  
-      max-width:1080px;
-      margin: 0 auto;
-    height:30px;
-      }
-  
-
-    .topbar a {
-        color: white;
-        text-decoration:none;
-        display:inline-block;
-        line-height:30px;
-        padding:0 10px;
-        font-size: 14px;
-        background-image: none;
-        }
-    
-        .topbar a:hover {
-           background-color:rgba(255,255,255,0.1);
-            }
-  
-  .main-header {
-  
-  margin-top:30px;
-  }
-  
-  
-  
-  .site-footer {
-    
-    z-index:4;
-    position: fixed;
-   display:block;
-   bottom:0px;
-   height:40px;
-   width:100%;
-  }
-  #footerlogo {
-  height: 24px;
-  width:auto;
-  margin: 8px 20px 0 10px;
-  display:block;
-  position:absolute;
-  left:0;
-  top:2px;
-  }
-
-  .bottombar {
-  
-    max-width:1080px;
-    margin: 0 auto;
-  height:40px;
-position:relative;
-text-align:center;
-  }
-
-  .site-footer a {
-display:inline-block;
-color:white;
-padding:0 10px;
-font-size:14px;
-background:transparent;
-line-height:40px;
-height:40px;
-margin:0;
-  }
-  .nav-list-top {
-  margin-bottom:90px;
-  
-  }
-  
-  @media only screen and (max-width: 711px) {
-  .site-header {
-    padding-top:30px;
-  }
-  #footerlogo {
-  display:none;
-    }
+
+a {
+    transition: all 0.3s;
+    }
+    .topcont {
+      height: 30px;
+      width:100%;
+     z-index:3;
+  position:fixed;
+  top:0;
+  left:0;
+  
+    }
+    .topbar {
+  
+      max-width:1080px;
+      margin: 0 auto;
+    height:30px;
+      }
+  
+
+    .topbar a {
+        color: white;
+        text-decoration:none;
+        display:inline-block;
+        line-height:30px;
+        padding:0 10px;
+        font-size: 14px;
+        background-image: none;
+        }
+    
+        .topbar a:hover {
+           background-color:rgba(255,255,255,0.1);
+            }
+  
+  .main-header {
+  
+  margin-top:30px;
+  }
+  
+  
+  
+  .site-footer {
+    
+    z-index:4;
+    position: fixed;
+   display:block;
+   bottom:0px;
+   height:40px;
+   width:100%;
+  }
+  #footerlogo {
+  height: 24px;
+  width:auto;
+  margin: 8px 20px 0 10px;
+  display:block;
+  position:absolute;
+  left:0;
+  top:2px;
+  }
+
+  .bottombar {
+  
+    max-width:1080px;
+    margin: 0 auto;
+  height:40px;
+position:relative;
+text-align:center;
+  }
+
+  .site-footer a {
+display:inline-block;
+color:white;
+padding:0 10px;
+font-size:14px;
+background:transparent;
+line-height:40px;
+height:40px;
+margin:0;
+  }
+  .nav-list-top {
+  margin-bottom:90px;
+  
+  }
+  
+  @media only screen and (max-width: 711px) {
+  .site-header {
+    padding-top:30px;
+  }
+  #footerlogo {
+  display:none;
+    }
   }

data/_sass/support/_variables.scss

@@ -51,7 +51,7 @@ $purple-300: #381885 !default;
 
 $blue-000: #2c84fa !default;
 $blue-100: #2869e6 !default;
-$blue-200: #264caf !default;
+$blue-200: #2B5A9B !default;
 $blue-300: #2b5a9b !default;
 
 $green-000: #41d693 !default;
@@ -80,7 +80,7 @@ $body-text-color: $grey-dk-100 !default;
 $body-heading-color: $grey-dk-300 !default;
 $search-result-preview-color: $grey-dk-000 !default;
 $nav-child-link-color: $grey-dk-100 !default;
-$link-color: $purple-000 !default;
+$link-color: $blue-200 !default;
 $btn-primary-color: $blue-300 !default;
 $base-button-color: #f7f7f7 !default;
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-cessda-docs
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.5.pre.c8c720a2d5d981d7a0c823c57e579379f502d827
 platform: ruby
 authors:
 - openconcept
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-10-21 00:00:00.000000000 Z
+date: 2020-11-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.1'
+- !ruby/object:Gem::Dependency
+  name: jekyll-seo-tag
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
 description: 
 email:
 - post@openconcept.no
@@ -31,12 +45,14 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- LICENSE.txt
+- LICENSE
 - README.md
 - _config.yml
 - _includes/css/custom.scss.liquid
 - _includes/css/just-the-docs.scss.liquid
 - _includes/fix_linenos.html
+- _includes/glossary.html
+- _includes/glossary_table.html
 - _includes/head.html
 - _includes/head_custom.html
 - _includes/js/custom.js
@@ -54,6 +70,7 @@ files:
 - _sass/buttons.scss
 - _sass/cessda.scss
 - _sass/code.scss
+- _sass/color_schemes/cessda.scss
 - _sass/color_schemes/dark.scss
 - _sass/color_schemes/light.scss
 - _sass/content.scss
@@ -94,7 +111,8 @@ files:
 homepage: https://cessda.eu
 licenses:
 - MIT
-metadata: {}
+metadata:
+  documentation_uri: https://docs.tech.cessda.eu/platform/documentation_tooling.html
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -106,13 +124,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6.2
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
-summary: Chrome for CESSDA tech docs
+summary: Jekyll theme for CESSDA documentation sites
 test_files: []