Skip to content

Commit 0ca2d95

Browse files
author
Xavier Berger
committed
doc: Prepare mkdocs for internationalisation
1 parent f0fe6b8 commit 0ca2d95

30 files changed

+36
-5
lines changed

docs/about.md docs/en/about.md

File renamed without changes.

docs/alternatives.md docs/en/alternatives.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ If it doesn't fully feat your needs, you may have a look to the following projec
77

88
* [PvRouter](https://ota.apper-solaire.org/) from **Cyril P** (in French), site français qui propose un routeur solaire clé en main avec une carte électronique dédiée.
99

10-
* [Routeur Photovoltaïque](f1atb.fr) from **André** (in French), routeur solaire multi-source qui a été la source d'inspiration de **Solar-Router-for-ESPHome**
10+
* [Routeur Photovoltaïque](http://f1atb.fr) from **André** (in French), routeur solaire multi-source qui a été la source d'inspiration de **Solar-Router-for-ESPHome**
1111

1212
* [PV-Routeur Solaire ESP Home](https://domo.rem81.com/index.php/2023/07/18/pv-routeur-solaire/) from **Remy**, Routeur solaire à base de ESPHome qui a aussi été source d'inspiration pour **Solar-Router-for-ESPHome**
1313

File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

docs/engine.md docs/en/engine.md

File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

docs/index.md docs/en/index.md

File renamed without changes.
File renamed without changes.

docs/license.md docs/en/license.md

File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

mkdocs.yml

+33-3
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ nav:
2525
- Solid State Relay: regulator_solid_state_relay.md
2626
- Mecanical relay: regulator_mecanical_relay.md
2727
- Engine:
28-
- Variable regulation: engine.md
28+
- Progressive regulation: engine.md
2929
- ON/OFF regulation: engine_on_off.md
3030
- Energy Counter:
3131
- Theorical: energy_counter_theorical.md
@@ -41,11 +41,10 @@ nav:
4141
- Alternatives: alternatives.md
4242

4343
theme:
44+
name: material
4445
features:
4546
- tabs
4647
- content.code.copy
47-
name: material
48-
4948
font:
5049
text: Ubuntu
5150
code: Ubuntu Mono
@@ -67,6 +66,37 @@ markdown_extensions:
6766
- md_in_html
6867

6968
plugins:
69+
- i18n:
70+
docs_structure: folder
71+
reconfigure_material: true
72+
reconfigure_search: true
73+
languages:
74+
- locale: en
75+
default: true
76+
name: English
77+
build: true
78+
- locale: fr
79+
name: Français
80+
build: true
81+
nav_translations:
82+
Home: Accueil
83+
Disclamer: Clause de non-responsabilité
84+
Solar Router / Diverter: Routeur solaire
85+
Hardware: Materiel
86+
Overview: Aperçu
87+
Examples: Exemples
88+
Standalone: Routeur autonome
89+
With proxy: Router utilisant un proxy
90+
Proxy client: Client proxy
91+
Mecanical relay: Relais mécanique
92+
Progressive regulation: Régulation progressive
93+
ON/OFF regulation: Regi=ulation tout ou rien
94+
Theorical: Théorique
95+
HA configuration: Configuration de HA
96+
Contributing: Contribution
97+
License: Licence
98+
About: A propos
99+
Alternatives: Alternatives
70100
- search
71101
- minify:
72102
minify_html: true

requirements.txt

+2-1
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,5 @@ mkdocs-include-markdown-plugin
66
mkdocs-material
77
mkdocs-material-extensions
88
mkdocs-minify-plugin
9-
pymdown-extensions
9+
mkdocs-static-i18n
10+
pymdown-extensions

0 commit comments

Comments
 (0)