first commit

.github/workflows/build_and_deploy.yml

@@ -0,0 +1,30 @@
+name: Build and Deploy
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Build
+        run: |
+          mkdir -p build && chmod -R 0777 build
+          make slides
+      - name: Prepare Deploy
+        if: github.ref == 'refs/heads/main'
+        run: |
+          echo "# This branch is for deployment only" >> build/README.md
+          mv build/slide-deck.html build/index.html
+      - name: Deploy
+        if: github.ref == 'refs/heads/main'
+        uses: JamesIves/github-pages-deploy-action@v4.4.0
+        with:
+          branch: gh-pages
+          folder: build
+          single-commit: true
+          silent: true

.gitignore

@@ -0,0 +1,139 @@
+#IDE
+.idea
+.vscode
+
+# Build Folder
+build
+
+# Generated light theme slides
+*light.md
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/

.marprc.yml

@@ -0,0 +1,10 @@
+allowLocalFiles: true
+options:
+  looseYAML: false
+  markdown:
+    breaks: true       # newlines in paragraphs are rendered as <br>
+bespoke:
+  progress: true
+output: "./build/"
+themeSet: "./themes"
+theme: pwr

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Markus Hofbauer
+
+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.

Makefile

@@ -0,0 +1,18 @@
+file_finder = find . -type f \( $(1) \) -not -path '*/build/*'
+
+SLIDE_FILES = $(call file_finder,-name slide-deck.md)
+SLIDE_FILES_LIGHT = $(call file_finder,-name slide-deck-light.md)
+
+clean:
+	rm -rf build
+
+light_theme_slides:
+	$(SLIDE_FILES) | xargs -I '{}' sh -c 'v={}; cp $$v $${v%.md}-light.md'
+	$(SLIDE_FILES_LIGHT) | xargs sed -i '/class. invert/d'
+	$(SLIDE_FILES_LIGHT) | xargs sed -i '/- invert/d'
+
+.PHONY: slides
+slides: light_theme_slides
+	mkdir -p build && cp -r slides/images build/
+	docker compose run -e MARP_USER=$(shell id -u):$(shell id -g) generate --input-dir ./slides
+	docker compose run -e MARP_USER=$(shell id -u):$(shell id -g) generate --input-dir ./slides --pdf

README.md

@@ -0,0 +1,34 @@
+# PWr Marp Template
+
+> This template is based on the [TUM Marp Template](https://github.com/hofbi/tum-marp-template).
+
+This is a template for [Marp](https://marp.app/) presentations at [PWr](https://pwr.edu.pl/). Marp is the simplest presentation writer with Markdown.
+
+You can find a live demo at https://hofbi.github.io/tum-marp-template/
+
+Download the [PDF](https://hofbi.github.io/tum-marp-template/slide-deck.pdf).
+
+## Setup
+
+Follow the setup on the [Marp CLI repository](https://github.com/marp-team/marp-cli) or use the `docker-compose.yml`.
+
+## Build
+
+```shell
+# Learn the CLI
+docker compose run generate --help
+
+# Generate slides
+docker compose run generate --input-dir ./slides         # Generate html
+docker compose run generate --input-dir ./slides --pdf   # Pdf
+docker compose run generate --input-dir ./slides --pptx  # Powerpoint
+
+# Fast Live Serve of the slides
+docker compose up   # Access the slides on http://localhost:8080
+```
+
+## How To
+
+- [Get Started](https://github.com/marp-team/marp)
+- [Documentation](https://marpit.marp.app/)
+- [CLI](https://github.com/marp-team/marp-cli)

docker-compose.yml

@@ -0,0 +1,21 @@
+version: '3'
+services:
+  generate:
+    image: marpteam/marp-cli
+    volumes:
+      - ./:/home/marp/app
+    environment:
+      - LANG=de_DE.UTF-8
+      - MARP_USER=""
+    command: --input-dir ./slides
+  serve:
+    image: marpteam/marp-cli
+    volumes:
+      - ./:/home/marp/app
+    environment:
+      - LANG=de_DE.UTF-8
+      - MARP_USER=""
+    ports:
+      - 8080:8080
+      - 37717:37717
+    command: --watch --server ./slides