Erste Schritte

Squidoc ist eine statische Dokumentationsplattform mit Plugins, Themes und SEO-freundlichen Voreinstellungen. Schreibe Markdown, konfiguriere dein Projekt in docs.config.ts und veroeffentliche ein schnelles statisches Docs-Site.

Projektstruktur

Dokumente liegen in docs/, optionale Astro-Seiten in pages/, und docs.config.ts verbindet Website-Metadaten, Navigation, Plugins und Theme.

Erweitern

Plugins fuegen Verhalten wie Suche, SEO, Codebloecke, Versionierung, Internationalisierung und generierte Dateien hinzu. Themes steuern Layout, Navigation und Slots.

Verifizieren

Nutze npm run check, npm run build und npm run preview, bevor du deployest.

Erste Schritte

Diese Seite folgt der englischen Dokumentation, damit alle unterstuetzten Sprachen dieselbe Abdeckung fuer die aktuelle Version haben.

Konfiguration · Plugins · Themes · Deployment

Referenzbeispiele

npm create squidoc@latest my-docs
cd my-docs
npm run dev

---
title: API Guide
description: Learn how to use the API.
---

# API Guide

Write your documentation here.

nav: [
  { title: "Getting Started", path: "/getting-started" },
  { title: "API Guide", path: "/api-guide" },
];

npm run check
npm run build
npm run preview