From 9ec7cbd6a4e77131245e060369479768e8e6cf54 Mon Sep 17 00:00:00 2001 From: forresst Date: Fri, 19 Jul 2019 10:30:31 +0200 Subject: [PATCH] Transalations docs in french --- website/docs/fr/README.md | 84 ++++++ website/docs/fr/builtin-components.md | 206 ++++++++++++++ website/docs/fr/credits.md | 12 + website/docs/fr/guide/customization.md | 172 ++++++++++++ website/docs/fr/guide/deployment.md | 51 ++++ website/docs/fr/guide/internationalization.md | 48 ++++ website/docs/fr/guide/markdown-features.md | 246 ++++++++++++++++ website/docs/fr/guide/offline-support.md | 80 ++++++ website/docs/fr/guide/plugin.md | 60 ++++ website/docs/fr/guide/use-vue-in-markdown.md | 82 ++++++ website/docs/fr/guide/use-with-bundlers.md | 32 +++ website/docs/fr/options.md | 264 ++++++++++++++++++ website/docs/fr/plugin-api.md | 79 ++++++ website/index.js | 88 ++++++ 14 files changed, 1504 insertions(+) create mode 100644 website/docs/fr/README.md create mode 100644 website/docs/fr/builtin-components.md create mode 100644 website/docs/fr/credits.md create mode 100644 website/docs/fr/guide/customization.md create mode 100644 website/docs/fr/guide/deployment.md create mode 100644 website/docs/fr/guide/internationalization.md create mode 100644 website/docs/fr/guide/markdown-features.md create mode 100644 website/docs/fr/guide/offline-support.md create mode 100644 website/docs/fr/guide/plugin.md create mode 100644 website/docs/fr/guide/use-vue-in-markdown.md create mode 100644 website/docs/fr/guide/use-with-bundlers.md create mode 100644 website/docs/fr/options.md create mode 100644 website/docs/fr/plugin-api.md diff --git a/website/docs/fr/README.md b/website/docs/fr/README.md new file mode 100644 index 00000000..43cea149 --- /dev/null +++ b/website/docs/fr/README.md @@ -0,0 +1,84 @@ +# Introduction à Docute + +Le moyen le plus rapide pour créer un site de documentation pour votre projet. + +## Qu'est-ce que Docute + +Docute est essentiellement un fichier JavaScript qui récupère des fichiers Markdown et les rend sous forme d'une application mono page. + +Il est totalement axé sur l'exécution, il n'y a donc aucun composant côté serveur, ce qui signifie également qu'il n'y a pas de processus de construction. Vous avez seulement besoin de créer un fichier HTML et plusieurs documents Markdown et votre site web est presque prêt ! + +## Comment ça marche + +En bref : l'URL est l'API. + +Nous récupérons et faisons le rendu du fichier markdown correspondant vers l'URL que vous visitez : + +``` +/ => /README.md +/foo => /foo.md +/foo/ => /foo/README.md +/foo/bar => /foo/bar.md +``` + +## Démarrage rapide + +Supposons que vous avez les fichiers suivants dans le dossier `./my-docs` : + +```bash +. +├── README.md +└── index.html +``` + +Le fichier `index.html` ressemble à ceci : + +```html {highlight:[7,'10-16']} + + + + + + My Docs + + + +
+ + + + +``` + +Vous pouvez ensuite servir ce dossier en tant que site Web statique sur votre ordinateur en utilisant : + +- Node.js: `npm i -g serve && serve .` +- Python: `python -m SimpleHTTPServer` +- Golang: `caddy` +- ..ou quel que soit le serveur web statique + +Ensuite, vous pouvez utiliser [sidebar](./options.md#sidebar), [nav](./options.md#nav) ou d'autres [options](./options.md) pour personnaliser le site Web. + +Voici un [REPL](https://repl.it/@egoist/docute-starter) où vous pouvez essayer Docute en ligne ou [téléchargez](https://repl.it/@egoist/docute-starter.zip) le pour l'exécuter localement. + +## Comparaisons + +### VuePress / GitBook / Hexo + +Ils génèrent tous du HTML statique lors de la construction, ce qui est bien pour le SEO (référencement). + +Si le SEO vous intéresse, vous pouvez utiliser [presite](https://github.com/egoist/presite) pour pré rendre votre site web. + +### Docsify + +[Docsify](https://docsify.js.org/#/) et Docute sont à peu près les mêmes, mais avec une interface utilisateur et des usages différents. + +Docute (60Kb) est 3 fois plus volumineux que Docsify (20 Kb), car nous utilisons Vue, Vue Router et Vuex, alors que Docsify utilise sous le capot du JavaScript. + +## Compatibilité des navigateurs + +Docute prend en charge tous les navigateurs _ever-green_. Aucun support de IE ! diff --git a/website/docs/fr/builtin-components.md b/website/docs/fr/builtin-components.md new file mode 100644 index 00000000..99c3d9bf --- /dev/null +++ b/website/docs/fr/builtin-components.md @@ -0,0 +1,206 @@ +# Composants intégrés + +Docute est livré avec un ensemble de composants Vue intégrés. + +## `` + +Utilise un effet de zoom de style moyen pour afficher certaines images. + +| Prop | Type | Par défaut | Description | +| ------ | --------- | ---------- | ------------------------------------- | +| src | `string` | N/A | URL vers l'image | +| title | `string` | N/A | Titre de l'image | +| alt | `string` | N/A | Texte de remplacement | +| border | `boolean` | `false` | Affiche une bordure autour de l'image | +| width | `string` | N/A | Image width | + +
+ +Exemple : + +```markdown + +``` + + + +## `` + +Un petit composant d'étiquette. + +| Prop | Type | Par défaut | Description | +| -------- | -------------------------------------------------------------------- | ---------- | ----------------------------- | +| type | 'tip' | 'success' | 'warning' | 'danger' | N/A | Type de badge | +| color | `string` | N/A | Couleur de fond personnalisée | +| children | `string` | N/A | Texte du badge | + +
+ +Exemple : + +```markdown +- Fonctionnalité 1 Badge +- Fonctionnalité 2 Astuce +- Fonctionnalité 3 Succès +- Fonctionnalité 4 Attention +- Fonctionnalité 5 Danger +- Fonctionnalité 6 Couleur personnalisée +``` + +- Fonctionnalité 1 Badge +- Fonctionnalité 2 Astuce +- Fonctionnalité 3 Succès +- Fonctionnalité 4 Attention +- Fonctionnalité 5 Danger +- Fonctionnalité 6 Couleur personnalisée + +## `` + +Blocs notes colorés pour accentuer une partie de votre page. + +| Prop | Type | Par défaut | Description | +| -------- | -------------------------------------------------------------------- | ------------------- | ------------------------------------------------- | +| type | 'tip' | 'warning' | 'danger' | 'success' | N/A | Type de note | +| label | `string` `boolean` | La valeur de `type` | Custom note label text, use `false` to hide label | +| children | `string` | N/A | Contenu de la note | + +
+ +Exemples : + +```markdown + + +Ceci est une note qui détaille quelque chose d'important.
+[Un lien vers des informations utiles.](https://docute.org) + + + + + + +Ceci est une astuce pour quelque chose de possible. + + + + + + +Ceci est un avertissement pour quelque chose de très important. + + + + + + +C’est un danger pour lequel il faut agir. + + +``` + + + +Ceci est une note qui détaille quelque chose d'important.
+[Un lien vers des informations utiles.](https://docute.org) + + + + + + +Ceci est une astuce pour quelque chose de possible. + + + + + + +Ceci est un avertissement pour quelque chose de très important. + + + + + + +C’est un danger pour lequel il faut agir. + + + +## `` + +Intègre un [Gist de GitHub](https://gist.github.com/) dans vos documents Markdown. + +| Prop | Type | Default | Description | +| ---- | -------- | ------- | ----------- | +| id | `string` | N/A | ID du Gist | + +Exemple : + +```markdown + +``` + + + +## `` + +Un composant `