v2/mkdocs.yml at main · SteelCompendium/v2 · 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
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
site_name: "Steel Compendium: Draw Steel Rules"
site_url: https://steelcompendium.io/v2
copyright: 'The Draw Steel Compendium is an independent product published under the DRAW STEEL Creator License and is not affiliated with MCDM Productions, LLC. DRAW STEEL © 2026 MCDM Productions, LLC.'
theme:
  name: "material"
  palette:
    # dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: custom
      accent: custom
      toggle:
        icon: material/toggle-switch
        name: Switch to light mode
    # Light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: custom
      accent: custom
      toggle:
        icon: material/toggle-switch-off-outline
        name: Switch to dark mode
  logo: Media/favicon.ico
  favicon: Media/favicon.ico
  custom_dir: overrides
  features:
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.top
    # Section index pages: attach a folder's index.md to the section header in
    # the sidebar (and tabs), so e.g. the "Culture" section links straight to
    # its index instead of rendering a redundant "Cultures" child entry. Every
    # generated Browse/Read/Bestiary folder ships an index.md (cards.go), whose
    # file.name == "index" makes Material's nav-item template pull it up. The
    # displayed label is the folder/section title; the index page title is only
    # used on the page itself.
    - navigation.indexes
    # Build-time perf: render only the active branch of the nav per page instead
    # of the full 3,097-item tree on every page. Material rebuilds the whole nav
    # per page (O(pages × nav-size)) — profiled as ~half the build; enabling prune
    # cut a local `mkdocs build` from ~614s to ~222s (-64%). Top-level tabs stay
    # via navigation.tabs. Incompatible only with navigation.expand (not used).
    # See .repo-docs/decisions/2026-06-05-ci-deploy-build-time-perf.md.
    - navigation.prune
    - search.suggest
    - search.highlight
    - navigation.instant
    # navigation.instant.preview disabled 2026-05-31: on link-heavy pages it ran
    # a render-time pass over every anchor (classes page = 8,494 links) building a
    # URL + resolving each and pre-wiring tooltip extraction, costing ~31s of
    # main-thread time. Profiled to RxJS (innerFrom.ts) self-time in resolve/URL/
    # getElements/extract. Paired with material.extensions.preview below. Revisit
    # if previews are wanted on small pages only (scope targets narrowly).
    # - navigation.instant.preview
    - navigation.path
    # Prev/next page links at the bottom of every page — primarily for Read
    # chapters (book-order reading). Order comes from the nav (.nav.yml files
    # already sort Read by source position).
    - navigation.footer
    - toc.follow
# Extensions
markdown_extensions:
  - footnotes
  - attr_list
  - md_in_html
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - def_list
  - pymdownx.critic
  - pymdownx.caret
  - pymdownx.keys
  - pymdownx.mark
  - pymdownx.tilde
  - 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
  - toc:
      permalink: true
      toc_depth: 1-8
      # Hover/link previews disabled 2026-05-31 — root cause of the ~31s render on
      # link-heavy pages (see navigation.instant.preview note above). Re-enable only
      # with a tightly scoped target include so link-dense pages (class/chapter
      # aggregates with thousands of anchors) are excluded.
      # - material.extensions.preview:
      #     configurations:
      #       - targets:
      #           include:
      #             - Browse/*
      #             - Read/*
      #             - Bestiary/*
extra:
  homepage: https://steelcompendium.io/v2
  analytics:
    provider: google
    property: G-PMF9SHHXNY
  # Bug-report Google Form (linked from footer + header bug icon).
  bug_report_url: 'https://docs.google.com/forms/d/e/1FAIpQLSc6m-pZ0NLt2EArE-Tcxr-XbAPMyhu40ANHJKtyRvvwBd2LSw/viewform?usp=sharing&ouid=105036387964900154878'
  # Build stamps shown in the footer. etl_* is written by the local `just`
  # recipes (steel-etl pipeline commit); site_* is written by CI from
  # $GITHUB_SHA right before gh-deploy. Committed empty; filled at build time.
  etl_sha: "a59b5a4"
  etl_date: "2026-08-20"
  site_sha: ""
  site_date: ""
plugins:
  - search
  - roamlinks
  - awesome-nav
extra_css:
  - stylesheets/palette.css
  - stylesheets/extra.css
  - stylesheets/custom_font.css
  - stylesheets/tables.css
  - stylesheets/mobile.css
  - stylesheets/print.css
  - stylesheets/steel-redesign.css
  - stylesheets/steel-settings.css
  - stylesheets/steel-cardhead.css
  - stylesheets/steel-class.css
  - stylesheets/steel-ability-cards.css
  - stylesheets/steel-kit.css
  - stylesheets/steel-statblock.css
  - stylesheets/steel-featureblock.css
  - stylesheets/steel-traits.css
  - stylesheets/steel-indexes.css
  - stylesheets/steel-bestiary.css
  - stylesheets/steel-copylink.css
  - stylesheets/steel-encounter.css
  - stylesheets/steel-dice.css
  - stylesheets/steel-export.css
  - stylesheets/steel-scale.css
  - stylesheets/steel-pins.css
  - stylesheets/steel-pageact.css
extra_javascript:
  # MathJax and Mermaid were removed: no generated page, source doc, static
  # override, or theme partial uses math ($$/arithmatex) or mermaid diagrams,
  # so these two CDN libraries were downloaded and parsed on every page for
  # nothing. Re-add the relevant one here if math or mermaid content is ever
  # introduced (the pymdownx.arithmatex / superfences-mermaid extensions that
  # produce the markup are still configured in markdown_extensions above).
  - https://unpkg.com/tablesort@5.3.0/dist/tablesort.min.js
  - javascripts/tablesort.js
  - javascripts/settings-core.js
  - javascripts/settings-panel.js
  - javascripts/ability-cards-core.js
  - javascripts/ability-cards.js
  - javascripts/steel-ability-cards.js
  - javascripts/sc-dice-core.js
  - javascripts/sc-dice.js
  - javascripts/statblock-preview.js
  - javascripts/sc-scale-core.js
  - javascripts/sc-scale.js
  - javascripts/steel-traits.js
  - javascripts/sc-facet-core.js
  - javascripts/steel-feature-browser-core.js
  - javascripts/steel-feature-browser.js
  - javascripts/steel-bestiary-browser.js
  - javascripts/sc-encounter-core.js
  - javascripts/sc-encounter.js
  - javascripts/browse-enhancements.js
  - javascripts/reading-progress.js
  - javascripts/keyboard-nav.js
  - javascripts/read-resume-core.js
  - javascripts/read-resume.js
  - javascripts/sc-pageact.js
  - javascripts/scc-headerlinks.js
  - javascripts/scc-card-copy-core.js
  - javascripts/scc-card-copy.js
  - javascripts/vendor/html-to-image.min.js
  - javascripts/sc-export.js
  - javascripts/sc-pins-core.js
  - javascripts/sc-pins.js
  - javascripts/nav-drawer-keep-core.js
  - javascripts/nav-drawer-keep.js