mkdocs.yml

# Project Information
site_name: LLVM Wiki
site_description: The LLVM Wiki provides wiki documentation on reusable compilation techniques
site_author: LLVM Wiki Team
site_url: https://llvm.wiki
strict: false

# Repository
repo_name: 'llvm-wiki/llvm-wiki'
repo_url: 'https://github.com/llvm-wiki/llvm-wiki'
edit_uri: 'https://llvm.wiki/edit-landing/?ref='

# Copyright
copyright: 'Copyright © 2022 LLVM Wiki team'

plugins:
  - search
  - i18n:
      languages:
        en: "English"
        zh: "简体中文"
      default_language: 'en'
      no_translation:
        en: "This page isn't translated to English."
        zh: "这个页面还没有被翻译为简体中文"
      translate_nav:
        en:
          section title: "Section"
          subsection: "Subsection"
          page title: "Page with title translated"

          mlir-basic-concept: MLIR Basic Concept
          mlir-dialect: Dialect
          mlir-overview: Overview

          llvm-pass-overview: Overview
          llvm-pass-hello-world: Hello World
        zh:
          section title: "节"
          subsection: "小节"
          page title: "标题被翻译过的页"

          mlir-basic-concept: 基本概念
          mlir-dialect: 方言
          mlir-overview: 概述

          llvm-pass-overview: 概述
          llvm-pass-hello-world: Hello World
      add_lang_links: False


# Contents
nav:
  - LLVM Wiki: index.md
  - LLVM Wiki: index.zh.md
  - MLIR:
    - mlir-overview: mlir/mlir.md
    - mlir-overview: mlir/mlir.zh.md
    - mlir-basic-concept:
      - mlir-dialect: mlir/basic/dialect.md
      - mlir-dialect: mlir/basic/dialect.zh.md
  - LLVM:
    - Pass:
      - llvm-pass-overview: llvm/pass/index.md
      - llvm-pass-overview: llvm/pass/index.zh.md
      - llvm-pass-hello-world: llvm/pass/hello-world.md
      - llvm-pass-hello-world: llvm/pass/hello-world.zh.md

# Theme
theme:
  name: material
  language: 'en'
  font:
    text: 'Lato'
    code: 'Fira Mono'
  features:
    - navigation.tabs
    - navigation.tabs.sticky
    - search.suggest
    - search.highlight
    - search.share
  palette:
    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: white
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to light mode

extra:
  # Default mkdocs-material alternate links for untranslated pages
  # https://squidfunk.github.io/mkdocs-material/setup/changing-the-language/#site-language-selector
  alternate:
    - name: English
      link: ""
      lang: en

    - name: 简体中文
      link: index.zh/
      lang: zh

markdown_extensions:
  - admonition
  - codehilite:
      guess_lang: false
      linenums: true
  - def_list
  - footnotes
  - meta
  - toc:
      permalink: ""
      slugify: !!python/name:pymdownx.slugs.uslugify
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.caret
  - pymdownx.critic
  - pymdownx.details
  - pymdownx.emoji:
      emoji_generator: !!python/name:pymdownx.emoji.to_svg
  - pymdownx.highlight:
      linenums: true
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.magiclink
  - pymdownx.mark
  - pymdownx.snippets
  - pymdownx.progressbar
  - pymdownx.smartsymbols
  - pymdownx.superfences:
      custom_fences:
        - name: math
          class: arithmatex
          format: !!python/name:pymdownx.arithmatex.fence_mathjax_format
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde