lore/mkdocs.yml at main · ButterStack/lore · 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: Lore Developer Documentation
# site_url is required for navigation.instant (sitemap.xml), social cards, and
# canonical URLs. GitHub Pages project site → trailing-slash base path.
site_url: https://epicgames.github.io/lore/
# Source repository: renders the header repo link and the per-page View-source
# button (content.action.view derives a blob/main/docs/ link from edit_uri).
# The "Edit this page" button is intentionally omitted — contributions go
# through Lore change requests, not direct GitHub edits to main. edit_uri
# assumes the default branch is `main`.
repo_url: https://github.com/EpicGames/lore
repo_name: EpicGames/lore
edit_uri: edit/main/docs/

theme:
  name: material
  logo: assets/icons/Lore_White_V1.svg
  favicon: assets/icons/Lore_Icon_White_V1.svg
  # Force dark-only — no auto switching, no light toggle.
  palette:
    - scheme: slate
      primary: custom
      accent: custom
  # Disable Material's Google Fonts loader; fonts are self-hosted in docs/assets/fonts/.
  font: false
  features:
    - navigation.instant
    - navigation.instant.prefetch   # start fetching a page on link hover
    - navigation.instant.progress   # top progress bar during instant nav
    - navigation.tracking
    - navigation.indexes
    - navigation.path               # breadcrumbs above the page title
    - navigation.top
    - navigation.footer             # prev/next links at the page bottom
    - search.suggest                # inline autocomplete of the last word
    - search.highlight              # highlight matches on the target page
    - search.share                  # shareable deep link to a search query
    - content.code.copy
    - content.code.annotate
    - content.code.select           # selectable code line ranges
    - content.tabs.link             # sync linked content tabs across the page
    - content.action.view           # "View source" button (GitHub, read-only)
    - toc.follow

extra_css:
  - assets/css/lore-docs.css

exclude_docs: |
  guides/
  proposals/
  specs/
  tutorials/*-template.md
  how-to/*-template.md
  reference/*-template.md
  explanation/*-template.md
  developing/decisions/adr-template.md
  # Bundled-font licensing notice — kept in-repo, excluded from the built site.
  assets/**/*.md
  # mkdocs hook source lives under assets/ but is config, not a published page.
  assets/hooks/

plugins:
  - search
  - awesome-pages

# Keep every section/subsection overview README out of the sidebar (they stay
# built and reachable by URL, and are linked from the homepage cards). The
# pattern matches README.md at any depth below the docs root, but never the root
# homepage. This lets the nav regenerate from the folder tree without
# per-section .pages files.
not_in_nav: |
  */**/README.md

# Site-layer presentation for ADRs: render the frontmatter (status, date,
# deciders, …) as a table under each H1. Source ADR files are left untouched.
# Comment-delimited tab groups (<!-- tabs:start/end -->) → Material content
# tabs; convention documented in docs/developing/doc-standards/canon/format.md.
hooks:
  - docs/assets/hooks/adr_meta.py
  - docs/assets/hooks/content_tabs.py

markdown_extensions:
  - gfm_admonition
  - admonition
  - attr_list
  - md_in_html
  - tables
  - toc:
      permalink: true
  - pymdownx.details
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.tabbed:
      alternate_style: true