Mitmachen

Wer hier im Wiki mitmachen möchte, sollte sich hier umschauen, um alles richtig zu machen.

Sobald das Git-Repo dieses Wikis online ist, wird jeder in der Lage sein, Inhalte hinzuzufügen oder Fehler zu korrigieren. Ob und in welchen Fällen ich Pull Requests annehme, das werde ich in Zunkft noch beschreiben.

Eine neue Seite im Wiki erstellen

hinweis
Neue Hauptbereiche (oberste Ebene) bitte nur mit vorheriger Absprache erstellen.

Mindestanforderungen für eine neue Seite

Eine neue Seite im Wiki enthält mindestens:

  • Angaben im Front Matter (siehe hier).
    • Einen aussagekräftigen Titel.
    • Passende Tags (an den vorhandenen Tags orientieren und nur wenig neue Tags erstellen).
    • Eine Beschreibung mit maximal ~200 Zeichen (siehe hier).
  • Seitenbild (siehe hier).

Front Matter

Als Vorlage kann man dieses Front Matter benutzen:

---
title: Title
linkTitle: linkTitle
toc_hide: false
tags:
- tag1
- tag2 mit leerzeichen
- tag3
description: Beschreibung lala plum
---

Titel (Title)

Der Titel einer Seite.

LinkTitel (linkTitle)

Der Titel, wie er innerhalb der Seitenliste (Sidebar links) angezeigt wird. Dieser Wer ist optional.

Nützlich, wenn der Titel sehr lang ist, man aber eine Kurzversion in der Seitenliste haben möchte.

Zum Beispiel verwende ich das in diesem Bereich, um auf der Seite selbst den Kontext zum Minimalismus herzustellen, in der Seitenliste in der Sidebar aber das Wort Minimalismus weglassen zu können, da es sich aus der Hierarchie ergibt:

title: Minimalismus und Hygiene
linkTitle: Hygiene

Man kann eine Seite von der Suche ausschließen lassen. (Das funktioniert vermutlich nur mit der Defaultsuche von Docsy, hier im Wiki wird jedoch FuseJS verwendet.)

exclude_search: true

toc_hide

Wird dieser Parameter auf true gesetzt, dann wird die Seite nicht in der Seitenliste in der linken Sidebar angezeigt.

So wird z. B. der gesamte Bereich /ueber auf diese Weise “versteckt” und taucht nicht links in der Seitenliste in der Sidebar auf.

Beschreibung

Man kann und sollte je Seite oder Seitenbereich (_index.md) im Front Matter eine Beschreibung einfügen:

description: Beschreibung

Diese Beschreibung wird auch in den Seitenlisten angezeigt und auf der Seite selbst oberhalb der Tags.

Man kann diese auch mit einfachen oder doppelten Anführungszeichen umschließen, je nachdem, ob darin bereits Anführungszeichen verwendet werden.

warnung
Es ist zwar möglich, Shortcodes in der Beschreibung zu verwenden und diese werden auf der Seite im Wiki auch gerendert. In den Metadaten für Open Graph und Twitter Cards landet jedoch der Quelltext statt der gerenderten Variante. Daher sollte die Beschreibung nur Text enthalten.

Seitenbild

Am besten ist es, wenn man in einer Seite oder einem Seitenbereich (_index.md) eine Datei mit dem Substring cover, feature oder thumbnail im Namen hinterlegt. Diese wird dann automatisch als Bild für Twitter Cards und Open Graph verwendet.

Zusätzlich dieses Bild bitte irgendwo passend mit dem Shortcode figure einfügen.

Es sollte maximal 600 Pixel breit sein, da es sehr oft und schnell nacheinander nach einer Veröffentlichung z. B. bei Mastodon abgerufen werden wird.

Seite(n) verschieben

Verschiebt man (nur aus guten Gründen) eine Seite innerhalb des Wikis, dann muss im Front Matter der Parameter aliases: hinzugefügt werden mit dem alten Standort der Seite.

Beispielsweise hatte ich mal diese Anweisungen hier verschoben von /docs/ueber/format/ nach /docs/ueber/mitarbeit/. Der richtige Alias-Eintrag war deshalb:

aliases:
  - /docs/ueber/format/
hinweis
Der Alias-Eintrag bewirkt, dass an der alten URL eine HTML-Datei erzeugt wird, die nur eine Weiterleitung per HTTP Status Code 301 (“Moved permanently”) enthält und auf die neue URL zeigt.

Verschiebt man einen Seitenbereich mit Unterseiten, so muss ein Alias in jeder einzelnen Unterseite entsprechend angepasst eingetragen werden.

Benennt man eine einzelne Seite nur um, dann reicht es aus, den Namen der alten Datei in Aliases einzutragen. Hieß die alte Seite z. B. ohne_kuehlschrank_leben.md und benennt man diese um in kuehlschrank.md, dann ist der passende Eintrag in Aliases:

aliases:
  - ohne_kuehlschrank_leben

Dinge, die im Blog und Wiki gleichermaßen gelten

Dinge, die für Wiki und Blog gleich sind, habe ich nur im Blog beschrieben. Siehe hier

Zuletzt geändert 2022-06-21 22:36:18 +0200 CEST durch Natenom (fix, 430cdb4)