Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 4 additions & 0 deletions docs/__buffer.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
1 change: 1 addition & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
20 changes: 20 additions & 0 deletions docs/vitedoc.md
Original file line number Diff line number Diff line change
@@ -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
7 changes: 4 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down
Loading