Skip to content
Closed
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
178 changes: 178 additions & 0 deletions fr/quickstart.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,178 @@
---
title: "Démarrage Rapide"
description: "Commencez à construire une documentation moderne en moins de cinq minutes"
icon: "rocket"
---

<Frame>
<img
className="block dark:hidden"
src="https://mintlify-assets.b-cdn.net/hero-light.png"
/>
<img
className="hidden dark:block"
src="https://mintlify-assets.b-cdn.net/hero-dark.png"
/>
</Frame>

## Pour Commencer

Bienvenue ! Suivez les instructions ci-dessous pour apprendre à déployer, mettre à jour et améliorer votre documentation avec Mintlify.

### Création du Dépôt

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.

<AccordionGroup>

<Accordion icon="message-bot" title="Installer l'application GitHub">

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.

<Frame>
![GitHub Bot Verification](https://mintlify.s3-us-west-1.amazonaws.com/mintlify/images/github-bot-verification.png)
</Frame>

</Accordion>

<Accordion icon="code-branch" title="Configuration Monorepo">
Si vous souhaitez que votre documentation vive aux côtés de votre code en tant que configuration monorepo, vous pouvez :
1. Déplacer le contenu de votre documentation dans votre monorepo.
2. Spécifier le chemin vers votre `mint.json` dans le [tableau de bord](https://dashboard.mintlify.com/settings/deployment/git-settings)

<Frame>
<img
alt="Configuration monorepo"
className="block dark:hidden"
src="/images/monorepo-light.png"
/>
<img
alt="Configuration monorepo"
className="hidden dark:block"
src="/images/monorepo-dark.png"
/>
</Frame>
</Accordion>

</AccordionGroup>

### Mise à Jour du Contenu

Mintlify vous permet de personnaliser facilement le style, la structure et le contenu de votre documentation.

<AccordionGroup>
<Accordion icon="rectangle-terminal" title="Édition en local (recommandé pour les développeurs)">

1. Installez [git](https://git-scm.com/book/fr/v2/Démarrage-rapide-Installation-de-Git).
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).
3. Utilisez votre IDE préféré pour ouvrir le dépôt.
4. Installez notre CLI Mintlify pour prévisualiser les changements avec `npm i -g mintlify`.

En savoir plus dans notre [guide de développement local](/development).

</Accordion>

<Accordion icon="pen-to-square" title="Édition avec l'éditeur web">

Apprenez à utiliser l'éditeur web dans notre [guide](/web-editor).

</Accordion>

<Accordion icon="palette" title="Personnalisation selon votre marque">

Personnalisez facilement les couleurs, logos et boutons parmi d'autres configurations dans notre fichier `mint.json`. Commencez par ces configurations de base :

```json
"name": "Votre Entreprise"
"logo": {
"light": "/logo/light.svg",
"dark": "/logo/dark.svg",
"href": "https://votreentreprise.com"
},
"favicon": "/favicon.svg",
"colors": {
"primary": "#2AB673",
"light": "#55D799",
"dark": "#117866",
},
```

Une liste complète des configurations prises en charge se trouve dans les [paramètres globaux](/settings/global).

</Accordion>

<Accordion icon="pencil" title="Ajout de contenu">

Ajoutez du contenu avec de simples fichiers MDX. Initialisez vos pages avec ce modèle :

```md
---
title: "Titre de la Page"
sidebarTitle: "Titre de la barre latérale (optionnel - si différent du titre de la page)"
description: "Sous-titre (optionnel)"
---
```

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).

</Accordion>

<Accordion icon="rocket" title="Pousser les changements">

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).

<Frame>
![Mise à jour
manuelle](https://mintlify.s3-us-west-1.amazonaws.com/mintlify/images/manual-update.png)
</Frame>

</Accordion>

<Accordion icon="code-branch" title="Génération des références API">

Vous pouvez facilement configurer vos références API en utilisant un document OpenAPI.

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.

```json
"openapi": "lien-vers-votre-fichier-openapi"
```

2. Utilisez notre [scraper](/api-playground/openapi/setup#autogenerate-files-recommended) pour générer automatiquement vos fichiers d'endpoints OpenAPI :

```bash
npx @mintlify/scraping@latest openapi-file <chemin-ou-url-vers-fichier-openapi>
```

3. Enfin, incluez les fichiers MDX d'endpoints générés dans votre `mint.json` sous `navigation`.

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).

</Accordion>

<Accordion icon="chart-simple" title="Ajout d'analyses">

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).

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).

</Accordion>
</AccordionGroup>

<Note>
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]).
</Note>

### Publication

<Accordion icon="star" title="Ajouter un domaine personnalisé">

Intégrez votre documentation dans votre site web en l'hébergeant sur un domaine personnalisé. C'est inclus dans le plan gratuit.

Accédez aux [paramètres de votre tableau de bord](https://www.dashboard.mintlify.com/settings) pour ajouter un domaine personnalisé.

<Frame>![Domaine personnalisé](/images/custom-domain.png)</Frame>

</Accordion>

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]).
3 changes: 2 additions & 1 deletion mint.json
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,8 @@
},
"settings/global",
"settings/navigation",
"migration"
"migration",
"fr/quickstart"
]
},
{
Expand Down
Loading