File: mkdocs.yml

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 (91 lines) | stat: -rw-r--r-- 2,424 bytes parent folder | download
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
site_name: MkDocs static i18n plugin documentation
site_url: https://ultrabug.github.io/mkdocs-static-i18n
repo_url: https://github.com/ultrabug/mkdocs-static-i18n

docs_dir: docs/
exclude_docs: overrides/

copyright: Copyright © 2021-2023 Alexys Jacob

theme:
  name: material
  font: false
  custom_dir: docs/overrides
  logo:
    assets/logo_by_maxicons.png
  palette:
    primary: blue
  features:
    - navigation.expand
    - navigation.indexes
    - navigation.sections
    - navigation.tabs
    - toc.follow
    - toc.integrate

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/ultrabug/mkdocs-static-i18n
      name: mkdocs-static-i18n on Github

markdown_extensions:
  - admonition
  - attr_list
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.superfences
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg

nav:
  - Home: index.md
  - Getting Started:
    - getting-started/installation.md
    - getting-started/quick-start.md
    - getting-started/philosophy.md
  - Configuration:
    - setup/index.md
    - setup/choosing-the-structure.md
    - setup/setting-up-languages.md
    - setup/translating-content.md
    - setup/controlling-your-builds.md
    - setup/localizing-navigation.md
    - setup/using-i18n-context.md
    - setup/using-alternates.md
    - setup/upgrading-to-1.md
    - Plugins Compatibility:
      - setup/setting-up-material.md
      - setup/setting-up-search.md
      - setup/plugins-compatibility.md
  - Changelog: changelog.md

plugins:
  - search
  - i18n:
      docs_structure: suffix
      fallback_to_default: true
      reconfigure_material: true
      reconfigure_search: true
      languages:
        - locale: en
          default: true
          name: English
          build: true
          site_name: "MkDocs static i18n plugin documentation (en)"
        - locale: fr
          name: Français
          build: true
          site_name: "Documentation du plugin MkDocs static i18n (fr)"
          theme:
            palette:
              primary: red
          nav_translations:
            Home: Accueil
            Getting Started: Démarrage Rapide
            Plugins Compatibility: Compatibilité des plugins