ENFR0.1.0-rc.3

Votre premier site

D’un dossier vide à un site de documentation construit.


Votre premier site
0:00 / 0:28
  1. Installer la CLI

    Lancez la commande d’installation dans le dossier du projet.

    terminal
    npm install --save-dev @specistry/cli
  2. Créer la configuration

    Ajoutez specistry.config.ts à la racine. Deux champs sont obligatoires : schemaVersion et name.

    specistry.config.ts
    import { defineConfig } from "@specistry/config";
    
    export default defineConfig({
      schemaVersion: 1,
      name: "Docs Acme",
    });
  3. Écrire la première page

    docs/index.md devient la page d’accueil. Chaque page commence par un frontmatter avec un title.

    docs/index.md
    ---
    title: Documentation développeur Acme
    description: Tout ce qu’il faut pour intégrer notre API.
    ---
    
    Bienvenue. Commencez par le démarrage rapide.
  4. Valider puis construire

    La validation n’écrit rien. Le build écrit un artefact complet dans .specistry/artifacts — ou rien du tout en cas d’erreur.

    terminal
    npx specistry validate
    npx specistry build

AstuceEt ensuite ?

Ajoutez des pages et une barre latérale dans le tutoriel suivant, ou branchez directement votre contrat OpenAPI.

Signaler un problème sur cette page (GitHub)