Skip to content

Commit

Permalink
basic file structure
Browse files Browse the repository at this point in the history
  • Loading branch information
Steve2955 committed Mar 23, 2021
0 parents commit e78ab48
Show file tree
Hide file tree
Showing 9 changed files with 228 additions and 0 deletions.
78 changes: 78 additions & 0 deletions .github/workflows/pandoc.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
name: Create PDF release from markdown

on:
push:
branches:
- main
workflow_dispatch:

jobs:
convert_via_pandoc_and_release:
runs-on: ubuntu-18.04
steps:
- uses: actions/checkout@v2
- run: |
mkdir .old &&
rsync -vr ./* .old/ --exclude .old &&
awk '/!\[/{gsub(/<!--/,"{");gsub(/-->/,"}")};{gsub("<!--pagebreak-->","\\pagebreak")};{gsub("<!--newpage-->","\\newpage")};{gsub("<!--clearpage-->","\\clearpage")};{gsub("<!----------","---")};{gsub("---------->","...")};{print}' .old/ABWL-LEDER/README.md > ABWL-LEDER/README.md &&
awk '/!\[/{gsub(/<!--/,"{");gsub(/-->/,"}")};{gsub("<!--pagebreak-->","\\pagebreak")};{gsub("<!--newpage-->","\\newpage")};{gsub("<!--clearpage-->","\\clearpage")};{gsub("<!----------","---")};{gsub("---------->","...")};{print}' .old/ASM-GUENTHER/README.md > ASM-GUENTHER/README.md &&
awk '/!\[/{gsub(/<!--/,"{");gsub(/-->/,"}")};{gsub("<!--pagebreak-->","\\pagebreak")};{gsub("<!--newpage-->","\\newpage")};{gsub("<!--clearpage-->","\\clearpage")};{gsub("<!----------","---")};{gsub("---------->","...")};{print}' .old/DBS-DORENDORF/README.md > DBS-DORENDORF/README.md &&
awk '/!\[/{gsub(/<!--/,"{");gsub(/-->/,"}")};{gsub("<!--pagebreak-->","\\pagebreak")};{gsub("<!--newpage-->","\\newpage")};{gsub("<!--clearpage-->","\\clearpage")};{gsub("<!----------","---")};{gsub("---------->","...")};{print}' .old/PRO-KASCHE/README.md > PRO-KASCHE/README.md &&
awk '/!\[/{gsub(/<!--/,"{");gsub(/-->/,"}")};{gsub("<!--pagebreak-->","\\pagebreak")};{gsub("<!--newpage-->","\\newpage")};{gsub("<!--clearpage-->","\\clearpage")};{gsub("<!----------","---")};{gsub("---------->","...")};{print}' .old/SWE-KASCHE/README.md > SWE-KASCHE/README.md
- run: |
mkdir output
- uses: docker://rstropek/pandoc-latex:latest # generate ABWL-LEDER pdf
with:
args: --output=output/ABWL-LEDER.pdf --resource-path=ABWL-LEDER/ --template https://raw.githubusercontent.com/Wandmalfarbe/pandoc-latex-template/v1.4.0/eisvogel.tex --pdf-engine=xelatex --listings -f markdown+raw_tex --verbose ABWL-LEDER/README.md
- uses: docker://rstropek/pandoc-latex:latest # generate ASM-GUENTHER pdf
with:
args: --output=output/ASM-GUENTHER.pdf --resource-path=ASM-GUENTHER/ --template https://raw.githubusercontent.com/Wandmalfarbe/pandoc-latex-template/v1.4.0/eisvogel.tex --pdf-engine=xelatex --listings -f markdown+raw_tex --verbose ASM-GUENTHER/README.md
- uses: docker://rstropek/pandoc-latex:latest # generate DBS-DORENDORF pdf
with:
args: --output=output/DBS-DORENDORF.pdf --resource-path=DBS-DORENDORF/ --template https://raw.githubusercontent.com/Wandmalfarbe/pandoc-latex-template/v1.4.0/eisvogel.tex --pdf-engine=xelatex --listings -f markdown+raw_tex --verbose DBS-DORENDORF/README.md
- uses: docker://rstropek/pandoc-latex:latest # generate PRO-KASCHE pdf
with:
args: --output=output/PRO-KASCHE.pdf --resource-path=PRO-KASCHE/ --template https://raw.githubusercontent.com/Wandmalfarbe/pandoc-latex-template/v1.4.0/eisvogel.tex --pdf-engine=xelatex --listings -f markdown+raw_tex --verbose PRO-KASCHE/README.md
- uses: docker://rstropek/pandoc-latex:latest # generate SWE-KASCHE pdf
with:
args: --output=output/SWE-KASCHE.pdf --resource-path=SWE-KASCHE/ --template https://raw.githubusercontent.com/Wandmalfarbe/pandoc-latex-template/v1.4.0/eisvogel.tex --pdf-engine=xelatex --listings -f markdown+raw_tex --verbose SWE-KASCHE/README.md
- uses: actions/upload-artifact@master # upload pdfs as an artifact
with:
name: output
path: output
- uses: meeDamian/github-release@2.0 # create/override a release and attach a pdf
with:
token: ${{ secrets.ACCESS_TOKEN }}
tag: pdf-release
name: PDFs
body: Automated release
gzip: false
files: output/ABWL-LEDER.pdf
allow_override: true
- uses: meeDamian/github-release@2.0 # override release to attach another pdf
with:
token: ${{ secrets.ACCESS_TOKEN }}
tag: pdf-release
name: PDFs
body: Automated release
gzip: false
files: output/DBS-DORENDORF.pdf
allow_override: true
- uses: meeDamian/github-release@2.0 # override release to attach another pdf
with:
token: ${{ secrets.ACCESS_TOKEN }}
tag: pdf-release
name: PDFs
body: Automated release
gzip: false
files: output/ASM-GUENTHER.pdf
allow_override: true
- uses: meeDamian/github-release@2.0 # override release to attach another pdf
with:
token: ${{ secrets.ACCESS_TOKEN }}
tag: pdf-release
name: PDFs
body: Automated release
gzip: false
files: output/SWE-KASCHE.pdf
allow_override: true
14 changes: 14 additions & 0 deletions .github/workflows/toc.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
on: pull_request
name: TOC Generator
jobs:
generateTOC:
runs-on: ubuntu-latest
steps:
- uses: technote-space/toc-generator@v2.4.0
with:
GITHUB_TOKEN: ${{ secrets.ACCESS_TOKEN }}
TOC_TITLE: "**Inhaltsverzeichnis**"
# Git commit name.
COMMIT_NAME: "TOCGEN"
CREATE_PR: false
TARGET_PATHS: "./ABWL-LEDER/README.md, ./ASM-GUENTHER/README.md, ./DBS-DORENDORF/README.md, ./PRO-KASCHE/README.md, ./SWE-KASCHE/README.md"
47 changes: 47 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
# ignore everything by default #################################################

**

# root-level README ############################################################

!/README.md

# github workflows #############################################################

!/.github/
!/.github/workflows
!/.github/workflows/*.yml

# modul folders ################################################################

!/[A-Z]*[A-Z]-[A-Z]*[A-Z]/
!/[A-Z]*[A-Z]-[A-Z]*[A-Z]/README.md

# appendix folder ##############################################################

!/[A-Z]*[A-Z]-[A-Z]*[A-Z]/appendix
!/[A-Z]*[A-Z]-[A-Z]*[A-Z]/appendix/*.md
!/[A-Z]*[A-Z]-[A-Z]*[A-Z]/appendix/assets/
!/[A-Z]*[A-Z]-[A-Z]*[A-Z]/appendix/assets/*.svg
!/[A-Z]*[A-Z]-[A-Z]*[A-Z]/appendix/assets/*.png
!/[A-Z]*[A-Z]-[A-Z]*[A-Z]/appendix/assets/*.jpg

# assets folder ################################################################

!/[A-Z]*[A-Z]-[A-Z]*[A-Z]/assets
!/[A-Z]*[A-Z]-[A-Z]*[A-Z]/assets/*.svg
!/[A-Z]*[A-Z]-[A-Z]*[A-Z]/assets/*.png
!/[A-Z]*[A-Z]-[A-Z]*[A-Z]/assets/*.jpg

# extras folder ################################################################

!/[A-Z]*[A-Z]-[A-Z]*[A-Z]/extra
!/[A-Z]*[A-Z]-[A-Z]*[A-Z]/extra/**/
!/[A-Z]*[A-Z]-[A-Z]*[A-Z]/extra/**/*.md
!/[A-Z]*[A-Z]-[A-Z]*[A-Z]/extra/**/*.pdf
!/[A-Z]*[A-Z]-[A-Z]*[A-Z]/extra/**/*.svg
!/[A-Z]*[A-Z]-[A-Z]*[A-Z]/extra/**/*.png
!/[A-Z]*[A-Z]-[A-Z]*[A-Z]/extra/**/*.jpg

