pokemonautomation.github.io/mkdocs.yml at main · PokemonAutomation/pokemonautomation.github.io · GitHub

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
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
site_name: Pokémon Automation
site_url: https://pokemonautomation.github.io
repo_url: https://github.com/PokemonAutomation/ComputerControl
repo_name: PokemonAutomation/ComputerControl
# If true (default), use_directory_urls convert every md file not named index.md, <path>/<filename>.md, into
# <path/<filename>/index.html so the website viewers can use the link <path>/<filename> to view the page,
# hiding .html extension. But this messes up the image asset links in those md files. In order to view images
# both on the website and in the Github repo pages, we set use_directory_urls to false so eavery md file
# is converted into <path>/<filename>.html. This preserves the folder hierarchy when converted to website.
use_directory_urls: false

theme:
  logo: assets/original_logo_no_background.png  # logo shown on webpage
  favicon: assets/logo.png  # brower tab icon
  name: material
  features:
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.expand
    - toc.follow
    - toc.integrate
    - search.suggest
    - search.highlight
  palette:
    # Palette toggle for automatic mode
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/brightness-auto
        name: Switch to light mode
    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: teal
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: teal
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode

# Defines the navigation tab bar on PC / dropdown menu on mobile
nav:
  - Home: index.md
  - Getting Started:
      - SetupGuide/index.md
      - Controllers: SetupGuide/Controllers
  - Programs:
      - Programs/index.md
      - NintendoSwitch: Programs/NintendoSwitch
      - PokemonLGPE: Programs/PokemonLGPE
      - PokemonSwSh: Programs/PokemonSwSh
      - PokemonBDSP: Programs/PokemonBDSP
      - PokemonLA: Programs/PokemonLA
      - PokemonSV: Programs/PokemonSV
      - PokemonLZA: Programs/PokemonLZA
      - PokemonFRLG: Programs/PokemonFRLG
      - PokemonHome: Programs/PokemonHome
      - ZeldaTotK: Programs/ZeldaTotK
  - Controllers: ControllerList.md
  - Discord Integration:
      - Overview: DiscordIntegration/index.md
      - Discord Bot: DiscordIntegration/DiscordBot.md
      - Discord Webhooks: DiscordIntegration/DiscordWebhooks.md
  - Developer:
      - Overview: Developer/index.md
      - Knowledge Requirement: Developer/Knowledge.md
      - How to Use Github: Developer/Git.md
      - Tutorial Button Script: Developer/TutorialMC.md
      - Tutorial Home Sorter: Developer/TutorialCC.md
      - Development Topics: Developer

plugins:
  # Create social cards for link preview
  # https://squidfunk.github.io/mkdocs-material/setup/setting-up-social-cards/
  # This only works if "site_url" is set in mkdocs.yml.
  # Note: Chinese pages disable social cards (via frontmatter) due to the fonts are broken on the cards
  - social
  - search
  - i18n:
      docs_structure: suffix
      fallback_to_default: true
      reconfigure_material: true
      reconfigure_search: true
      languages:
        - locale: en
          default: true
          name: English
          build: true
        - locale: zh-CN
          name: 简体中文
          build: true
          theme:
            language: zh
          nav_translations:
            Home: 主页
            Getting Started: 上手指南
            Programs: 自动化程序
            Controllers: 单片机支持
            Discord Integration: Discord整合
            Developer: 开发者
  - include_dir_to_nav

# Hook to fix relative paths in translated pages
hooks:
  - hooks/i18n_path_fix.py

# Language switcher configuration
extra:
  alternate:
    - name: English
      link: /
      lang: en
    - name: 简体中文
      link: /zh-CN/
      lang: zh-CN

extra_css: [style.css]

# extensions
markdown_extensions:
  - toc:
      permalink: true
  - attr_list

# Exclude unused docs from being generated into webpages
# https://www.mkdocs.org/user-guide/configuration/#exclude_docs
exclude_docs: |
  /z_TestHome.md
  /z_TemplateProgramPage.md