mirror of
https://github.com/Anduin2017/HowToCook.git
synced 2026-05-18 21:31:26 +08:00
- Add mkdocs-static-i18n to requirements.txt - Configure i18n plugin: zh (default) at root, en/ subfolder - Add language switcher (alternate) in extra config - Disable navigation.instant (incompatible with i18n switcher) - Add nav_translations for all category labels in English - Update readme-generate.js: dish/tip nav entries use path-only (mkdocs auto-uses page heading = English title for /en/ pages) - en/ folder to be populated by dotlang translation Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
145 lines
3.6 KiB
YAML
145 lines
3.6 KiB
YAML
site_name: How To Cook
|
|
|
|
# Repository
|
|
repo_name: Anduin2017/HowToCook
|
|
repo_url: https://github.com/Anduin2017/HowToCook
|
|
edit_uri: ""
|
|
|
|
use_directory_urls: true
|
|
docs_dir: .
|
|
theme:
|
|
font: false
|
|
name: material
|
|
language: zh
|
|
features:
|
|
- content.code.annotate
|
|
- content.code.select
|
|
- content.code.copy
|
|
# - content.tabs.link
|
|
# - header.autohide
|
|
# - navigation.expand
|
|
# - navigation.indexes
|
|
# - navigation.instant # Incompatible with mkdocs-static-i18n language switcher
|
|
- navigation.sections
|
|
- navigation.tabs
|
|
- navigation.tabs.sticky
|
|
- navigation.top
|
|
- navigation.footer
|
|
- navigation.tracking
|
|
- search.highlight
|
|
- search.share
|
|
- search.suggest
|
|
- toc.follow
|
|
# - toc.integrate
|
|
search_index_only: true
|
|
palette:
|
|
- media: "(prefers-color-scheme)"
|
|
toggle:
|
|
icon: material/link
|
|
name: Switch to light mode
|
|
- media: "(prefers-color-scheme: light)"
|
|
scheme: default
|
|
primary: indigo
|
|
accent: indigo
|
|
toggle:
|
|
icon: material/toggle-switch
|
|
name: Switch to dark mode
|
|
- media: "(prefers-color-scheme: dark)"
|
|
scheme: slate
|
|
primary: black
|
|
accent: indigo
|
|
toggle:
|
|
icon: material/toggle-switch-off
|
|
name: Switch to system preference
|
|
|
|
extra:
|
|
alternate:
|
|
- name: 简体中文
|
|
link: /zh/
|
|
lang: zh
|
|
- name: English
|
|
link: /en/
|
|
lang: en
|
|
icon:
|
|
annotation: material/arrow-right-circle
|
|
admonition:
|
|
note: octicons/tag-16
|
|
abstract: octicons/checklist-16
|
|
info: octicons/info-16
|
|
tip: octicons/squirrel-16
|
|
success: octicons/check-16
|
|
question: octicons/question-16
|
|
warning: octicons/alert-16
|
|
failure: octicons/x-circle-16
|
|
danger: octicons/zap-16
|
|
bug: octicons/bug-16
|
|
example: octicons/beaker-16
|
|
quote: octicons/quote-16
|
|
|
|
markdown_extensions:
|
|
- md_in_html
|
|
- admonition
|
|
- pymdownx.details
|
|
- pymdownx.superfences
|
|
- abbr
|
|
- pymdownx.snippets
|
|
- pymdownx.tilde
|
|
- def_list
|
|
- pymdownx.tasklist:
|
|
custom_checkbox: true
|
|
- attr_list
|
|
- pymdownx.emoji:
|
|
emoji_index: !!python/name:material.extensions.emoji.twemoji
|
|
emoji_generator: !!python/name:material.extensions.emoji.to_svg
|
|
- pymdownx.superfences:
|
|
custom_fences:
|
|
- name: mermaid
|
|
class: mermaid
|
|
format: !!python/name:pymdownx.superfences.fence_code_format
|
|
|
|
plugins:
|
|
- i18n:
|
|
docs_structure: folder
|
|
fallback_to_default: true
|
|
reconfigure_material: true
|
|
languages:
|
|
- locale: zh
|
|
default: true
|
|
name: 简体中文
|
|
build: true
|
|
- locale: en
|
|
name: English
|
|
build: true
|
|
nav_translations:
|
|
做菜之前: Before You Cook
|
|
菜谱: Recipes
|
|
按种类: By Category
|
|
素菜: Vegetarian Dishes
|
|
荤菜: Meat Dishes
|
|
水产: Seafood
|
|
早餐: Breakfast
|
|
主食: Staple Foods
|
|
半成品加工: Semi-finished Products
|
|
汤与粥: Soups & Porridge
|
|
饮料: Beverages
|
|
酱料和其它材料: Sauces & Seasonings
|
|
甜品: Desserts
|
|
进阶知识学习: Advanced Knowledge
|
|
- offline
|
|
- same-dir
|
|
- search
|
|
- minify:
|
|
minify_html: true
|
|
|
|
nav:
|
|
- README.md
|
|
- 做菜之前:
|
|
{{before}}
|
|
- 菜谱:
|
|
- 按种类: # 只有两层section以上才能出现navigation expansion https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/#navigation-sections
|
|
{{main}}
|
|
- 进阶知识学习:
|
|
{{after}}
|
|
- CONTRIBUTING.md
|
|
- CODE_OF_CONDUCT.md
|