zerozstack/mkdocs.yml at main · ZeroZ4j/zerozstack · 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
site_name: ZeroZ Stack
site_description: >-
  Pure-Java full-stack framework: Java UI compiled for the browser by TeaVM, binary RPC over a
  persistent WebSocket, and EclipseStore object-graph persistence.
site_url: https://stack.zeroz4j.com/
repo_url: https://github.com/ZeroZ4j/zerozstack
repo_name: ZeroZ4j/zerozstack
edit_uri: edit/main/docs/
copyright: Copyright &copy; Franz Schöning — Apache 2.0

theme:
  name: material
  features:
    - navigation.instant
    - navigation.tracking
    - navigation.sections
    - navigation.top
    - navigation.indexes
    - content.code.copy
    - content.code.annotate
    - content.action.edit
    - search.highlight
    - search.suggest
    - toc.follow
  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

markdown_extensions:
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - tables
  - toc:
      permalink: true
  - pymdownx.details
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
  - pymdownx.inlinehilite
  - pymdownx.superfences
  - pymdownx.snippets:
      base_path: [.]
      check_paths: true
  - pymdownx.tabbed:
      alternate_style: true

plugins:
  - search

nav:
  - Home: index.md

  - Get started:
      - Quickstart: start/quickstart.md
      - Examples: examples/index.md

  - Decide:
      - decide/index.md
      - Events, signals or LiveSync?: decide/events-vs-signals-vs-livesync.md
      - RMI or state sync?: decide/rmi-vs-state-sync.md
      - Local or shared signal?: decide/local-vs-shared-signal.md
      - Anti-patterns: decide/antipatterns.md

  - Guides:
      - Declaring the types that cross the wire: guides/data-models.md
      - Saving data: guides/persistence.md
      - Store modes — embedded or hosted: store-modes.md
      - Authentication and authorization: guides/security-auth.md
      - Logging in with OpenID Connect: guides/oidc-auth.md
      - Forms and binding: guides/ui-forms-and-validation.md
      - Stacking overlays: guides/ui-layering.md
      - Keyboard and naming: guides/ui-keyboard-and-naming.md
      - Accepting file uploads: guides/file-uploads.md
      - Packaging and running: guides/packaging.md
      - Answering in the reader's language: guides/language.md
      - Testing an application: guides/testing.md
      - Troubleshooting: guides/troubleshooting.md
      - Routing: ROUTING.md
      - Installing as an app (PWA): PWA.md
      - Signals: SIGNALS.md
      - Server events: SERVER_EVENTS.md
      - LiveSync: LIVESYNC.md
      - Validation: VALIDATION.md
      - UI components: UI_COMPONENTS.md

  - Reference:
      - Glossary: reference/glossary.md
      - Limitations: reference/limitations.md
      - Wire protocol: PROTOCOL.md

  - Explanation:
      - Architecture: ARCHITECTURE.md
      - Core concepts: CONCEPTS.md
      - Code walkthrough: CODE_WALKTHROUGH.md
      - Legacy getting started: GETTING_STARTED.md

  - Design proposals:
      - Transactions and concurrency: design/persistence-transactions.md
      - Language support: design/language-support.md

  - AI agents:
      - Agent prompts: AGENT_PROMPTS.md

  - Contribute:
      - Documentation style guide: contribute/docs-style-guide.md
      - Documentation rewrite plan: contribute/documentation-plan.md

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/ZeroZ4j/zerozstack
    - icon: fontawesome/solid/globe
      link: https://www.zeroz4j.com