From 55440a1f26f491346f45d3eba1fc172e5a73bf18 Mon Sep 17 00:00:00 2001 From: Robert Jelic Date: Sun, 9 Feb 2025 16:01:32 +0100 Subject: [PATCH] config.ld --- config.ld | 48 ++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 48 insertions(+) create mode 100644 config.ld diff --git a/config.ld b/config.ld new file mode 100644 index 0000000..9673a7a --- /dev/null +++ b/config.ld @@ -0,0 +1,48 @@ +-- Projektname, erscheint in der Dokumentation als Titel +project = "Basalt2" + +-- Der Haupttitel der Dokumentation +title = "Basalt2 Documentation" + +-- Beschreibung des Projekts +description = "A powerful UI Framework for ComputerCraft" + +-- Ausgabeverzeichnis für die generierte Dokumentation +dir = "docs" + +-- Stil der Dokumentation (!pale, !minimal, etc.) +style = "!pale" + +-- Ausgabeformat (markdown oder html) +format = "markdown" + +-- Wo nach Lua-Dateien gesucht werden soll +file = "src" + +-- Auch private Funktionen dokumentieren +all = true + +-- Vorlagen für fehlende Dokumentation generieren +template = true + +-- Quellcode in der Dokumentation anzeigen +pretty = true + +-- Zusätzliche README-Dateien einbinden +topics = {"README.md"} + +-- Eigene Sections für die Dokumentation definieren +sections = { + "Classes", + "Methods", + "Events" +} + +-- Ignoriere bestimmte Dateien/Ordner +ignore = { + "src/tests", + "src/examples" +} + +-- Custom Tags definieren +new_type("event", "Events", false, "param")