mkdocs.yml

# Define the site name
site_name: me3 - FROMSOFTWARE mod loader

# Set the site URL by using a Read the Docs environment variable:
# https://docs.readthedocs.io/en/stable/reference/environment-variables.html
site_url: !ENV READTHEDOCS_CANONICAL_URL
copyright: Copyright © 2022 - 2025 me3 contributors
# Set the Material for MkDocs theme
theme:
  favicon: images/me3.png
  name: material
  font:
    text: Noto Sans
  features:
    - content.action.edit
    - content.action.view
    - content.code.annotate
    - content.code.copy
    # - content.code.select
    # - content.footnote.tooltips
    - content.tabs.link
    - content.tooltips
    - header.autohide
    - navigation.expand
    - navigation.footer
    - navigation.indexes
    - navigation.instant
    - navigation.instant.preview
    - navigation.instant.prefetch
    - navigation.instant.progress
    - navigation.path
    - navigation.prune
    - navigation.sections
    - navigation.tabs
    # - navigation.tabs.sticky
    - navigation.top
    - navigation.tracking
    - search.highlight
    - search.share
    - search.suggest
    - toc.follow
    - typeset
  icon:
    repo: fontawesome/brands/github
  palette:
    - scheme: slate
      primary: black
      accent: indigo
  # https://squidfunk.github.io/mkdocs-material/customization/
  custom_dir: docs/overrides
repo_url: https://github.com/garyttierney/me3
edit_uri: edit/main/docs/
# Include extra JS to setup Read the Docs addons integrations
extra_javascript:
  - javascripts/readthedocs.js
extra_css:
  - assets/stylesheets/custom.css
  - assets/stylesheets/collapse-code.css

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/garyttierney/me3
      name: me3 on GitHub

    - icon: fontawesome/brands/bluesky
      link: https://bsky.app/profile/me3.dev
      name: me3 on BlueSky
  alternate:
    - name: English
      link: /en/
      lang: en
    - name: 中文
      link: /zh/
      lang: zh
    - name: Polski
      link: /pl/
      lang: pl

nav:
  - index.md
  - User guide:
      - user-guide/installation.md
      - user-guide/troubleshooting.md
      - user-guide/faq.md
      - Tutorials:
          - user-guide/creating-mod-profiles.md
  - configuration-reference.md
  - Download: https://github.com/garyttierney/me3/releases/latest
  - Changelog: changelog.md
  - Blog:
      - Reversing Arxan (GuardIT): blog/posts/arxan-reversing-1.md
      - Release 0.2.0: blog/posts/me3-release.md
plugins:
  - group:
      enabled: !ENV MKDOCS_MATERIAL_INSIDERS_ENABLED
      plugins:
          - optimize
  - meta
  - search
  
  - meta-descriptions
  - git-committers:
      repository: garyttierney/me3
      branch: main
      exclude_committers:
        - web-flow
  - i18n:
      build_only_locale: !ENV [BUILD_ONLY_LOCALE]
      languages:
        - locale: en
          default: true
          name: English
          build: true
        - locale: zh
          name: 中文
          build: false
          site_name: me3 - FROMSOFTWARE mod加载器
          nav:
            - index.md
            - 用户引导:
                - user-guide/installation.md
                - user-guide/troubleshooting.md
                - user-guide/faq.md
                - 教程:
                    - user-guide/creating-mod-profiles.md
            - configuration-reference.md
            - 下载: https://github.com/garyttierney/me3/releases/latest
            - 更新日志: changelog.md
            - 博客:
              - Reversing Arxan (GuardIT): blog/posts/arxan-reversing-1.md
              - me3 已发布: blog/posts/me3-release.md
          extra:
            analytics:
              provider: google
              property: G-FMPH9RP5EH
              feedback:
                title: 这个页面有帮助吗？
                ratings:
                  - icon: material/emoticon-happy-outline
                    name: 有帮助
                    data: 1
                    note: >-
                      感谢您的反馈！
                  - icon: material/emoticon-sad-outline
                    name: 需要改进
                    data: 0
                    note: >-
                      感谢您的反馈！
            consent:
              title: Cookie允许
              actions:
                - accept
                - reject
                - manage
              description: >-
                我们使用Cookie来识别您的重复访问和偏好，以及衡量我们文档的有效性以及用户是否找到他们要找的东西。在您同意的情况下，您正在帮助我们使我们的文档更好。
        - locale: pl
          name: Polski
          build: false
          site_name: me3 – framework do obsługi modów w grach FROMSOFTWARE
          nav:
            - index.md
            - Przewodnik użytkownika:
                - user-guide/installation.md
                - user-guide/troubleshooting.md
                - user-guide/faq.md
                - Instrukcje: 
                    - user-guide/creating-mod-profiles.md
            - configuration-reference.md
            - Pobierz: https://github.com/garyttierney/me3/releases/latest
            - Lista zmian: changelog.md
            - Blog: 
              - Reversing Arxan (GuardIT): blog/posts/arxan-reversing-1.md
              - me3 wydany: blog/posts/me3-release.md
          extra:
            analytics:
              provider: google
              property: G-FMPH9RP5EH
              feedback:
                title: Czy ta strona była pomocna?
                ratings:
                  - icon: material/emoticon-happy-outline
                    name: Ta strona była pomocna
                    data: 1
                    note: >-
                      Dziękujemy za opinię!
                  - icon: material/emoticon-sad-outline
                    name: Tę stronę można ulepszyć
                    data: 0
                    note: >-
                      Dziękujemy za opinię!
            consent:
              title: Zgoda na pliki cookie
              actions:
                - accept
                - reject
                - manage
              description: >-
                Wykorzystujemy pliki cookie do rozpoznawania powtarzających się wizyt, zapamiętywania Twoich preferencji, mierzenia skuteczności naszej dokumentacji oraz sprawdzania, czy użytkownicy znajdują poszukiwane informacje. Wyrażając zgodę na pliki cookie, pomagasz nam ulepszać dokumentację. 
  - git-revision-date-localized:
      enable_creation_date: true

hooks:
  - docs/overrides/hooks/register_local_mdx.py

markdown_extensions:
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - toc:
      toc_depth: "1-3"
      permalink: true
  # Python Markdown Extensions
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.details
  - pymdownx.highlight
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.snippets:
      base_path: [!relative $config_dir]
      check_paths: true
      auto_append:
        - docs/includes/glossary.md
  - pymdownx.tabbed:
      alternate_style: true
      slugify: !!python/object/apply:pymdownx.slugs.slugify
        kwds:
          case: lower
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg