github-agent/mkdocs.yml at main · paulmann/github-agent · 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
site_name: github-agent
site_description: >-
  Repository and wiki steward: one command per documentation job, standard library
  only, exit codes 0/1/2 and findings as file:line plus a rule id.
site_url: https://paulmann.github.io/github-agent/
repo_url: https://github.com/paulmann/github-agent
repo_name: paulmann/github-agent
edit_uri: edit/main/docs/
docs_dir: docs
copyright: MIT licensed

# Links written for the repository (`../AGENTS.md`) are rewritten to the file on GitHub:
# a rendered site has no parent directory, so the same link would 404.
hooks:
    - hooks/repo_links.py

extra:
    repo_branch: main

theme:
  name: material
  language: en
  features:
    - navigation.sections
    - navigation.top
    - content.code.copy
    - content.action.edit
    - search.highlight
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle:
        icon: material/brightness-7
        name: Switch to the dark scheme
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to the light scheme

nav:
  - Home: index.md
  - Install: IMPORT.md
  - Rules: RULES.md
  - Architecture: ARCHITECTURE.md
  - Wiki workflow: WIKI.md
  - Packaging: PACKAGING.md
  - Procedures: PROCEDURES.md
  - Field notes: FIELD-NOTES.md

# The Russian copies mirror their English originals; they are reachable from the
# repository, not from the site navigation.
not_in_nav: |
  *.ru.md

markdown_extensions:
  - admonition
  - attr_list
  - tables
  - toc:
      permalink: true
  - pymdownx.details
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true

# The site is a rendering of documents that already live in the repository, and those
# documents link to sibling files outside docs/ (`../AGENTS.md`). On GitHub those links
# resolve; in a site they cannot. The report is a note, and `ghagent doc` remains the
# checker that fails on a broken link.
validation:
  omitted_files: info
  not_found: info
  absolute_links: info
  unrecognized_links: info