DependencyControl/mkdocs.yml at main · TypesettingTools/DependencyControl · 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
site_name: DependencyControl
site_description: Dependency manager and automatic script updater for Aegisub macros and modules.
repo_url: https://github.com/TypesettingTools/DependencyControl

theme:
  name: material
  features:
    - content.code.copy # copy button on code blocks
    - content.tabs.link # selecting a language tab syncs every tab on the page
    - navigation.instant # SPA-style page loads
    - navigation.top # back-to-top button
    - search.suggest # autocomplete in the search box
    - search.highlight # highlight matches on the opened page
    - toc.follow # sidebar TOC tracks the reading position
  palette:
    # auto follows the OS setting; the toggle cycles auto -> light -> dark
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/brightness-auto
        name: Switch to light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to system preference

plugins:
  - search
  # expands `- API Reference: reference/` from the generated reference/SUMMARY.md
  - literate-nav:
      nav_file: SUMMARY.md

markdown_extensions:
  # Material's code-block stack; superfences also hosts the mermaid custom fence
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.superfences:
      # ```mermaid fences render as diagrams; Material bundles mermaid.js and themes it to the palette
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  # language-labeled code tabs; content.tabs.link keeps a reader's choice across the page
  - pymdownx.tabbed:
      alternate_style: true
  # anchor links on headings, so the in-page cross-references resolve
  - toc:
      permalink: true

extra:
  # mike maintains versions.json on the published site; Material shows its version picker when present
  version:
    provider: mike

nav:
  - Home: index.md
  - Design:
      - Updater Architecture: design/updater-architecture.md
  - API Reference: reference/