Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
bodobraegger committed Sep 3, 2023
1 parent 6d93bda commit f730526
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,5 +56,26 @@ Schaue dir die Issues an oder erstelle ein Neues.
Wir freuen uns über jeden PR.
Bei Fragen kannst du dich an die Betreuungskommission (inhaltlich) oder die IT Kommission (technisch) wenden.

### Content Creation
Der Inhalt für dieses Frontend wird mittels Markdown und HTML erstellt. Zur Zeit
werden JSON Dateien angelegt mittels Strapi die Markdown enthalten.

#### Anleitungen und Cheat Sheets für Markdown:
Die grundlegende Markdown Syntax, die in diesem Projekt unterstützt wird, findet
Ihr auf folgenden Seiten:
- https://remarkjs.github.io/react-markdown/
- https://commonmark.org/help/
- https://github.com/remarkjs/remark-gfm#use
#### Projektspezifisches Markdown:
Die Bildgestaltung und die Bildunterschrift können über das Alt-Attribut eines Bildes spezifiziert werden, wie folgt:
```md
[caption: test-image; width: 150px; height: 150px;](location/of/test-image.jpg)
```
Alle möglichen HTML Einheiten funktionieren für die width- und height-Tags (und es können auch andere gültige CSS-Stiltags verwendet werden).

Des weiteren werden auch HTML tags akzeptiert. Dies erfordet mehr Hintergrund-
wissen und erfordert vertraulichen Zugang zum Backend, da dieses Feature
missbraucht werden könnte.

## Production
The frontend is deployed to GitHub pages.

0 comments on commit f730526

Please sign in to comment.