Bien démarrer

Squidoc est une plateforme de documentation statique avec plugins, thèmes et réglages SEO par défaut. Écrivez du Markdown, configurez docs.config.ts, puis publiez un site rapide et statique.

Structure du projet

Les articles vivent dans docs/, les pages Astro facultatives dans pages/, et docs.config.ts relie les métadonnées, la navigation, les plugins et le thème.

Extension

Les plugins ajoutent recherche, SEO, blocs de code, versionnement, internationalisation et fichiers générés. Les thèmes contrôlent les layouts, la navigation et les slots.

Vérification

Exécutez npm run check, npm run build et npm run preview avant le déploiement.

Bien démarrer

Cette page suit la documentation anglaise afin que chaque langue prise en charge garde la même couverture pour la version actuelle.

Configuration · Plugins · Thèmes · Déploiement

Exemples de référence

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