README: format markdown with backticks, update setup instructions

NOTE: `bundle install --path` is deprecated.
This commit is contained in:
Daniel Maslowski 2024-12-11 20:03:45 +01:00
parent ad52369341
commit f7a2458e05

View File

@ -10,23 +10,28 @@ jekyll + bootstrap
Für die Seite benötigt ihr Ruby 2.7.0
<pre><code>---
```
rbenv install 2.7.0
rbenv local 2.7.0
bundle install --path=vendor/cache
---</code></pre>
bundle config set --local path 'vendor/cache'
bundle install
```
## Blogeinträge
### Text
Blogeinträge werden in dem Verzeichnis „\_posts“ abgelegt. Um einen Blogeintrag zu verfassen legt man eine Datei mit dem Schema „Jahr-MM-TT-Titel.markdown“ an. Der Blogeintrag beginnt mit folgenden Metadaten:
<pre><code>---
Blogeinträge werden in dem Verzeichnis `_posts` abgelegt.
Um einen Blogeintrag zu verfassen legt man eine Datei mit dem Schema `Jahr-MM-TT-Titel.markdown` an.
Der Blogeintrag beginnt mit folgenden Metadaten:
```
layout: post
title: "Neues Update für DocPatch"
date: 2015-05-23 13:37:00
categories: docpatch
---</code></pre>
```
Damit wird der Titel des Blogeintrags, das Datum der Veröffentlichung und die Kategorie (optional) festgelegt.
#### Troobleshooting fürs NOC
@ -35,29 +40,37 @@ Sollte der Blogeintrag nicht in den nächsten Minuten auf der Webseite erscheine
### Bilder
Bilder für Blogeinträge werden unterhalb von Media in einem eigenen Verzeichnis (Jahr-MM-TT) abgelegt.
<pre><code>~/site/media/jahr-mm-tt
</code></pre>
Bilder für Blogeinträge werden unterhalb von Media in einem eigenen Verzeichnis (Jahr-MM-TT) abgelegt: `~/site/media/jahr-mm-tt`
Als erstes sollte man die Exif-Daten (z.B. Geoinformation) der Bilder entfernen. Dabei wird auch die „Rotation“ des Bildes entfernt.
<pre><code>exiftool -all= $Bild
</code></pre>
```
exiftool -all= $Bild
```
Ggf. muss das Bild gedreht werden, wenn es ohne die Metatags auf dem Kopf steht oder auf der Seite liegt.
<pre><code>convert -rotate 90 $Bild $Bild_out.jpg</code></pre>
```
convert -rotate 90 $Bild $Bild_out.jpg
```
Der vorletzte Schritt setzt die Bilder auf eine einheitliche Breite.
<pre><code>mogrify -resize "1140>" $Bild
</code></pre>
```
mogrify -resize "1140>" $Bild
```
Viele Bilder können noch optimiert werden, damit der benötige Speicherplatz und die zu übertragende Datenmenge reduziert wird.
<pre><code>jpegoptim -m 80 %Bild.jpg</code></pre>
Wenn das Bild in der korrekten Größe und Ausrichtung vorliegt, kann es wie Folgt eingebunden werden.
<pre><code>![Quelle: Chaospott]({{ site.url }}/media/Jahr-MM-TT/$Bild.jpg)
</code></pre>
```
jpegoptim -m 80 %Bild.jpg
```
Wenn das Bild in der korrekten Größe und Ausrichtung vorliegt, kann es wie folgt eingebunden werden:
```
![Quelle: Chaospott]({{ site.url }}/media/Jahr-MM-TT/$Bild.jpg)
```
### Web Key Directory (GPG/PGP-Keys zur Suche ablegen)
@ -66,7 +79,7 @@ Um, neben [keys.openpgp.org](https://keys.openpgp.org/), den eigenen Chaospott-G
1. Clone das Repo.
2. Im Repo geh in den Ordner `.well-known/openpgpkey/hu`.
2. Im Repo geh in den Ordner `.well-known/openpgpkey/hu`.
3. Folgendes Skript exportiert deinen öffentlichen Schlüssel in eine Datei, die den Namen deines WKD-Hashes trägt. Dieses wird zur Suche nach deinem GPG-Key benutzt.