codexspec/mkdocs.yml at main · Zts0hg/codexspec · 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
site_name: CodexSpec
site_description: A Spec-Driven Development (SDD) toolkit for Claude Code
site_url: https://zts0hg.github.io/codexspec/
repo_url: https://github.com/Zts0hg/codexspec
repo_name: Zts0hg/codexspec
edit_uri: edit/main/docs/

# Documentation directory (parent folder containing all language subdirectories)
docs_dir: docs

# Exclude internal planning documents and i18n config from build
exclude_docs: |
  /plans/
  /i18n/
  /internal/

theme:
  name: material
  favicon: assets/images/codexspec-icon.svg
  logo: assets/images/codexspec-icon.svg
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: teal
      accent: teal
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: black
      accent: black
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.tracking
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - navigation.top
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.action.edit
  icon:
    repo: fontawesome/brands/github

nav:
  - Home: index.md
  - Getting Started:
    - Installation: getting-started/installation.md
    - Quick Start: getting-started/quick-start.md
  - User Guide:
    - Workflow: user-guide/workflow.md
    - Commands: user-guide/commands.md
    - Internationalization: user-guide/i18n.md
  - Case Studies:
    - PR Description Generator: case-studies/case-study-pr-description-generator.md
  - Reference:
    - CLI: reference/cli.md
    - Configuration: reference/configuration.md
  - Development:
    - Contributing: development/contributing.md
    - Scripts Architecture: development/scripts-architecture.md

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - admonition
  - pymdownx.details
  - attr_list
  - md_in_html
  - toc:
      permalink: true

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          paths: [src]
          options:
            show_source: true
            show_root_heading: true
  - i18n:
      docs_structure: folder
      reconfigure_search: false
      languages:
        - locale: en
          name: English
          default: true
          build: true
        - locale: zh
          name: 中文简体
          build: true
        - locale: ja
          name: 日本語
          build: true
        - locale: ko
          name: 한국어
          build: true
        - locale: es
          name: Español
          build: true
        - locale: fr
          name: Français
          build: true
        - locale: de
          name: Deutsch
          build: true
        - locale: pt-BR
          name: Português (Brasil)
          build: true

hooks:
  - hooks/post_build.py

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/Zts0hg/codexspec
  alternate:
    - name: English
      link: /codexspec/
      lang: en
    - name: 中文简体
      link: /codexspec/zh/
      lang: zh
    - name: 日本語
      link: /codexspec/ja/
      lang: ja
    - name: 한국어
      link: /codexspec/ko/
      lang: ko
    - name: Español
      link: /codexspec/es/
      lang: es
    - name: Français
      link: /codexspec/fr/
      lang: fr
    - name: Deutsch
      link: /codexspec/de/
      lang: de
    - name: Português (Brasil)
      link: /codexspec/pt-BR/
      lang: pt-BR

extra_css:
  - assets/stylesheets/extra.css