code-principles/mkdocs.yml at main · PeterRamotowski/code-principles · 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
site_name: Code Principles
site_description: A human-readable software engineering knowledge base and policy system for AI coding agents.
site_url: https://peterramotowski.github.io/code-principles/
repo_url: https://github.com/PeterRamotowski/code-principles
repo_name: PeterRamotowski/code-principles
edit_uri: edit/main/
docs_dir: .site-docs
site_dir: .site-build
use_directory_urls: true

hooks:
  - tools/docs_nav.py

theme:
  name: material
  language: en
  features:
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.indexes
    - navigation.top
    - navigation.footer
    - toc.follow
    - search.suggest
    - search.highlight
    - search.share
    - content.code.copy
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/weather-night
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode
  icon:
    repo: fontawesome/brands/github

plugins:
  - search

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

extra_css:
  - stylesheets/extra.css

extra_javascript:
  - javascripts/catalog-filter.js

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/PeterRamotowski/code-principles
      name: Code Principles on GitHub

validation:
  omitted_files: warn
  absolute_links: relative_to_docs
  unrecognized_links: warn