Use mkdocs

.github/workflows/ci.yml

@@ -0,0 +1,15 @@
+name: ci
+on:
+  push:
+    branches:
+      - main
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-python@v2
+        with:
+          python-version: 3.x
+      - run: pip install mkdocs-material
+      - run: mkdocs gh-deploy --force

README.md

@@ -1,15 +1,2 @@
 # awk_course
 
-This is the teaching material for the UPPMAX Awk course.
-
-This repository is based on the material of <https://pmitev.github.io/to-awk-or-not/>
-and puts it into teaching cycles.
-
- * [FAQ](faq.md)
-
-## Overview
-
-```mermaid
-flowchart TD
-    awk[Awk]
-```

docs/README.md

@@ -0,0 +1,15 @@
+# awk_course
+
+This is the teaching material for the UPPMAX Awk course.
+
+This repository is based on the material of <https://pmitev.github.io/to-awk-or-not/>
+and puts it into teaching cycles.
+
+ * [FAQ](faq.md)
+
+## Overview
+
+```mermaid
+flowchart TD
+    awk[Awk]
+```

docs/faq.md

@@ -0,0 +1,18 @@
+# Awk course FAQ
+
+## What is the goal of this repository?
+
+The goal of this repository is to use the 'To Awk Or Not?' materials
+and put it into lesson plans. 
+
+## Why is the course on 'To Awk Or Not?'
+
+This repository is based on the material of <https://pmitev.github.io/to-awk-or-not/>,
+because it is -as far as I can see- the only free and online Awl
+resource that has both text and exercises.
+
+## Why not use the 'To Awk Or Not?' repository for these lessons?
+
+That repository does not allow `mermaid` plots.
+I will not change the setup of the 'To Awk Or Not?' repository.
+Hence, I needed another repository :-) 

docs/stylesheets/extra.css

@@ -0,0 +1,27 @@
+:root > * {
+  --md-primary-fg-color:        #C41237;
+  --md-primary-bg-color:        #000000;
+  --md-primary-fg-color--light: #CCCCCC;
+  --md-accent-fg-color--light: #CCCCCC; 
+  --md-footer-bg-color: #CCCCCC;
+  --md-footer-fg-color: #000000;
+}
+
+
+:root {
+  --md-admonition-icon--t2s: url('data:image/svg+xml;charset=utf-8, <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 384 512"><!--! Font Awesome Free 6.2.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc.--><path d="M64 0C28.7 0 0 28.7 0 64v384c0 35.3 28.7 64 64 64h256c35.3 0 64-28.7 64-64V160H256c-17.7 0-32-14.3-32-32V0H64zm192 0v128h128L256 0zm2 226.3c37.1 22.4 62 63.1 62 109.7s-24.9 87.3-62 109.7c-7.6 4.6-17.4 2.1-22-5.4s-2.1-17.4 5.4-22c28-16.8 46.6-47.4 46.6-82.3s-18.6-65.5-46.5-82.3c-7.6-4.6-10-14.4-5.4-22s14.4-10 22-5.4zm-91.9 30.9c6 2.5 9.9 8.3 9.9 14.8v128c0 6.5-3.9 12.3-9.9 14.8s-12.9 1.1-17.4-3.5L113.4 376H80c-8.8 0-16-7.2-16-16v-48c0-8.8 7.2-16 16-16h33.4l35.3-35.3c4.6-4.6 11.5-5.9 17.4-3.5zm51 34.9c6.6-5.9 16.7-5.3 22.6 1.3 10.1 11.2 16.3 26.2 16.3 42.6s-6.2 31.4-16.3 42.7c-5.9 6.6-16 7.1-22.6 1.3s-7.1-16-1.3-22.6c5.1-5.7 8.1-13.1 8.1-21.3s-3.1-15.7-8.1-21.3c-5.9-6.6-5.3-16.7 1.3-22.6z"/></svg>')
+}
+.md-typeset .admonition.t2s,
+.md-typeset details.t2s {
+  border-color: rgb(43, 155, 70);
+}
+.md-typeset .t2s > .admonition-title,
+.md-typeset .t2s > summary {
+  background-color: rgba(43, 155, 70, 0.1);
+}
+.md-typeset .t2s > .admonition-title::before,
+.md-typeset .t2s > summary::before {
+  background-color: rgb(43, 155, 70);
+  -webkit-mask-image: var(--md-admonition-icon--t2s);
+          mask-image: var(--md-admonition-icon--t2s);
+}

