glaze/mkdocs.yml at main · makekryl/glaze · 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
site_name: Glaze Documentation
site_description: Extremely fast, in memory, JSON and interface library for modern C++
site_url: https://stephenberry.github.io/glaze/
repo_url: https://github.com/stephenberry/glaze
repo_name: stephenberry/glaze
edit_uri: edit/main/docs/

theme:
  name: material
  palette:
    # Palette toggle for automatic mode
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/brightness-auto
        name: Switch to light mode
    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: blue
      accent: blue
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: blue
      accent: blue
      toggle:
        icon: material/brightness-4
        name: Switch to system preference
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - navigation.path
    - navigation.top
    - search.highlight
    - search.share
    - content.action.edit
    - content.action.view
    - content.code.copy
    - content.code.annotate

plugins:
  - search
  - autorefs

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

nav:
 - Home: index.md
 - Getting Started:
   - Installation: installation.md
   - Quick Start: quick-start.md
   - Compile Time Options: options.md
   - Optimizing Performance: optimizing-performance.md
   - Rename Keys: rename-keys.md
   - Skip Keys: skip-keys.md
   - Generic JSON: generic-json.md
 - Reflection:
   - Pure Reflection: pure-reflection.md
   - Modify Reflection: modify-reflection.md
 - Formats:
   - JSON: json.md
   - TOML: toml.md
   - CSV: csv.md
   - BEVE (binary): binary.md
   - Stencil/Mustache: stencil-mustache.md
   - EETF: EETF/erlang-external-term-format.md
 - Serialization/Parsing:
   - Exceptions: exceptions.md
   - Wrappers: wrappers.md
   - Custom Wrappers: custom-wrappers.md
   - Custom Serialization: custom-serialization.md
   - Variant Handling: variant-handling.md
   - Unknown Keys: unknown-keys.md
   - JSON Pointer Syntax: json-pointer-syntax.md
   - JMESPath: JMESPath.md
   - JSON Schema: json-schema.md
   - Field Validation: field-validation.md
   - Partial Read/Write:
     - Partial Read: partial-read.md
     - Partial Write: partial-write.md
   - Max Float Precision: max-float-precision.md
   - Ranges: ranges.md
 - Networking:
   - networking/http-rest-support.md
   - networking/http-server.md
   - networking/http-router.md
   - networking/rest-registry.md
   - networking/tls-support.md
   - networking/http-client.md
   - networking/websocket-client.md
   - networking/advanced-networking.md
   - networking/http-examples.md
 - RPC:
   - REPE RPC: rpc/repe-rpc.md
   - REPE Buffer Handling: rpc/repe-buffer.md
   - REPE Plugin Interface: rpc/repe-plugin.md
   - JSON-RPC 2.0 Registry: rpc/jsonrpc-registry.md
   - JSON-RPC 2.0 Client/Server: rpc/json-rpc.md
   - REPE to JSON-RPC: rpc/repe-jsonrpc-conversion.md
 - Interface Utilities:
   - JSON Include: json-include.md
   - CLI Menu: cli-menu.md
   - Glaze Interfaces: glaze-interfaces.md
   - Building Shared Libraries: building-shared-libraries.md
   - Advanced API Usage: advanced-api-usage.md
 - Data Recording/Logging:
   - Time Trace Profiles: time-trace.md
   - Data Recorder: recorder.md
 - Threading:
   - Thread Pool: thread-pool.md
   - Volatile Support: volatile-support.md
 - FAQ: FAQ.md

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/stephenberry/glaze
      name: GitHub Repository
    - icon: fontawesome/solid/star
      link: https://github.com/stephenberry/glaze/stargazers
      name: Star on GitHub

copyright: Copyright &copy; 2025 Stephen Berry