{"schemaVersion":1,"title":"Bien démarrer avec Docsy","url":"https://appgram.github.io/docsy/versions/current/fr/guides/getting-started","markdownUrl":"https://appgram.github.io/docsy/format-md/versions/current/fr/guides/getting-started","jsonUrl":"https://appgram.github.io/docsy/agent/pages/versions/current/fr/guides/getting-started.json","version":"current","locale":"fr","markdown":"# Bien démarrer avec Docsy\n\nCréez un portail pour les humains et les agents, générez un projet et prenez le contrôle de son code.\n\nWritten by: [nedimf](https://github.com/nedimf), [AppGram](https://appgram.dev)\n\nDocsy est un outil de documentation pour les humains et les agents de code. Vos lecteurs consultent des guides et des références API ou SDK dans un portail de documentation. Vos agents peuvent lire le même contenu en Markdown et vous aider à maintenir les articles, la configuration YAML et l’interface Astro.\n\n> Testez les deux sélecteurs\n>\n> Vous consultez la version française du guide actuel. Choisissez **Preview (demo)** pour ouvrir un article différent, puis **English** pour changer de langue sans quitter cette page.\n\n## Lancer ce portail\n\nUtilisez Node 22.22 ou une version plus récente, puis clonez le dépôt :\n\n```bash\ngit clone https://github.com/AppGram/docsy.git\ncd docsy\nnpm ci\nnpm run dev\n```\n\nOuvrez `http://localhost:4321/docsy/`. Le contenu des articles, l’interface et la configuration appartiennent à votre dépôt.\n\n## Générer un projet indépendant\n\nLa commande suivante crée un projet Astro modifiable avec le guide de démarrage et l’interface par défaut :\n\n```bash\nnpm run create -- ../acme-docs \\\n  --name \"Acme API\" \\\n  --base /docs\n```\n\nPour ajouter une référence API générée, fournissez aussi votre source OpenAPI :\n\n```bash\nnpm run create -- ../acme-docs \\\n  --name \"Acme API\" \\\n  --openapi https://api.example.com/openapi.json \\\n  --api-base https://api.example.com \\\n  --base /docs\n```\n\n## Organiser le contenu\n\n| Emplacement | Rôle |\n| --- | --- |\n| `docsy.config.yaml` | Identité, navigation, articles, sources, langues, versions et permissions |\n| `content/` et `sources/` | Articles Markdown et métadonnées API ou SDK |\n| `src/` | Interface Astro et styles que vous pouvez modifier |\n\nGardez les réglages dans YAML et les explications dans Markdown. Modifiez Astro ou CSS lorsque vous souhaitez changer l’interface elle-même. Votre agent de code peut travailler dans ces mêmes fichiers, avec `AGENTS.md` et `DOCSY_BRIEF.md` comme instructions.\n\n## Valider et publier\n\n```bash\nnpm run validate\nnpm run build\n```\n\nLe mode ouvert avec `agent.query: false` produit un site statique adapté à GitHub Pages. Le mode verrouillé ou `agent.query: true` nécessite le serveur Node pour vérifier les permissions ou exécuter des recherches à chaque requête.\n\n> Ne publiez pas vos secrets\n>\n> Les exemples et les articles d’un site statique sont publics. Gardez vos jetons privés dans l’environnement du serveur, jamais dans un fichier Markdown ou YAML publié.\n\n## Tester les traductions et le repli\n\nLes pages **Bien démarrer**, **Articles enrichis** et **Versions et langues** ont une traduction française. Ouvrez **Configuration YAML** pour voir le repli vers l’anglais : la navigation reste en français, mais un message précise que le corps de l’article est en anglais.\n\nLa recherche respecte la langue et la version sélectionnées. Essayez **encadrés** sur la page des articles enrichis.\n\n","contentLocale":"fr","isFallback":false,"authorship":{"authors":[{"name":"nedimf","kind":"human","github":"nedimf","avatar":"/docsy/assets/authors/nedimf.png","role":"AppGram","id":"nedimf","url":"https://github.com/nedimf"},{"name":"AppGram","kind":"organization","github":"AppGram","url":"https://appgram.dev","avatar":"/docsy/assets/ag-logo.svg","id":"appgram"}],"contributors":[],"reviewedBy":[]},"editUrl":"https://github.com/AppGram/docsy/edit/main/content/fr/getting-started.md"}