# just in case #################################################################
!.gitignore
9 changes: 9 additions & 0 deletions ABWL-LEDER/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
Allgemeine Betriebswirtschaftslehre
===================================

<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->

<!-- END doctoc generated TOC please keep comment here to allow auto update -->

<!--newpage-->
9 changes: 9 additions & 0 deletions ASM-GUENTHER/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
Rechnerarchitekturen/hardwarenahe Programmierung
================================================

<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->

<!-- END doctoc generated TOC please keep comment here to allow auto update -->

<!--newpage-->
9 changes: 9 additions & 0 deletions DBS-DORENDORF/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
Datenbanken
===========

<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->

<!-- END doctoc generated TOC please keep comment here to allow auto update -->

<!--newpage-->
9 changes: 9 additions & 0 deletions PRO-KASCHE/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
IT-Trends
=========

<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->

<!-- END doctoc generated TOC please keep comment here to allow auto update -->

<!--newpage-->
44 changes: 44 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
# DHGE - Praktische Informatik - Matrikel 19 - Semester 4

Dieses Repository ist ein Projekt von Studierenden des Studiengangs "Praktische Informatik" der Dualen Hochschule Gera-Eisenach. Hier werden alle Mitschriften der einzelnen Modulen gesammelt. Die Skripte liegen im `markdown`-Format vor. Zur besseren Handhabung (und weil Github nur begrenzte `markdown`-Features bereitstellt) werden diese zusätzlich automatisch in [PDFs](https://github.com/importPI19fromDHGE/dhge-pi19-sem4/releases) umgewandelt und zur Verfügung gestellt.

## Contributing

Alle Kommilitonen sind dazu eingeladen, ihre eigenen Beiträge zu diesem Projekt zu leisten und ihre Ideen einzubringen. Wenn du einen Beitrag leisten willst, kannst du wie folgt vorgehen:

1. Wenn du hier neu bist, erstelle auf jeden Fall ersteinmal [ein Issue](https://github.com/importPI19fromDHGE/dhge-pi19-sem4/issues/new). Dann können wir uns gerne über deine Idee austauschen.
2. Forke dieses Repository
3. `git clone <fork>` deine Fork und erstelle mit `git checkout -b <branchname>` eine neue Branch
4. Implementiere deine Idee. Bei Fragen kannst du dich gerne über das Issue an uns wenden.
5. Erstelle eine Pull Request, markiere dabei via @mention die Personen aus dem Issue und warte auf Feedback.

## Module

- [ABWL - Allgemeine Betriebswirtschaftslehre](./ABWL-LEDER)
- [DBS - Datenbanken](./DBS-DORENDORF)
- [ASM - Rechnerarchitekturen/hardwarenahe Programmierung](./ASM-GUENTHER)
- [SWE - Systemanalyse](./SWE-KASCHE)
- [PRO - IT-Trends](./PRO-KASCHE)

## Markdown-Erweiterungen

Alle Skripte in diesem Repository sind im `markdown`-Format verfasst. Für dieses existieren [viele verschiedene Standards](https://de.wikipedia.org/wiki/Markdown#Weiterentwicklungen,_Variationen_und_Erg%C3%A4nzungen). Auf Github selbst ist der Funktionsumfang von `markdown` im Vergleich zu anderen Standards deutlich eingeschränkt. Es ist beispielsweise nicht möglich die Größe von Bilder zu definieren, Metadaten für Dokumente anzugeben oder Mathematische Formel darzustellen. Aus diesem Grund wird [`pandoc`](https://pandoc.org/) verwendet, um `markdown`-Dateien mit vielen Funktionserweiterungen in PDFs umzuwandeln. Damit eine Kompatibilität zum Github-`markdown` haben wir eigene Erweiterungen definiert, die im Folgenden beschrieben werden:

### Bildgröße

```md
![Bildbeschreibung](img/a.png)<!--width=200px-->
![Bildbeschreibung](img/b.png)<!--height=200px-->
```

### Pagebreaks usw.

```md
<!--pagebreak-->
<!--newpage-->
<!--clearpage-->
```

### Mathematische Formel

Github unterstützt keine mathematischen Formeln. Als Workaround gibt es eine [Erweiterung für Chrome](https://github.com/orsharir/github-mathjax). Ansonsten können Formeln in ihrer vollen Pracht nur in den PDFs betrachtet werden.
9 changes: 9 additions & 0 deletions SWE-KASCHE/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
Systemanalyse
=============

<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->

<!-- END doctoc generated TOC please keep comment here to allow auto update -->

<!--newpage-->

0 comments on commit e78ab48

Please sign in to comment.