File: README.md

package info (click to toggle)
mkdocs-static-i18n 1.3.0-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 3,412 kB
  • sloc: python: 3,131; xml: 45; makefile: 21; sh: 17
file content (123 lines) | stat: -rw-r--r-- 4,047 bytes parent folder | download | duplicates (6)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
# Sujet 2 (french version)

!!! tip "Astuce"
    **Utilisez le sélecteur de langue dans la barre de titre** pour passer d'une version localisée à l'autre de ce site de démonstration. Ce sélecteur fait partie de [mkdocs-material >= 7.1.0](https://squidfunk.github.io/mkdocs-material/setup/changing-the-language/#site-language-selector) et est **configuré automatiquement par ce plugin** ou peut être défini de manière statique depuis le [fichier mkdocs.yml](https://github.com/ultrabug/mkdocs-static-i18n/blob/main/mkdocs.yml).

## Ce que vous voyez en ce moment

La source de cette page et son contenu média ont été localisés en suivant la
[logique de localisation](#logique-de-localisation) décrite ci-dessous. Voici
un rapide récapitulatif des fichiers utilisés comme source et de la structure
générée que vous voyez en ce moment:

```
docs
├── image.en.png
├── image.fr.png  <-- this image file is used on the /fr version
├── index.fr.md
├── index.md
├── topic1
│   ├── named_file.en.md
│   └── named_file.fr.md  <-- this file is used on the /fr version
└── topic2
    ├── index.en.md
    └── index.md
```

```
site
├── en
│   ├── image.png
│   ├── index.html
│   ├── topic1
│   │   └── named_file
│   │       └── index.html
│   └── topic2
│       └── index.html
├── fr
│   ├── image.png  <-- you see this image on the /fr version
│   ├── index.html
│   ├── topic1
│   │   └── named_file
│   │       └── index.html
│   └── topic2
│       └── index.html  <-- you are here on the /fr version
├── image.png
├── index.html
├── topic1
│   └── named_file
│       └── index.html
└── topic2
    └── index.html
```

## Localisation automatique des médias / liens / assets

![localized image](../image.png)

La source de cette image est dynamiquement localisée bien qu'elle soit
référencée dans la source du markdown par `![localized image](image.png)`.
Cela démontre que ce plugin vous permet de ne pas vous préoccuper du nom
des fichiers dans vos liens, médias et contenus statiques : utilisez leurs
noms sans extension localisée et concentrez-vous sur la traduction de vos
contenus !

---

## Logique de localisation

Ce site est construit avec cette configuration :

```
plugins:
  - i18n:
      default_language: en
      languages:
        en: english
        fr: français
```

Ce qui veut dire que nous obtiendrons trois versions de notre site :

1. la version `default_language` qui utilisera en premier les fichiers dont
l'extension est `.md` et prendra quelconque fichier en `.en.md` en repli
puisque la version `en` est configurée comme la langue par défaut
2. la version localisée `/en` qui utilisera les fichiers dont l'extension est
`.en.md` en premier et utilisera leur version `.md` en repli si elle existe
3. la version localisée `/fr` qui utilisera les fichiers dont l'extension est
`.fr.md` en premier et utilisera en repli soit la version `.en.md` (dérivée
du langage par défaut) ou `.md`

En suivant cette logique, la structure `site` générée est :

```
site
├── 404.html
├── assets
│   ├── images
│   ├── javascripts
│   └── stylesheets
├── en
│   ├── image.png
│   ├── index.html
│   ├── topic1
│   │   └── named_file
│   │       └── index.html
│   └── topic2
│       └── index.html
├── fr
│   ├── image.png
│   ├── index.html
│   ├── topic1
│   │   └── named_file
│   │       └── index.html
│   └── topic2
│       └── index.html
├── image.png
├── index.html
├── topic1
│   └── named_file
│       └── index.html
└── topic2
    └── index.html
```