diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml index 3b387c0..ae5bee8 100644 --- a/.github/workflows/deploy.yml +++ b/.github/workflows/deploy.yml @@ -12,7 +12,7 @@ jobs: - uses: actions/setup-node@v3 with: node-version: '20' - - run: npm ci --ignore-scripts + - run: npm ci - run: npm run build-docs - name: Deploy to GitHub Pages uses: peaceiris/actions-gh-pages@v3 diff --git a/docs/__buffer.md b/docs/__buffer.md index abe4bb6..883c633 100644 --- a/docs/__buffer.md +++ b/docs/__buffer.md @@ -14,6 +14,10 @@ - TEMPLATE.md nettoye; dossier site retire de la doc. - docsDir mis a jour pour ne compiler que le dossier docs. - log.md renomme en docs/__buffer.md; config et docs actualises. +- DevDependency vite fixe a 4.4.9, CI utilise `npm ci`, + tentative `npm install` echouee faute de reseau. +- Ajout d'un fichier `vitedoc.md` pour expliquer la generation de la doc. +- Ajout de `vitedoc` dans package.json et scripts mis a jour. - Workflow test ajoute pour npm ci et npm test sur PR. - Ajout du fichier .nvmrc pour Node 20. - Champ engines ajoute dans package.json. diff --git a/docs/index.md b/docs/index.md index d5b1dbe..63dbd08 100644 --- a/docs/index.md +++ b/docs/index.md @@ -5,6 +5,7 @@ du projet et les règles que l'agent doit suivre. - [Init du Template](./init.md) - [Knowledge Ethics](./knowledge-ethics.md) +- [ViteDoc](./vitedoc.md) - [Roadmap](./roadmap.md) Le site GitHub Pages du projet affiche cette page d'accueil. diff --git a/docs/vitedoc.md b/docs/vitedoc.md new file mode 100644 index 0000000..c93bb4b --- /dev/null +++ b/docs/vitedoc.md @@ -0,0 +1,20 @@ + +# ViteDoc + +Ce projet utilise **ViteDoc** pour generer la documentation statique. + +## Commandes +- `npm run dev-docs` — lance un serveur local avec rechargement automatique. +- `npm run build-docs` — genere le site dans `dist/`. + +## Installation + +```bash +npm install vitedoc --save-dev +``` + +## Fonctionnalites principales + +- Support Markdown et apercu interactif de composants +- HMR via Vite +- Generation de site statique personnalise diff --git a/package.json b/package.json index 33413b2..970a7fb 100644 --- a/package.json +++ b/package.json @@ -4,13 +4,14 @@ "description": "Ce dépôt sert de champ d'entraînement pour un agent IA autonome. Clones-le, lance l'agent, puis laisse-le évoluer.", "type": "module", "scripts": { - "dev-docs": "vite --config docs/vitedoc.config.js", - "build-docs": "vite build --config docs/vitedoc.config.js", + "dev-docs": "vitedoc dev --config docs/vitedoc.config.js", + "build-docs": "vitedoc build --config docs/vitedoc.config.js", "test": "vitest", "test:e2e": "vitest run tests" }, "devDependencies": { - "vite": "latest", + "vitedoc": "1.0.0", + "vite": "4.4.9", "vitest": "^1.0.0" }, "template": true,