codebase-interface.github.io/mkdocs.yml at main · codebase-interface/codebase-interface.github.io · 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
site_name: Codebase Interface
site_description: A comprehensive set of principles and tools that promote ease of use of codebases across languages, frameworks, and audiences - including contributors, consumers, operators, AI agents, and build agents. Explore documentation, CLI tools, and implementation guides.
site_url: https://codebaseinterface.org
repo_url: https://github.com/codebase-interface/codebase-interface.github.io
repo_name: codebase-interface/codebase-interface.github.io
edit_uri: edit/main/

theme:
  name: material
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - navigation.top
    - navigation.tracking
    - search.highlight
    - search.share
    - search.suggest
    - content.code.copy
    - content.code.annotate
    - content.tabs.link
    - toc.integrate
    - header.autohide
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: blue
      accent: blue
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: blue
      accent: blue
      toggle:
        icon: material/brightness-4
        name: Switch to light mode

nav:
  - Home: index.md
  - About: about.md

extra_css:
  - assets/stylesheets/extra.css

extra_javascript:
  - assets/javascripts/extra.js

plugins:
  - search:
      lang: en
  - git-revision-date-localized:
      type: date
      enabled: !ENV [CI, false]
  - mermaid2
  - minify:
      minify_html: true
      minify_js: false
      minify_css: true

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets:
      base_path: .
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - admonition
  - pymdownx.details
  - attr_list
  - md_in_html
  - meta
  - toc:
      permalink: true
      title: On this page
  - abbr
  - def_list
  - footnotes

extra:
  analytics:
    provider: google
    property: !ENV GOOGLE_ANALYTICS_KEY
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/codebase-interface
      name: GitHub Organization
    - icon: fontawesome/brands/github
      link: https://github.com/codebase-interface/docs
      name: Documentation Repository
    - icon: fontawesome/brands/github
      link: https://github.com/codebase-interface/cli
      name: CLI Tools Repository
    - icon: fontawesome/brands/twitter
      link: https://twitter.com/codebaseinterface
      name: Follow us on Twitter
    - icon: fontawesome/brands/linkedin
      link: https://linkedin.com/company/codebase-interface
      name: Connect on LinkedIn
  version:
    provider: mike
    default: latest
  generator: false
  # External repository metadata for search and discovery
  external_repos:
    docs:
      name: "Documentation Hub"
      url: "https://github.com/codebase-interface/docs"
      description: "Comprehensive guides, templates, and specifications"
      topics: ["documentation", "templates", "guides", "specifications", "best-practices"]
    cli:
      name: "CLI Tools"
      url: "https://github.com/codebase-interface/cli"
      description: "Command-line tools for automation and validation"
      topics: ["cli", "automation", "validation", "generation", "tools"]

copyright: |
  &copy; 2023-2025 <a href="https://github.com/codebase-interface" target="_blank" rel="noopener">Codebase Interface Contributors</a><br>
  <a href="#__consent">Change cookie settings</a>