From 7ec3ed71d6eddf8a63843d8488b02f58b2b4b0b9 Mon Sep 17 00:00:00 2001 From: Martijn Kersloot Date: Mon, 11 Nov 2024 15:36:11 +0100 Subject: [PATCH 1/3] Update README.md --- README.md | 33 +++++++++------------------------ 1 file changed, 9 insertions(+), 24 deletions(-) diff --git a/README.md b/README.md index d5da94d..d4b20a8 100644 --- a/README.md +++ b/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/). \ No newline at end of file From 088029edd0c351b98f8da5f60f11cbc161741e85 Mon Sep 17 00:00:00 2001 From: Martijn Kersloot Date: Mon, 11 Nov 2024 15:36:19 +0100 Subject: [PATCH 2/3] Add github edit buttons --- _layouts/lesson-plan.html | 6 +++++- _layouts/page.html | 15 +++++++++------ _layouts/unit.html | 4 ++++ _sass/lesson-plans.scss | 3 ++- 4 files changed, 20 insertions(+), 8 deletions(-) diff --git a/_layouts/lesson-plan.html b/_layouts/lesson-plan.html index 271196d..388ce9a 100644 --- a/_layouts/lesson-plan.html +++ b/_layouts/lesson-plan.html @@ -9,9 +9,13 @@ {% unless page.content contains " {{ page.number }} - {{ page.title | default: site.title }} + {{ page.title | default: site.title }} {% endunless %} + + {%- if site.theme_variables.github_buttons.position == "top" or site.theme_variables.github_buttons.position == nil %} + {% include github-buttons.html %} + {%- endif %}
diff --git a/_layouts/page.html b/_layouts/page.html index 238fdc4..c884cff 100644 --- a/_layouts/page.html +++ b/_layouts/page.html @@ -4,21 +4,24 @@
+
{%- if page.title %} {%- if page.type %} {%- assign subtitle = page.type | replace: "_", " " | capitalize %} -

{{subtitle}} {{ page.title }}

+

{{subtitle}} {{ page.title }}

{%- else %}

{{ page.title }} {%- endif %} - {%- if site.theme_variables.github_buttons.position == "top" or site.theme_variables.github_buttons.position == nil %} - {% include github-buttons.html %} - {%- endif %}

{%- endif %} - {%- if page.summary %} -
{{page.summary}}
+ + {%- if site.theme_variables.github_buttons.position == "top" or site.theme_variables.github_buttons.position == nil %} + {% include github-buttons.html %} {%- endif %} +
+ {%- if page.summary %} +
{{page.summary}}
+ {%- endif %}
{%- unless page.toc == false %}
diff --git a/_layouts/unit.html b/_layouts/unit.html index 07d6a40..a70151c 100644 --- a/_layouts/unit.html +++ b/_layouts/unit.html @@ -17,6 +17,10 @@

{{ page.title | default: site.title }}

{% endunless %} + + {%- if site.theme_variables.github_buttons.position == "top" or site.theme_variables.github_buttons.position == nil %} + {% include github-buttons.html %} + {%- endif %}
diff --git a/_sass/lesson-plans.scss b/_sass/lesson-plans.scss index ce1aad8..1a8f3a9 100644 --- a/_sass/lesson-plans.scss +++ b/_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; From a04cc6bb50d53c94fe91f49ac55caf70a0a50359 Mon Sep 17 00:00:00 2001 From: Martijn Kersloot Date: Mon, 11 Nov 2024 15:37:08 +0100 Subject: [PATCH 3/3] Fix capitalization --- _lesson-plans/fair-generics/topics/1-why-fair.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_lesson-plans/fair-generics/topics/1-why-fair.md b/_lesson-plans/fair-generics/topics/1-why-fair.md index 703314c..847d6f0 100644 --- a/_lesson-plans/fair-generics/topics/1-why-fair.md +++ b/_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: