StudyLoop/mkdocs.yml at main · NetDevAutomate/StudyLoop · 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
site_name: StudyLoop
site_description: A local-first, AuDHD-aware study companion for active learning with AI mentors
site_url: https://netdevautomate.github.io/StudyLoop/

theme:
  name: material
  font: false
  logo: images/logo.png
  favicon: images/favicon.png
  palette:
    - scheme: default
      primary: blue grey
      accent: teal
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: blue grey
      accent: teal
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.sections
    - navigation.expand
    - toc.follow
    - search.highlight

plugins:
  - search
  - offline
  - privacy

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

extra_css:
  - stylesheets/audhd.css
  - stylesheets/fonts.css

extra_javascript:
  - javascripts/preferences.js

# Public documentation contract: new files stay out of the rendered site until
# they are explicitly rooted here and added to nav. Repository history, audits,
# plans, handoffs, ADRs, and agent instructions remain source-only by default.
exclude_docs: |
  **
  !/index.md
  !/first-week.md
  !/setup-guide.md
  !/study-plans.md
  !/web-ui-guide.md
  !/content-pipeline.md
  !/voice-output.md
  !/obsidian-export.md
  !/tui-guide.md
  !/agent-install.md
  !/cli-reference.md
  !/troubleshooting.md
  !/audhd-learning-philosophy.md
  !/roadmap.md
  !/architecture.md
  !/contributing.md
  !/images/**
  !/stylesheets/**
  !/javascripts/**

nav:
  - Home: index.md
  - Start Here:
    - Your First Week: first-week.md
    - Setup Guide: setup-guide.md
  - Study and Review:
    - Study Plans: study-plans.md
    - Web UI Guide: web-ui-guide.md
    - Content Pipeline: content-pipeline.md
    - Voice Output: voice-output.md
    - Obsidian Export: obsidian-export.md
  - Interfaces:
    - TUI Guide: tui-guide.md
    - Agent Installation: agent-install.md
  - Reference:
    - CLI Reference: cli-reference.md
    - Troubleshooting: troubleshooting.md
  - About:
    - AuDHD Learning Philosophy: audhd-learning-philosophy.md
    - Architecture Overview: architecture.md
    - Roadmap: roadmap.md
  - Contribute: contributing.md