mkdocs.yml

@@ -0,0 +1,77 @@
+site_name: Python Introduction
+
+nav:
+  - Start: index.md
+  - Morning Session:
+    - Overview: morning_session/overview.md
+    - Using The Python interpreter: morning_session/using_the_python_interpreter.md
+    - The Way Of The Program: morning_session/the_way_of_the_program.md
+    - Working with Python scripts: morning_session/working_with_python_scripts.md
+    - Variables, expressions and statements: morning_session/variables_expressions_and_statements.md
+#    - Lecture: morning_session/lecture.md
+#    - Exercise: morning_session/exercise.md
+  - Afternoon Session:
+    - Overview: afternoon_session/overview.md
+    - UPPMAX modules and Python packages: afternoon_session/hello_little_turtles.md
+    - File IO: afternoon_session/files.md
+    - Command-line arguments: afternoon_session/command_line_arguments.md
+    - Graphics: afternoon_session/graphics.md
+    - Functions: afternoon_session/functions.md
+#    - Lecture: afternoon_session/lecture.md
+#    - Exercise: afternoon_session/exercise.md
+
+theme:
+  name: material
+  greetings: Welcome to UPPMAX userguide
+  font:
+    # text: Lato
+    code: JetBrains Mono
+
+
+  logo: assets/logo.svg
+
+  features:
+    - navigation.tabs
+    - navigation.sections
+    - search.suggest
+    - content.code.annotate
+    - content.tabs.link
+
+  custom_dir: mkdocs_uppmax/
+
+extra_css:
+  - stylesheets/extra.css
+
+markdown_extensions:
+  - toc:
+      toc_depth: 3
+      permalink: true
+      permalink_title: Anchor link to this section for reference
+  - admonition
+  - tables
+  - attr_list
+  - footnotes
+  - pymdownx.details
+  - pymdownx.tabbed:
+      alternate_style: true
+  - pymdownx.highlight:
+      anchor_linenums: true
+  - pymdownx.inlinehilite
+  - pymdownx.snippets
+  - pymdownx.arithmatex:
+      generic: true
+  - pymdownx.superfences:
+      custom_fences:
+        - name: mermaid
+          class: mermaid
+          format: !!python/name:pymdownx.superfences.fence_code_format
+  - pymdownx.keys
+  - md_in_html
+  - pymdownx.emoji:
+      emoji_index: !!python/name:materialx.emoji.twemoji
+      emoji_generator: !!python/name:materialx.emoji.to_svg
+
+extra_javascript:
+  - javascripts/mathjax.js
+  - https://polyfill.io/v3/polyfill.min.js?features=es6
+  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js

mkdocs_uppmax/home.html

@@ -0,0 +1,52 @@
+{% extends "main.html" %}
+
+
+{% block tabs %}
+  {{ super() }}
+
+
+  <style>
+
+    /* Application header should be static for the landing page */
+    <!-- .md-header { -->
+    <!--   position: initial; -->
+    <!-- } -->
+
+    /* Remove spacing, as we cannot hide it completely */
+    .md-main__inner {
+      margin: 0;
+    }
+
+    /* Hide main content for now */
+    <!-- .md-content { -->
+    <!--   display: none; -->
+    <!-- } -->
+
+    /* Hide table of contents */
+    @media screen and (min-width: 60em) {
+      .md-sidebar--secondary {
+        display: none;
+      }
+    }
+
+    /* Hide navigation */
+    @media screen and (min-width: 76.25em) {
+      .md-sidebar--primary {
+        display: none;
+      }
+    }
+
+  </style>
+
+  <section class="tx-container">
+
+    <div class="md-grid md-typeset">
+
+      {{ page.content }}
+
+{% endblock %}
+
+
+{% block content %}{% endblock %}
+
+{% block footer %}{% endblock %}

mkdocs_uppmax/partials/footer.html

@@ -0,0 +1 @@
+

mkdocs_uppmax/stylesheets/extra.css

@@ -0,0 +1,5 @@
+:root > * {
+  --md-primary-fg-color:        #EE0F0F;
+  --md-primary-fg-color--light: #ECB7B7;
+  --md-primary-fg-color--dark:  #90030C;
+}