okf-pub-theme 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e73318dca48bad376050a513f4690ef4df3889a1
+  data.tar.gz: 866d2520bbd1bb9f9bc97cf7b7be64fb547ac1f4
+SHA512:
+  metadata.gz: 39a2019de5c279715e5d433173ec74e420e5f56b05d595513abc13e1b0fc06958e635a90e4dc57a75111b31658584184d4dda0c5a561b58e5c444c2ec42a8c18
+  data.tar.gz: cdf3999e1b9eb86527a27c793c2e2a6e4ab0021eff1a5f0a2673bd6d70f0227977574fba420892033328c3d9d78a2798917cd2fc56879fbe050b82fe3a88ed69

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 lislis
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+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 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.

data/README.md

@@ -0,0 +1,111 @@
+# okf-pub
+
+A Jekyll theme for online publications.
+
+## Installation
+
+Add this line to your Jekyll site's `Gemfile`:
+
+```ruby
+gem "okf-pub"
+```
+
+And add this line to your Jekyll site's `_config.yml`:
+
+```yaml
+theme: okf-pub
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install okf-pub
+
+## Usage
+
+This is a Jekyll theme for publications. It will render all `_content` into a single html file and generate a navigation with jump links.
+
+Because of that this theme only has one layout, `home`, to be used in your `index.md` like so:
+
+``` yaml
+---
+layout: home
+---
+```
+
+For the layout to find all your Markdown files, put them into `_content` and numerate the filenames and folders for Jekyll to keep the order consistent. E.g:
+
+```
+- _content/
+-- 1-intro.md
+-- 2-overview.md
+-- 3-sections/
+---- 1-subsection.md
+---- 2-subsection.md
+-- 4-afterword.md
+```
+
+`content` is a [collection](https://jekyllrb.com/docs/collections/), in case you were wondering.
+
+There are a bunch of variables you should set in your config.yml to, as well.
+This theme will use the following:
+
+``` yaml
+title: A title
+author: Author
+email: test@test.de
+description: >
+  Description and teaser, used in a couple of places
+# path to the publication as pdf
+pub:
+  pdf: /fake/link/to.pdf
+# were to link back to
+mainpage:
+  url: //your-actual-website.tld
+  label: Go back to the actual website
+  year: 2018
+# used to generate project meta content
+# these are the keys that will be looked for in the project.md files
+chapter:
+  effects:
+    - label: Some Key
+      key: somekey
+    - label: another Key
+      key: anotherkey
+  resources:
+    - label: Some Resource
+      key: someresource
+    - label: Another Resource
+      key: anotherresource
+  outcomes:
+    - label: Some Outcome
+      key: someoutcome
+    - label: Anoter outcome with elaborate Title
+      key: anotheroutcome
+
+# Optional, matomo tracking code
+# matomo:
+#   url: //to-your-matomo.tdl
+#   id: projectID
+
+```
+
+## Contributing
+
+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.
+
+## Development
+
+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 `okf-pub.gemspec` accordingly.
+
+## License
+
+The theme is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/_includes/chapters.html

@@ -0,0 +1,18 @@
+{% assign frags = page.path | split: "/" %}
+{% if frags.size == 2 %}
+    <p class="main__chapter is-size-7 is-uppercase">Kapitel {{ page.chapter }}</p>
+    <h1 class="title" id="{{ page.title | url_encode}}">{{ page.title }}</h1>
+{% else %}
+    {% if page.chapter %}
+    <p class="main__chapter is-size-7 is-uppercase">Kapitel {{ page.chapter }}</p>
+    {% endif %}
+    <h2 class="{% if page.chapter %}title{% endif %}" id="{{ page.title | url_encode}}">{{page.title}}</h2>
+{% endif %}
+
+<div>
+{{ page.content | markdownify }}
+</div>
+
+{% include effect-chains.html %}
+
+{% include outcomes.html %}

data/_includes/effect-chains.html

@@ -0,0 +1,18 @@
+{% if page.problem  %}
+<section>
+{% for x in site.chapter.effects %}
+  {% if page[x.key] %}
+    <div class="effect__block">
+      <h3 class="is-size-4">{{ x.label }}</h3>
+      {% assign collection = page[x.key] %}
+      <ol class="effect__chain">
+        {% for item in collection %}
+        {% include effect-item.html %}
+        {% endfor %}
+      </ol>
+    </div>
+  {% endif %}
+{% endfor %}
+</section>
+<hr>
+{% endif %}

data/_includes/effect-item.html

@@ -0,0 +1,5 @@
+<li>
+  {% if item.title %}<h4>{{ item.title }}</h4>{% endif %}
+  {% if item.text %}<p>{{ item.text }}</p>{% endif %}
+  {% if item.claim %}<p class="effect__claim"><strong>{{ item.claim }}</strong></p>{% endif %}
+</li>

data/_includes/footer.html

@@ -0,0 +1,5 @@
+<footer class="footer">
+  <div class="container">
+    &copy; OKF DE 2019
+  </div>
+</footer>

data/_includes/head.html

@@ -0,0 +1,22 @@
+<head>
+  <meta charset="utf-8">
+  <meta http-equiv="X-UA-Compatible" content="IE=edge">
+  <meta name="viewport" content="width=device-width, initial-scale=1">
+  {%- seo -%}
+  <link rel="stylesheet" href="{{ "/assets/css/style.css" | relative_url }}">
+  {%- feed_meta -%}
+
+  <link rel="apple-touch-icon" sizes="180x180" href="/assets/favicon/apple-touch-icon.png">
+  <link rel="icon" type="image/png" sizes="32x32" href="/assets/favicon/favicon-32x32.png">
+  <link rel="icon" type="image/png" sizes="16x16" href="/assets/favicon/favicon-16x16.png">
+  <link rel="manifest" href="/assets/favicon/manifest.json">
+  <link rel="mask-icon" href="/assets/favicon/safari-pinned-tab.svg" color="#5bbad5">
+  <link rel="shortcut icon" href="/assets/favicon/favicon.ico">
+  <meta name="msapplication-TileColor" content="#ffffff">
+  <meta name="msapplication-config" content="/assets/favicon/browserconfig.xml">
+  <meta name="theme-color" content="#ffffff">
+
+  {%- if jekyll.environment == 'production' and site.matomo -%}
+  {%- include matomo.html -%}
+  {%- endif -%}
+</head>

data/_includes/header.html

@@ -0,0 +1,36 @@
+<header class="header" id="menutoggle">
+  <a href="#content" class="show-on-focus skip">Zum Inhalt skippen</a>
+  <div class="header__visible">
+    <div class="header__toggle">
+      <a href="#menutoggle" class="toggle burger" title="Menü ausklappen">
+        <svg viewBox="0 0 100 100" width="60px" height="40px" class="toggle__icon">
+          <rect x="0" y="38" width="100" height="5" class="toggle__r" />
+          <rect x="0" y="63" width="100" height="5" class="toggle__l" />
+        </svg>
+      </a>
+      <a href="#" class="toggle cross" title="Menü einklappen">
+        <svg viewBox="0 0 100 100" width="60px" height="40px" class="toggle__icon">
+          <rect x="0" y="38" width="100" height="5" class="toggle__r" />
+          <rect x="0" y="63" width="100" height="5" class="toggle__l" />
+        </svg>
+      </a>
+    </div>
+    <div class="header__title">
+      <h2>{{ site.title }}</h2>
+    </div>
+  </div>
+  <div  class="header__toggleble">
+    <nav class="header__nav">
+      <h2 class="header__nav-title is-size-5">Inhalt</h2>
+      <ol>
+        {% for page in site.content %}
+        {% assign frags = page.path | split: "/" %}
+        <li class="{% if frags.size == 2 %}toplevel{% else %}sublevel{% endif %}">
+          <a href="#{{ page.title | url_encode}}">{{ page.title }}</a>
+        </li>
+      {% endfor %}
+      </ol>
+    </nav>
+    <p class="header__footer"><a href="{{ site.mainpage.url }}"><- {{ site.mainpage.label }}</a></p>
+  </div>
+</header>

data/_includes/matomo.html

@@ -0,0 +1,15 @@
+<!-- Matomo -->
+<script type="text/javascript">
+ var _paq = window._paq || [];
+ /* tracker methods like "setCustomDimension" should be called before "trackPageView" */
+ _paq.push(['trackPageView']);
+ _paq.push(['enableLinkTracking']);
+ (function() {
+   var u="{{ site.matomo.url }}";
+   _paq.push(['setTrackerUrl', u+'matomo.php']);
+   _paq.push(['setSiteId', {{ site.matomo.id }}]);
+   var d=document, g=d.createElement('script'), s=d.getElementsByTagName('script')[0];
+   g.type='text/javascript'; g.async=true; g.defer=true; g.src=u+'matomo.js'; s.parentNode.insertBefore(g,s);
+ })();
+</script>
+<!-- End Matomo Code -->

data/_includes/outcomes.html

@@ -0,0 +1,34 @@
+{% if page.effect %}
+<section class="chapter">
+  <h2>Was ist {{ site.mainpage.year }} passiert?</h2>
+
+{% if page.resources %}
+  <div class="chapter__resources">
+    <h3>Resourcen</h3>
+
+    {% for y in site.chapter.resources %}
+      {% if page.resources[y.key] %}
+        <div class="chapter__item">
+          <h4>{{ y.label }}</h4>
+          <img src="{{ page.resources[y.key].img }}"
+               alt="{{ page.resources[y.key].alt }}">
+        </div>
+      {% endif %}
+    {% endfor %}
+  </div>
+{% endif %}
+
+  <div class="chapter__outcomes">
+    {% for x in site.chapter.outcomes %}
+      {% if page[x.key] %}
+        <div class="columns chapter__item">
+          <h3 class="column is-one-third">{{ x.label }}</h3>
+          <div class="column is-two-thirds no-inner-margin">
+            {{ page[x.key] | markdownify}}
+          </div>
+        </div>
+      {% endif %}
+    {% endfor %}
+  </div>
+</section>
+{% endif %}

data/_layouts/default.html

@@ -0,0 +1,19 @@
+<!DOCTYPE html>
+<html lang="{{ page.lang | default: site.lang | default: "de" }}">
+
+  {%- include head.html -%}
+
+  <body>
+
+    {%- include header.html -%}
+
+    <main class="page-content" aria-label="Content" id="content">
+      <div class="wrapper">
+        {{ content }}
+      </div>
+    </main>
+
+    {%- include footer.html -%}
+
+  </body>
+</html>

data/_layouts/home.html

@@ -0,0 +1,52 @@
+---
+layout: default
+---
+
+<section class="hero is-light is-fullheight">
+  <div class="hero-body">
+    <div class="container">
+      <div class="colums">
+        <div class="column is-three-quarters-mobile is-two-thirds-tablet is-half-desktop">
+          <h1 class="title is-spaced is-size-1">
+            {{ site.title }}
+          </h1>
+          <h2 class="subtitle">
+            {{ site.description }}
+          </h2>
+          {% if site.pub and site.pub.pdf %}
+          <a href="{{ site.pub.pdf }}" class="button is-link is-uppercase">
+            <span>Download PDF</span>
+            <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 100 100"
+                 width="20px" height="20px" class="icon-download">
+              <title>download icon</title>
+              <path d="M15 84 H 85" fill="transparent" stroke="white" stroke-width="7"
+                    stroke-linecap="square" />
+              <path d="M50 10 V 70" fill="transparent" stroke="white"
+                    stroke-width="7" stroke-linecap="round" />
+              <path d="M25 50 L 50 70 L 75 50"
+                    fill="transparent" stroke="white"
+                    stroke-width="7" stroke-linecap="round"/>
+            </svg>
+          </a>
+          {% endif %}
+        </div>
+      </div>
+    </div>
+  </div>
+</section>
+<article>
+  {% for page in site.content %}
+  <section class="main columns">
+    <div class="main__img column is-half">
+      {% if page.visual %}
+      <img src="{{ page.visual.img}}"
+           alt="{{ page.visual.alt }}"
+           class="main__img__img">
+      {% endif%}
+    </div>
+    <div class="main__copy column is-half">
+      {% include chapters.html %}
+    </div>
+  </section>
+  {% endfor %}
+</article>

data/_sass/_a11y.sass

@@ -0,0 +1,25 @@
+.skip
+  background-color: $primary
+  color: $white
+  font-size: 1.3rem
+  padding: 1em
+  text-decoration: none
+  &:focus
+    outline: 1px dashed $white
+
+.sr-only,
+.show-on-focus
+  height: 1px
+  overflow: hidden
+  position: absolute
+  width: 1px
+
+.show-on-focus
+  clip: rect(1px,1px,1px,1px)
+  margin: 0
+
+  &:focus
+    clip: auto
+    height: auto
+    width: auto
+    z-index: 20