First step for documentation translations

The goal is to be able to embed some of the FAQ entries within the app, see #1710 and #813 for instance.

Author: davidbgk

docs/fr/index.md

@@ -0,0 +1,6 @@
+# Documentation uMap
+
+uMap vous offre la possibilité de concevoir rapidement des cartes personnalisées avec des fonds OpenStreetMap (OSM) et de les intégrer facilement à votre site.
+
+- 🤓 Consulter les [tutoriels en français sur le site de umap-project.org](https://umap-project.org/tutoriels/).
+- 🤔 Explorer les [les questions/réponses de la FAQ](support/faq.md).

docs/fr/support/faq.md

@@ -0,0 +1,12 @@
+# Questions Fréquemment Posées (FAQ)
+
+## Quelle syntaxe est acceptée dans les champs de description ?
+
+* `*simple astérisque pour italique*` → *simple astérisque pour italique*
+* `**double astérisque pour gras**` → **double astérisque pour gras**
+* `# un dièse pour titre 1` ⤵ <h1>un dièse pour titre 1</h1>
+* `## deux dièses pour titre 2` ⤵ <h2>deux dièses pour titre 2</h2>
+* `### trois dièses pour titre 3` ⤵ <h3>trois dièses pour titre 3</h3>
+* `Lien simple : [[http://example.com]]` → Lien simple : [http://example.com](http://example.com)
+* `Lien avec texte : [[http://exemple.fr|texte du lien]]` → Lien avec texte : [texte du lien](http://example.com)
+* `--- pour un séparateur horizontal` ⤵ <hr>

docs/requirements.txt

@@ -2,3 +2,4 @@
 mkdocs==1.5.3
 pymdown-extensions==10.7.1
 mkdocs-material==9.5.16
+mkdocs-static-i18n==1.2.2

docs/support/faq.md

@@ -0,0 +1,12 @@
+# Frequently Asked Questions (FAQ)
+
+## Which syntax is allowed in description fields?
+
+* `*single star for italic*` → *single star for italic*
+* `**double star for bold**` → **double star for bold**
+* `# one hash for main heading` ⤵ <h1>one hash for main heading</h1>
+* `## two hashes for second heading` ⤵ <h2>two hashes for second heading</h2>
+* `### three hashes for third heading` ⤵ <h3>three hashes for third heading</h3>
+* `Simple link: [[http://example.com]]` → Simple link: [http://example.com](http://example.com)
+* `Link with text: [[http://example.com|text of the link]]` → Link with text: [text of the link](http://example.com)
+* `--- for a horizontal rule` ⤵ <hr>

mkdocs.yml

@@ -1,8 +1,9 @@
-site_name: uMap docs
+site_name: uMap documentation
 site_description: uMap lets you create maps with OpenStreetMap layers in a minute and embed them in your site
 repo_name: umap-project/umap
 repo_url: https://github.com/umap-project/umap
 nav:
+  - Home: index.md
   - How-tos:
       - Getting started: install.md
       - Contribute: contributing.md
@@ -18,6 +19,8 @@ nav:
   - Deployment:
       - Docker: deploy/docker.md
       - Nginx: deploy/nginx.md
+  - Support:
+      - FAQ: support/faq.md
   - Changelog: changelog.md
 theme:
   name: material
@@ -42,6 +45,8 @@ theme:
 extra_css:
   - stylesheets/extra.css
 markdown_extensions:
+  - toc:
+      permalink: ⚓︎
   - pymdownx.magiclink:
       normalize_issue_symbols: true
       repo_url_shorthand: true
@@ -56,3 +61,18 @@ markdown_extensions:
   - pymdownx.tabbed:
       alternate_style: true
       combine_header_slug: true
+plugins:
+  - i18n:
+      docs_structure: folder
+      languages:
+        - locale: en
+          default: true
+          name: English
+          build: true
+        - locale: fr
+          name: Français
+          build: true
+          site_name: Documentation uMap
+          nav_translations:
+            Home: Accueil
+            Support: Aide