Video-Generation-101/mkdocs.yml at main · GVCLab/Video-Generation-101 · 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
site_name: Video Generation 101
site_description: 从生成原理、系统能力、世界理解到真实应用与验证的视频生成知识体系
site_author: Xiaodong Cun, GVC Lab, Great Bay University
site_url: https://gvclab.github.io/Video-Generation-101/
repo_url: https://github.com/GVCLab/Video-Generation-101
repo_name: GVCLab/Video-Generation-101
edit_uri: edit/main/
copyright: MIT License &middot; GVC Lab, Great Bay University

# The repository is browsed on GitHub as much as on the site, so the whole repo
# is the docs root. That keeps every existing relative link (docs/x.md,
# ../../assets/y.png) working identically in both places.
docs_dir: .mkdocs-build/docs
site_dir: _site
use_directory_urls: false

not_in_nav: |
  sources/*

theme:
  name: material
  language: zh
  icon:
    repo: fontawesome/brands/github
  features:
    - navigation.instant
    - navigation.tracking
    - navigation.top
    - navigation.indexes
    - navigation.footer
    - toc.follow
    - search.suggest
    - search.highlight
    - search.share
    - content.code.copy
    - content.action.edit
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/weather-night
        name: 切换到深色模式
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/weather-sunny
        name: 切换到浅色模式

plugins:
  - search:
      lang:
        - zh
        - en

markdown_extensions:
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - tables
  - toc:
      permalink: true
      toc_depth: 3
  - pymdownx.details
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.superfences:
      custom_fences:
        # The chapters write display equations as ```math fences (GitHub style).
        - name: math
          class: arithmatex
          format: !!python/object/apply:pymdownx.arithmatex.arithmatex_fenced_format
            kwds:
              mode: generic
              tag: pre
        # Material for MkDocs initializes Mermaid diagrams from this class.
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format

extra_javascript:
  - assets/js/mathjax.js
  - https://unpkg.com/mathjax@3/es5/tex-mml-chtml.js

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/GVCLab
    - icon: fontawesome/solid/flask
      link: https://gvclab.github.io/