shadlet/mkdocs.yml at main · programmersd21/shadlet · 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
site_name: shadlet
site_description: python-first web applications with a genuine shadcn/ui renderer
docs_dir: docs
site_dir: site

theme:
  name: material
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - navigation.top
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.tabs.link
  palette:
    - scheme: default
      primary: neutral
      accent: neutral
      toggle:
        icon: material/brightness-7
        name: switch to dark mode
    - scheme: slate
      primary: neutral
      accent: neutral
      toggle:
        icon: material/brightness-4
        name: switch to light mode

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

plugins:
  - search

nav:
  - home: index.md
  - getting started:
      - introduction: getting-started/index.md
      - installation: getting-started/installation.md
      - first app: getting-started/first-app.md
      - project structure: getting-started/project-structure.md
  - guides:
      - applications: guides/applications.md
      - components: guides/components.md
      - layouts: guides/layouts.md
      - state: guides/state.md
      - events: guides/events.md
      - routing: guides/routing.md
      - forms: guides/forms.md
      - icons: guides/icons.md
      - server-driven data tables: guides/data-tables.md
      - background tasks: guides/background-tasks.md
      - query parameter state: guides/query-parameters.md
      - http uploads: guides/uploads.md
      - react extensions: extensions.md
      - themes: guides/themes.md
      - agent skills: guides/agent-skills.md
      - deployment: guides/deployment.md
  - components:
      - overview: components/index.md
      - catalogue: components/catalogue.md
  - templates:
      - overview: project-templates/index.md
      - github templates: project-templates/github.md
  - architecture:
      - overview: architecture/index.md
      - protocol: architecture/protocol.md
      - renderer: architecture/renderer.md
      - runtime: architecture/runtime.md
      - security: architecture/security.md
  - reference:
      - python api: reference/python-api.md
      - configuration: reference/configuration.md
      - cli: reference/cli.md
      - compatibility: reference/compatibility.md
  - development:
      - contributing: development/contributing.md
      - testing: development/testing.md
      - performance: development/performance.md
      - migration from 0.3.0: development/migration-0.3-to-0.4.md
      - migration from 0.4.0: development/migration-0.4-to-0.5.md
      - migration from 0.5.0: development/migration-0.5-to-0.6.md
      - releases: development/releases.md
  - changelog: changelog.md
  - troubleshooting:
      - common issues: troubleshooting/index.md
      - faq: faq.md
      - limitations: limitations.md