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
|
# How to translate docs (Help files)
## 1. Install:
https://github.com/mkdocs/mkdocs/
https://squidfunk.github.io/mkdocs-material/
https://pypi.org/project/mkdocs-static-i18n/
https://pypi.org/project/mkdocs-redirects/
## 2. Copy:
File: `mkdocs.yml`
and
Folder: `/docs`
in to the same location *(\*don't put mkdocs.yml in /docs folder!)*
## 3. Edit mkdocs.yml
Add your language under
`languages:`
`alternate:`
`redirect_maps:`
## 3. Translate:
In Folder `/docs` duplicate, rename and translate every `*.\<lang>.md` file
example for German: Clone `index.md` -> `index.de.md`
## 4. Test
in your console go to the folder of mkdocs.yml then run
`mkdocs serve`
Open your web-browser and go to http://127.0.0.1:8000
## 5. Build
`mkdocs build`
compiled site is in folder `\site` that is in same folder where the `mydocs.yml` is
|
