Merge pull request #154 from elixir-europe-training/small-fixes

Small fixes

README.md

@@ -1,39 +1,24 @@
-# Elixir Training Lesson template
+# FAIR Lesson Plan Handbook
 
-[![DOI](https://zenodo.org/badge/564252010.svg)](https://zenodo.org/badge/latestdoi/564252010)
+The FAIR Lesson Plan Handbook facilitates trainers to advance FAIR skills by helping them build training programs within life sciences research organisations. Many organisations struggle with training on how to implement FAIR in practice. The lesson plans are not a training in itself but offer a framework and learning paths to design FAIR trainings for specific audiences.
 
+## Installing locally
 
-For instruction on how to use the template, please follow this documentation: 
-https://elixir-europe-training.github.io/ELIXIR-TrP-LessonTemplateInstructions-MkDocs/
+This website is generated with [Jekyll](https://jekyllrb.com/), with the [ELIXIR Toolkit Theme](https://elixir-belgium.github.io/elixir-toolkit-theme/).
 
 
-**Any issues?** Contact Geert van Geest (@GeertvanGeest) 
 
+To host it locally, clone this repository to your local computer. 
 
-
-## If working locally
-
-This website is generated with [MkDocs](https://www.mkdocs.org/), with the theme [Material](https://squidfunk.github.io/mkdocs-material/).
-
-To host it locally, clone this repository to your local computer. Install the required dependencies by runnning: 
-
+Install Jekyll if you haven’t already:
 ```bash
-pip install -r requirements.txt
+gem install jekyll bundler
 ```
 
 Next, you can launch the website by making the repository your current directory and typing:
 
 ```bash
-mkdocs serve
+bundle exec jekyll serve
 ```
 
-Check it out with your browser at [http://localhost:8000/](http://localhost:8000/).
-
-
-## Citation
-
-Please cite as
-
-> Geert van Geest, Elin Kronander, Jose Alejandro Romero Herrera, Nadja Žlender, & Alexia Cardona. (2023). 
-> The ELIXIR Training Lesson Template - Developing Training Together (v1.0.0-alpha). Zenodo. 
-> https://doi.org/10.5281/zenodo.7913092
+Check it out with your browser at [http://localhost:4000/](http://localhost:4000/).

_layouts/lesson-plan.html

@@ -9,9 +9,13 @@
     {% unless page.content contains "<h1" %}
     <h1>
         <span class="lesson-plan-number">{{ page.number }}</span>
-        {{ page.title | default: site.title }}
+        <span class="lesson-plan-title">{{ page.title | default: site.title }}</span>
     </h1>
     {% endunless %}
+
+    {%- if site.theme_variables.github_buttons.position == "top" or site.theme_variables.github_buttons.position == nil %}
+    {% include github-buttons.html %}
+    {%- endif %}
 </div>
 
 <div class="lesson-plan-metadata">

_layouts/page.html

@@ -4,21 +4,24 @@
 <div class="container">
     <main id="main" class="order-1{% unless page.toc == false %} add-grid{% endunless %}">
         <div id="intro">
+            <div class="page-header">
             {%- if page.title %}
             {%- if page.type %}
             {%- assign subtitle = page.type | replace: "_", " " | capitalize %}
-            <h1 class="has-subtitle"><span class="d-block text-secondary fs-4 ff-body">{{subtitle}}</span><span class="visually-hidden">:</span> {{ page.title }}</h1>
+                <h1 class="has-subtitle"><span class="d-block text-secondary fs-4 ff-body">{{subtitle}}</span><span class="visually-hidden">:</span> {{ page.title }}</h1>
                 {%- else %}
                 <h1>{{ page.title }}
                     {%- endif %}
-                    {%- if site.theme_variables.github_buttons.position == "top" or site.theme_variables.github_buttons.position == nil %}
-                    {% include github-buttons.html %}
-                    {%- endif %}
                 </h1>
                 {%- endif %}
-                {%- if page.summary %}
-                <div class="summary">{{page.summary}}</div>
+
+                {%- if site.theme_variables.github_buttons.position == "top" or site.theme_variables.github_buttons.position == nil %}
+                {% include github-buttons.html %}
                 {%- endif %}
+            </div>
+            {%- if page.summary %}
+            <div class="summary">{{page.summary}}</div>
+            {%- endif %}
         </div>
         {%- unless page.toc == false %}
         <div id="toc" class="text-muted sticky-xl-top">

_layouts/unit.html

@@ -17,6 +17,10 @@ <h1>
             {{ page.title | default: site.title }}
         </h1>
         {% endunless %}
+
+        {%- if site.theme_variables.github_buttons.position == "top" or site.theme_variables.github_buttons.position == nil %}
+        {% include github-buttons.html %}
+        {%- endif %}
     </div>
 
     <div class="unit-content">

_lesson-plans/fair-generics/topics/1-why-fair.md

@@ -150,7 +150,7 @@ activities:
     - learning_outcome: 4
       activities: Facilitate a role-playing scenario where participants present a 'worst-case scenario' impact analysis of ignoring FAIR principles for a research project
       time: 60 min
-      type: Role-playing
+      type: role-playing
       level: expert
 
   after:

_sass/lesson-plans.scss

@@ -23,7 +23,8 @@ main#unit {
 }
 
 .lesson-plan-header,
-.unit-header
+.unit-header,
+.page-header
 {
   display: flex;
   justify-content: space-between;