Instalación
Añade la capa, extiéndela, escribe Markdown.
Añadir la dependencia
pnpm add -D @kirchdev/duxtExtender la capa
export default defineNuxtConfig({
extends: ['@kirchdev/duxt']
});
Escribir tu documentación
El Markdown va en docs/, en la raíz de tu repositorio — resuelto contra el
repositorio y no contra el directorio donde se ejecuta el sitio, de modo que un
sitio en una subcarpeta lo encuentra. Un archivo es una página, una carpeta es
una sección, y el frontmatter lleva el título, la descripción y el icono.
- docs
- index.md
- 1.getting-started
- index.md
- 1.installation.md
- 2.guides
- 1.deploying.md
- nuxt.config.ts
---
title: Introducción
description: Qué es este proyecto.
icon: lucide:rocket
---
Tu primera página.
Un prefijo numérico ordena el árbol y se elimina de la URL:
1.getting-started/ se sirve en /getting-started. Reordenar una sección nunca
mueve una URL — solo renombrar la parte posterior al punto lo hace.
El title de la página se representa como el <h1>. Un encabezado propio al
principio del archivo sería el segundo de la página.
Qué necesita la compilación
- Node 24. La capa lee su base de datos mediante
node:sqlite, así que no se instala ni hace falta ningún controlador nativo de SQLite. - Acceso de red a tus fuentes, si alguna es otro repositorio, y un token
para las privadas — Content lo lee del
authde la colección.
Qué viene incluido
El paquete trae un comando, duxt-report, y extender la capa es todo lo que
hace falta para tenerlo:
pnpm exec duxt-report # en qué se convirtieron tus fuentes, como Markdown
pnpm exec duxt-report --json # lo mismo, sin representar
Imprime las colecciones resueltas, todo lo que comprueba la compilación y las redirecciones que declaran las páginas — sin servidor de desarrollo, así que se ejecuta en CI y en una tubería. Véase Qué comprueba la compilación.
Resultado
nuxt dev sirve el sitio. Todo lo que dibuja el tema son datos con un valor por
defecto, así que el siguiente paso es el único archivo que lo sobrescribe:
Configuración.