Docusaurus#

Docusaurus ist eine Software, um einfach statische Webseiten aus simplen markdown-Dateien zu erstellen. Es arbeitet dabei wie eine Art sehr ausgefeilter Template-Generator.

Es basiert auf React und Node.js, ist also in Javascript bzw. Typescript geschrieben.

Es eignet sich insbesondere für Dokumentationen, weil es zu einem Verzeichnisbaum mit Kapiteln (als markdown-Dateien) automatisch eine Baumstruktur, ein Inhaltsverzeichnis, eine Suche, etc. generieren kann. Man kann Docusaurus als Server laufen lassen, dann werden die Webseiten live erzeugt. Änderungen am Quelltext werden also augenblicklich umgesetzt. Man kann aber auch eine statische Version der Webseite erzeugen, die man dann irgendwo in einen Webspace kopiert und dort ohne weitere Bibliotheken oder Serverbedingungen veröffentlichen kann.

Installation#

Tatsächlich habe ich eine Weile gebraucht, um zu verstehen, wie einfach das wirklich ist. ;-) Das liegt vielleicht auch daran, das meine Erfahrung mit Javascript, Node.js und npm gleich Null ist. Was aber ja schön ist, das hier zu dokumentieren, das man solche Erfahrung auch nicht braucht.

Ich musste zwei Debian-Pakete installieren: