Zum Inhalt springen
duxt

Installation

Ebene einbinden, erweitern, Markdown schreiben.

Abhängigkeit hinzufügen

pnpm add -D @kirchdev/duxt

Ebene erweitern

export default defineNuxtConfig({
  extends: ['@kirchdev/duxt']
});

Dokumentation schreiben

Markdown liegt in docs/ im Wurzelverzeichnis deines Repositories — aufgelöst gegen das Repository, nicht gegen das Verzeichnis, in dem die Seite läuft, damit eine Seite in einem Unterordner sie findet. Eine Datei wird zur Seite, ein Ordner zur Sektion, und das Frontmatter trägt Titel, Beschreibung und Icon.

dein-projekt/
  • docs
  • index.md
  • 1.getting-started
  • index.md
  • 1.installation.md
  • 2.guides
  • 1.deploying.md
  • nuxt.config.ts
---
title: Einführung
description: Was dieses Projekt ist.
icon: lucide:rocket
---

Deine erste Seite.

Ein numerisches Präfix ordnet den Baum und wird aus der URL entfernt: 1.getting-started/ wird unter /getting-started ausgeliefert. Eine Sektion umzusortieren verschiebt deshalb nie eine URL — nur den Teil nach dem Punkt umzubenennen tut das.

Was der Build braucht

  • Node 24. Die Ebene liest ihre Datenbank über node:sqlite, ein nativer SQLite-Treiber wird also weder installiert noch gebraucht.
  • Netzzugang zu deinen Quellen, falls eine davon ein anderes Repository ist, und ein Token für die privaten — Content liest ihn aus dem auth der Collection.

Was mitkommt

Das Paket bringt einen Befehl mit, duxt-report, und die Ebene zu erweitern ist alles, was es dafür braucht:

pnpm exec duxt-report            # was aus deinen Quellen wurde, als Markdown
pnpm exec duxt-report --json     # dasselbe, ungerendert

Er gibt die aufgelösten Collections aus, alles, was der Build prüft, und die Weiterleitungen, die die Seiten deklarieren — kein Dev-Server, er läuft also in CI und in einer Pipe. Siehe Was der Build prüft.

Ergebnis

nuxt dev liefert die Seite aus. Alles, was das Theme zeichnet, sind Daten mit einem Standardwert — der nächste Schritt ist deshalb die eine Datei, die ihn überschreibt: Konfiguration.

War diese Seite hilfreich?