-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathmkdocs.yml
194 lines (147 loc) · 4.59 KB
/
mkdocs.yml
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
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
###############################################################################
# Project Information
################################################################################
site_name: Getty
site_description: A (de)serialization framework for Zig
site_url: https://getty.so/
repo_name: getty-zig/getty
repo_url: https://github.com/getty-zig/getty
edit_uri: https://github.com/getty-zig/getty.so/edit/main/docs/
copyright: © 2023 Jason Phan
################################################################################
# Theme
################################################################################
theme:
name: material
font:
text: Fira Sans
icon:
logo: material/circle-multiple
repo: fontawesome/brands/github
favicon: assets/images/getty-favicon-solid-large.png
palette:
media: "(prefers-color-scheme: dark)"
scheme: slate
custom_dir: docs/overrides
features:
# Enables tooltips.
- content.tooltips
# Enables code annotations.
- content.code.annotate
# Enables code copying.
- content.code.copy
# Enables navigation footer.
- navigation.footer
# Clicks on internal links won't fully reload the page.
- navigation.instant
# Enables sections to have documents attached to them.
- navigation.indexes
# Enables tabs in the top bar.
- navigation.tabs
# Back to Top button.
- navigation.top
# Automatically scroll ToC.
- toc.follow
# Enable search suggestions.
- search.suggest
################################################################################
# Extra
################################################################################
extra:
generator: false
social:
- icon: fontawesome/brands/github
link: https://github.com/getty-zig
- icon: fontawesome/brands/discord
link: https://discord.gg/njDA67U5ph
extra_css:
- stylesheets/extra.css
################################################################################
# Plugins
################################################################################
plugins:
# Enables blog
- blog:
blog_dir: blog/
post_readtime: false
archive: false
categories: false
post_url_format: "{slug}"
# For some reasion, 'paginate: false' doesn't work, so we'll just set the
# pagination to a ridiculous number.
pagination_per_page: 999
# Enables search.
- search
################################################################################
# Extensions
################################################################################
markdown_extensions:
# Enables tooltips.
- abbr
# Enables call-outs.
- admonition
# Enables annotations.
- attr_list
# Enables definition lists.
- def_list
# Enables Markdown inside of HTML.
- md_in_html
# Enables superscripts.
- pymdownx.caret
# Eanbles call-outs to be collapsible.
- pymdownx.details
# Enables icons and Emojis.
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
# Adds support for syntax highlighting.
- pymdownx.highlight:
anchor_linenums: true
# Adds support for inline syntax highlighting.
- pymdownx.inlinehilite
# Enables text hightlighting.
- pymdownx.mark
# Enables snippets.
- pymdownx.snippets:
auto_append:
- includes/abbreviations.md
# Enables arbitrary nesting of code and content blocks.
- pymdownx.superfences
# Enables subscripts.
- pymdownx.tilde
# Enables content tabs.
- pymdownx.tabbed:
alternate_style: true
# Enables task lists.
- pymdownx.tasklist:
custom_checkbox: true
# Enables tables.
- tables
################################################################################
# Documentation Layout
################################################################################
nav:
- Home:
- index.md
- User Guide:
- user-guide/index.md
- Tutorial:
- user-guide/tutorial/index.md
- user-guide/tutorial/setup.md
- user-guide/tutorial/interfaces.md
- user-guide/tutorial/serializers.md
- user-guide/tutorial/deserializers.md
- user-guide/tutorial/customization.md
- user-guide/installation.md
- Design:
- user-guide/design/index.md
- user-guide/design/architecture.md
- user-guide/design/values.md
- user-guide/design/data-models.md
- user-guide/design/blocks-and-tuples.md
- Blog:
- blog/index.md
- Contributing:
- contributing/index.md
- API Reference:
- https://docs.getty.so/