learningz/mkdocs.yml at main · zmath01/learningz · 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
137
138
139
140
141
site_name: Deep-dive into Valuable Math
site_description: Deep-dive into Valuable Math
site_author: zmath01
site_url: https://zmath01.github.io/learningz/
repo_name: github.com/zmath01/learningz
repo_url: https://github.com/zmath01/learningz

# ──────────────────────────────────────────────
# Theme Configuration (Material for MkDocs)
# ──────────────────────────────────────────────
theme:
  name: material
  custom_dir: overrides
  language: en
  palette:
    - scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - navigation.top
    - navigation.indexes          # generate index pages for sections
    - navigation.footer           # prev/next at bottom
    - search.suggest
    - search.highlight            # highlight search results
    - search.share
    - content.code.copy
    - content.action.edit
    - content.action.view
    - content.tabs.link           # link tabs across pages
  font: false                     # system fonts (faster)
  logo: assets/logo.png
  favicon: assets/logo.png

# ──────────────────────────────────────────────
# Markdown Extensions
# ──────────────────────────────────────────────
markdown_extensions:
  # Admonitions / callouts
  - admonition
  - attr_list
  - md_in_html

  # Details/summary collapsible
  - pymdownx.details

  # Code fences (including mermaid diagrams)
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format

  # Tabbed content
  - pymdownx.tabbed:
      alternate_style: true

  # Syntax highlighting with line numbers
  - pymdownx.highlight:
      linenums: true
      line_spans: __span
      pygments_lang_class: true
      anchor_linenums: true      # clickable line number anchors

  # LaTeX / MathJax support
  - pymdownx.arithmatex:
      generic: true

  - pymdownx.inlinehilite
  - pymdownx.snippets

  # Task lists
  - pymdownx.tasklist:
      custom_checkbox: true

  # Table of contents (right sidebar)
  - toc:
      permalink: true

# ──────────────────────────────────────────────
# Navigation Structure
# ──────────────────────────────────────────────
# Navigation is auto-generated from the docs/ directory tree (no manual `nav`).
# Control order via numeric filename prefixes (e.g. 01_*, 02_*); control section
# titles via a per-folder index.md (used by the navigation.indexes feature).

# ──────────────────────────────────────────────
# Plugins
# ──────────────────────────────────────────────
plugins:
  - search

# ──────────────────────────────────────────────
# JavaScript: MathJax + Enhancements
# ──────────────────────────────────────────────
extra_javascript:
  # MathJax configuration (must load BEFORE the library loader)
  - javascripts/mathjax.js
  # MathJax loader: loads the local bundle, falls back to CDN on failure
  - javascripts/mathjax-loader.js
  # Site-wide enhancements (scroll progress, code/link analytics)
  - javascripts/site.js
  # Video player enhancements (Manim animations)
  - javascripts/video-player.js

# ──────────────────────────────────────────────
# CSS: Custom Styles
# ──────────────────────────────────────────────
extra_css:
  - stylesheets/extra.css
  - stylesheets/video.css

# ──────────────────────────────────────────────
# Extra Configuration
# ──────────────────────────────────────────────
extra:
  umami:
    # Privacy-friendly visitor analytics (https://umami.is). Fill in BOTH
    # values to enable; leave empty to keep analytics disabled.
    # url: your Umami script endpoint, e.g. https://analytics.example.com/script.js
    # id:  your Umami website ID (the data-website-id value)
    url: ""
    id: ""
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/zmath01
    - icon: fontawesome/brands/gitlab
      link: https://gitlab.com/zmath01

copyright: Copyright &copy; 2026 zmath01 — <a href="https://creativecommons.org/licenses/by-nc-sa/4.0/">CC BY-NC-SA 4.0</a>