Docusaurus
Ersetzt das alte MediaWiki
Installation
Linux
apt install npm nodejs
Erstellen
Nachfolgender Befehl erstellt eine neue Website im klassichen Design
npm init docusaurus@latest my-website classic
Aktualisieren
Nach dem Erstellen wird die Datei my-website/package.json und my-website/package-lock.json erstellt. Erstere definiert die Pakete und die minimal bzw. maximal Version jedes Pakets, letztere hingegen definiert die verwendeten Pakete mit einer spezifischen Version. Es ist ratsam die verwendeten Pakete von Zeit zu Zeit zu aktualisieren.
cd my-website
npm update
added 4 packages, removed 4 packages, changed 25 packages, and audited 1123 packages in 1m
205 packages are looking for funding
run `npm fund` for details
23 vulnerabilities (4 moderate, 19 high)
To address issues that do not require attention, run:
npm audit fix
To address all issues possible (including breaking changes), run:
npm audit fix --force
Some issues need review, and may require choosing
a different dependency.
Run `npm audit` for details.
Plugins
Suchen
Um das Wiki zu durchsuchen muss ein Plugin installiert werden.
Für eine lokale Suche, ohne externe Abhängigkeiten, wird für dieses Wiki docusaurus-search-local von cmfcmf verwendet.
Dieses Plugin muss einmalig mit folgendem Befehl installiert werden und wird so zum my-website/package.json hinzugefügt.
npm install @cmfcmf/docusaurus-search-local
Die Konfiguration kann wie folgt aussehen
plugins: [
[
require.resolve("@cmfcmf/docusaurus-search-local"),
{
indexBlog: false,
},
],
],
Starten
Development
Die Website wird automatisch bei jedem Speichern der überwachten Dateien im Ordner my-website neu gebaut und neu geladen. Unter Umständen muss das Limit für die zu überwachenden Dateien angepasst werden, siehe Linux File Watcher.
cd my-website
npm run start
Veröffentlichen
Die Website muss zum Veröffentlichen einmal statisch gebaut werden. Anschließend befinden sich alle Dateien, Seiten und Scripte im Ordner build
cd wiki
npm install
npm run build
Style
Eine Notiz auf grauem Grund
Ein Tip auf grünem Grund
Eine Info auf blauem Grund
Ein Hinweis auf orangem Grund
Eine Warnung auf rotem Grund