Files
HowToCook/.github/templates/mkdocs_template.yml
Anduin Xue a7d81fa681 Migrate from mkdocs to properdocs
- Replace mkdocs-with-pdf + weasyprint with properdocs>=1.6.7
- Add pymdown-extensions for richer markdown support
- Remove heavy apt dependencies (weasyprint, fonts-noto-cjk, wget, unzip)
- Switch build command from 'mkdocs build' to 'properdocs build --strict'
- Update template: add offline plugin, fix palette, add content.code.select/copy
- Add md_in_html, pymdownx.tilde, emoji, mermaid, annotation icon support
- Fix broken icon path material//weather-sunny

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
2026-05-04 13:20:03 +00:00

111 lines
2.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
- 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:
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:
- 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