Skip to content

Commit 9396d80

Browse files
Documentation edits made through Mintlify web editor
1 parent 9f9e9aa commit 9396d80

File tree

2 files changed

+180
-1
lines changed

2 files changed

+180
-1
lines changed

fr/quickstart.mdx

Lines changed: 178 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,178 @@
1+
---
2+
title: "Démarrage Rapide"
3+
description: "Commencez à construire une documentation moderne en moins de cinq minutes"
4+
icon: "rocket"
5+
---
6+
7+
<Frame>
8+
<img
9+
className="block dark:hidden"
10+
src="https://mintlify-assets.b-cdn.net/hero-light.png"
11+
/>
12+
<img
13+
className="hidden dark:block"
14+
src="https://mintlify-assets.b-cdn.net/hero-dark.png"
15+
/>
16+
</Frame>
17+
18+
## Pour Commencer
19+
20+
Bienvenue ! Suivez les instructions ci-dessous pour apprendre à déployer, mettre à jour et améliorer votre documentation avec Mintlify.
21+
22+
### Création du Dépôt
23+
24+
Les documents Mintlify sont générés à partir de fichiers MDX et de configurations définis dans notre [kit de démarrage](https://github.com/mintlify/starter). Nous utilisons GitHub pour intégrer votre documentation avec votre code et faciliter le contrôle des sources. Commencez via le [tableau de bord](https://dashboard.mintlify.com) ou clonez notre [kit de démarrage](https://github.com/mintlify/starter) pour débuter.
25+
26+
<AccordionGroup>
27+
28+
<Accordion icon="message-bot" title="Installer l'application GitHub">
29+
30+
Installez notre application GitHub pour garantir que vos mises à jour sont automatiquement déployées lorsque vous poussez des changements. Vous trouverez le lien d'installation dans le [tableau de bord](https://dashboard.mintlify.com/settings), sur la page Paramètres. Après une installation réussie, une coche apparaîtra à côté du hash du commit du dépôt.
31+
32+
<Frame>
33+
![GitHub Bot Verification](https://mintlify.s3-us-west-1.amazonaws.com/mintlify/images/github-bot-verification.png)
34+
</Frame>
35+
36+
</Accordion>
37+
38+
<Accordion icon="code-branch" title="Configuration Monorepo">
39+
Si vous souhaitez que votre documentation vive aux côtés de votre code en tant que configuration monorepo, vous pouvez :
40+
1. Déplacer le contenu de votre documentation dans votre monorepo.
41+
2. Spécifier le chemin vers votre `mint.json` dans le [tableau de bord](https://dashboard.mintlify.com/settings/deployment/git-settings)
42+
43+
<Frame>
44+
<img
45+
alt="Configuration monorepo"
46+
className="block dark:hidden"
47+
src="/images/monorepo-light.png"
48+
/>
49+
<img
50+
alt="Configuration monorepo"
51+
className="hidden dark:block"
52+
src="/images/monorepo-dark.png"
53+
/>
54+
</Frame>
55+
</Accordion>
56+
57+
</AccordionGroup>
58+
59+
### Mise à Jour du Contenu
60+
61+
Mintlify vous permet de personnaliser facilement le style, la structure et le contenu de votre documentation.
62+
63+
<AccordionGroup>
64+
<Accordion icon="rectangle-terminal" title="Édition en local (recommandé pour les développeurs)">
65+
66+
1. Installez [git](https://git-scm.com/book/fr/v2/Démarrage-rapide-Installation-de-Git).
67+
2. Une fois git installé, clonez votre dépôt de documentation en utilisant `git clone <votre-depot>`. Si vous ne l'avez pas encore configuré, c'est le bon moment pour le faire avec ces [clés SSH](https://docs.github.com/fr/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent).
68+
3. Utilisez votre IDE préféré pour ouvrir le dépôt.
69+
4. Installez notre CLI Mintlify pour prévisualiser les changements avec `npm i -g mintlify`.
70+
71+
En savoir plus dans notre [guide de développement local](/development).
72+
73+
</Accordion>
74+
75+
<Accordion icon="pen-to-square" title="Édition avec l'éditeur web">
76+
77+
Apprenez à utiliser l'éditeur web dans notre [guide](/web-editor).
78+
79+
</Accordion>
80+
81+
<Accordion icon="palette" title="Personnalisation selon votre marque">
82+
83+
Personnalisez facilement les couleurs, logos et boutons parmi d'autres configurations dans notre fichier `mint.json`. Commencez par ces configurations de base :
84+
85+
```json
86+
"name": "Votre Entreprise"
87+
"logo": {
88+
"light": "/logo/light.svg",
89+
"dark": "/logo/dark.svg",
90+
"href": "https://votreentreprise.com"
91+
},
92+
"favicon": "/favicon.svg",
93+
"colors": {
94+
"primary": "#2AB673",
95+
"light": "#55D799",
96+
"dark": "#117866",
97+
},
98+
```
99+
100+
Une liste complète des configurations prises en charge se trouve dans les [paramètres globaux](/settings/global).
101+
102+
</Accordion>
103+
104+
<Accordion icon="pencil" title="Ajout de contenu">
105+
106+
Ajoutez du contenu avec de simples fichiers MDX. Initialisez vos pages avec ce modèle :
107+
108+
```md
109+
---
110+
title: "Titre de la Page"
111+
sidebarTitle: "Titre de la barre latérale (optionnel - si différent du titre de la page)"
112+
description: "Sous-titre (optionnel)"
113+
---
114+
```
115+
116+
En savoir plus sur l'ajout d'images, tableaux, listes et plus encore en utilisant la [syntaxe MDX](/text). Nous proposons également une [large gamme de composants](/content/components).
117+
118+
</Accordion>
119+
120+
<Accordion icon="rocket" title="Pousser les changements">
121+
122+
Une fois prêt, validez et poussez vos changements pour mettre à jour votre site de documentation. Voici un [guide](https://docs.github.com/fr/get-started/using-git/pushing-commits-to-a-remote-repository#about-git-push) sur la façon de le faire. Si l'application GitHub ne parvient pas à déployer vos changements avec succès, vous pouvez mettre à jour manuellement votre documentation via notre [tableau de bord](https://dashboard.mintlify.com).
123+
124+
<Frame>
125+
![Mise à jour
126+
manuelle](https://mintlify.s3-us-west-1.amazonaws.com/mintlify/images/manual-update.png)
127+
</Frame>
128+
129+
</Accordion>
130+
131+
<Accordion icon="code-branch" title="Génération des références API">
132+
133+
Vous pouvez facilement configurer vos références API en utilisant un document OpenAPI.
134+
135+
1. Ajoutez votre fichier `openapi.yaml` ou `openapi.json` dans votre dépôt de documentation ou définissez le champ `openapi` dans `mint.json` avec une URL.
136+
137+
```json
138+
"openapi": "lien-vers-votre-fichier-openapi"
139+
```
140+
141+
2. Utilisez notre [scraper](/api-playground/openapi/setup#autogenerate-files-recommended) pour générer automatiquement vos fichiers d'endpoints OpenAPI :
142+
143+
```bash
144+
npx @mintlify/scraping@latest openapi-file <chemin-ou-url-vers-fichier-openapi>
145+
```
146+
147+
3. Enfin, incluez les fichiers MDX d'endpoints générés dans votre `mint.json` sous `navigation`.
148+
149+
Pour un guide complet sur l'utilisation de Mintlify avec OpenAPI, consultez [ce guide](/api-playground/openapi/setup). [Ce guide](/api-playground/openapi/writing-openapi) explique comment configurer vos méthodes d'authentification API. Pour une définition manuelle des références API, explorez [notre syntaxe](/api-playground/overview).
150+
151+
</Accordion>
152+
153+
<Accordion icon="chart-simple" title="Ajout d'analyses">
154+
155+
Nos analyses intégrées vous donnent des informations sur les vues de pages, les analyses de recherche, les enregistrements de session et plus encore. Accédez à ces informations sur votre [tableau de bord](https://dashboard.mintlify.com/analytics).
156+
157+
Nous prenons également en charge les intégrations avec une gamme de fournisseurs d'analyses. Vous pouvez trouver la liste des fournisseurs [ici](/integrations/analytics/overview).
158+
159+
</Accordion>
160+
</AccordionGroup>
161+
162+
<Note>
163+
Nous fournissons un service de migration personnalisé dans le cadre de notre plan Enterprise. Intéressé ? Vous pouvez le demander en nous [contactant](mailto:[email protected]).
164+
</Note>
165+
166+
### Publication
167+
168+
<Accordion icon="star" title="Ajouter un domaine personnalisé">
169+
170+
Intégrez votre documentation dans votre site web en l'hébergeant sur un domaine personnalisé. C'est inclus dans le plan gratuit.
171+
172+
Accédez aux [paramètres de votre tableau de bord](https://www.dashboard.mintlify.com/settings) pour ajouter un domaine personnalisé.
173+
174+
<Frame>![Domaine personnalisé](/images/custom-domain.png)</Frame>
175+
176+
</Accordion>
177+
178+
Félicitations ! Vous avez configuré votre Documentation Mintlify et elle est magnifique ! Besoin d'aide ou envie de donner votre avis ? Vous pouvez rejoindre notre [communauté](https://mintlify.com/community) ou nous envoyer un email à [[email protected]](mailto:[email protected]).

mint.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,8 @@
7070
},
7171
"settings/global",
7272
"settings/navigation",
73-
"migration"
73+
"migration",
74+
"fr/quickstart"
7475
]
7576
},
7677
{

0 commit comments

Comments
 (0)