-
Notifications
You must be signed in to change notification settings - Fork 5
/
mkdocs.yml
350 lines (334 loc) · 10.4 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
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
# Project Information
site_name: Spoofax
site_author: Spoofax Team
site_description: Spoofax language workbench
site_url: https://www.spoofax.dev/
# Copyright
copyright: "Copyright © 2010-2024 Spoofax Team"
# Repository
repo_name: spoofax
repo_url: https://github.com/metaborg/spoofax
edit_uri: https://github.com/metaborg/metaborg.github.io/edit/main/content
docs_dir: content/
# Configuration
theme:
name: material
language: en
custom_dir: overrides
features:
- navigation.tabs
- navigation.top
- navigation.indexes
- content.action.view
- content.action.edit
- content.code.select
- navigation.path
logo: assets/logo.svg
favicon: assets/favicon.png
icon:
logo: fontawesome/solid/sticky-note
repo: fontawesome/brands/github
font:
code: JetBrains Mono
palette:
# Light mode
- media: "(prefers-color-scheme: light)"
scheme: default
primary: deep purple
accent: amber
toggle:
icon: material/lightbulb
name: Switch to dark mode
# Dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: deep purple
accent: amber
toggle:
icon: material/lightbulb-outline
name: Switch to light mode
# Customization
extra:
tags:
Spoofax 2: spoofax2
Spoofax 3: spoofax3
extra_css:
- assets/stylesheets/extra.css
extra_javascript:
- assets/javascripts/mathjax.js
- https://polyfill.io/v3/polyfill.min.js?features=es6
- https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js
# Plugins
plugins:
- tags
- search
- git-revision-date-localized:
enable_creation_date: true
- macros:
module_name: tools/macro
include_dir: include
- bibtex:
bib_dir: "bibliographies"
# Extensions
markdown_extensions:
- abbr
- admonition
- attr_list
- def_list
- footnotes
- md_in_html
- pymdownx.arithmatex:
generic: true
- pymdownx.betterem:
smart_enable: all
- pymdownx.caret
- pymdownx.details
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
options:
custom_icons:
- overrides/.icons
- pymdownx.highlight:
guess_lang: false
- pymdownx.inlinehilite:
custom_inline:
- name: gui
class: guilabel
format: !!python/name:formatters.inline_span_format
- pymdownx.keys:
key_map:
click: "Click"
left-click: "Left Click"
right-click: "Right Click"
- pymdownx.magiclink
- pymdownx.mark
- pymdownx.saneheaders
- pymdownx.smartsymbols
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- pymdownx.tabbed:
alternate_style: true
slugify: !!python/object/apply:pymdownx.slugs.slugify
kwds:
case: lower
- pymdownx.tasklist:
custom_checkbox: true
- pymdownx.tilde
- toc:
permalink: true
# Navigation
nav:
- Home:
- index.md
- getting-started.md
- Tutorials:
- tutorials/index.md
- tutorials/start.md
- How-Tos:
- howtos/index.md
- Installation:
- howtos/installation/install-eclipse-bundle.md
- howtos/installation/install-eclipse-plugin-manually.md
- howtos/installation/install-from-source.md
- howtos/installation/install-spoofax-on-macos-arm.md
- Static Semantics:
- howtos/statix/index.md
- howtos/statix/debugging.md
- howtos/statix/migrating-from-nabl2.md
- howtos/statix/migrating-to-concurrent-solver.md
- howtos/statix/signature-generator.md
- Transformation:
- howtos/stratego/index.md
- howtos/stratego/generate-signature.md
- howtos/stratego/run-stratego-programs.md
- howtos/stratego/generate-pretty-printer.md
- howtos/stratego/debug-stratego.md
- howtos/stratego/concrete-syntax.md
- howtos/stratego/exchange-terms.md
- howtos/stratego/inspect-terms.md
- howtos/stratego/stratego-1-to-2.md
- Editor Services:
- howtos/editor-services/rename-refactoring.md
- Development:
- howtos/development/index.md
- howtos/development/spoofax-dev-requirements.md
- howtos/development/setup-maven-for-spoofax-dev.md
- howtos/development/build-spoofax.md
- howtos/development/develop-spoofax.md
- howtos/development/publish-spoofax.md
- howtos/development/troubleshooting.md
- howtos/development/custom-configuration.md
- Reference:
- references/index.md
- Configuration:
- references/config/index.md
- references/config/format.md
- references/config/language.md
- references/config/project.md
- references/config/examples.md
- SDF3:
- references/sdf3/index.md
- references/sdf3/modules.md
- references/sdf3/symbols.md
- references/sdf3/productions.md
- references/sdf3/lexical-syntax.md
- references/sdf3/context-free-syntax.md
- references/sdf3/kernel-syntax.md
- references/sdf3/start-symbols.md
- references/sdf3/templates.md
- references/sdf3/disambiguation.md
- references/sdf3/layout-sensitivity.md
- references/sdf3/recovery.md
- references/sdf3/configuration.md
- Statix:
- references/statix/index.md
- references/statix/concepts.md
- references/statix/modules.md
- references/statix/terms.md
- references/statix/basic-constraints.md
- references/statix/rules.md
- references/statix/scope-graphs.md
- references/statix/queries.md
- references/statix/tests.md
- references/statix/stratego-api.md
- Stratego:
- references/stratego/index.md
- references/stratego/lexical.md
- references/stratego/modules.md
- references/stratego/terms.md
- references/stratego/types.md
- references/stratego/rewrite-rules.md
- references/stratego/strategy-definitions.md
- references/stratego/strategy-combinators.md
- references/stratego/dynamic-rules.md
- references/stratego/troubleshooting.md
- ESV:
- references/esv/index.md
- references/esv/analysis.md
- references/esv/file-extensions.md
- references/esv/hover.md
- references/esv/menus.md
- references/esv/on-save.md
- references/esv/outline.md
- references/esv/parsing.md
- references/esv/reference-resolution.md
- references/esv/stratego.md
- references/esv/syntax-highlighting.md
- SPT:
- references/spt/index.md
- references/spt/test-suites.md
- references/spt/test-expectations.md
- references/spt/running-tests.md
- FlowSpec:
- references/flowspec/index.md
- references/flowspec/structure.md
- references/flowspec/Stratego_API.md
- references/flowspec/configuration.md
- references/flowspec/testing.md
- references/flowspec/references.md
- PIE:
- references/pie/index.md
- references/pie/modules.md
- references/pie/types.md
- references/pie/generics.md
- references/pie/functions.md
- references/pie/expressions.md
- references/pie/limitations.md
- Editor Services:
- references/editor-services/renaming.md
- Terms:
- references/terms/index.md
- references/terms/text-format.md
- Background:
- background/index.md
- Bibliography:
- background/bibliography/index.md
- background/bibliography/sdf3.md
- background/bibliography/statix.md
- background/bibliography/stratego.md
- background/bibliography/references.md
- Static Semantics:
- background/statix/index.md
- background/statix/rule-selection.md
- Transformations:
- background/stratego/index.md
- Strategic Rewriting:
- background/stratego/strategic-rewriting/term-rewriting.md
- background/stratego/strategic-rewriting/limitations-of-rewriting.md
- background/stratego/strategic-rewriting/traversal-with-rules.md
- background/stratego/strategic-rewriting/strategic-rewriting.md
- Strategy Combinators:
- background/stratego/strategy-combinators/sequential.md
- background/stratego/strategy-combinators/term.md
- background/stratego/strategy-combinators/traversal.md
- background/stratego/strategy-combinators/type-unifying.md
- background/stratego/origin-tracking.md
- Documentation:
- background/documentation/index.md
- background/documentation/pages.md
- background/documentation/internal-links.md
- background/documentation/code-highlighting.md
- background/documentation/guis-and-menus.md
- background/documentation/citations.md
- background/documentation/structure.md
- background/documentation/troubleshooting.md
- Support:
- support/index.md
- support/contributions.md
- Releases:
- release/stable.md
- release/develop.md
- Release Notes:
- release/note/2.5.22.md
- release/note/2.5.21.md
- release/note/2.5.20.md
- release/note/2.5.19.md
- release/note/2.5.18.md
- release/note/2.5.17.md
- release/note/2.5.16.md
- release/note/2.5.15.md
- release/note/2.5.14.md
- release/note/2.5.13.md
- release/note/2.5.12.md
- release/note/2.5.11.md
- release/note/2.5.10.md
- release/note/2.5.9.md
- release/note/2.5.8.md
- release/note/2.5.7.md
- release/note/2.5.6.md
- release/note/2.5.5.md
- release/note/2.5.4.md
- release/note/2.5.3.md
- release/note/2.5.2.md
- release/note/2.5.1.md
- release/note/2.5.0.md
- release/note/2.4.1.md
- release/note/2.4.0.md
- release/note/2.3.0.md
- release/note/2.2.1.md
- release/note/2.2.0.md
- release/note/2.1.0.md
- release/note/2.0.0.md
- release/note/2.0.0-beta1.md
- release/note/1.5.0.md
- release/note/1.4.0.md
- release/note/1.3.1.md
- release/note/1.3.0.md
- release/note/1.2.0.md
- release/note/1.1.0.md
- release/note/1.0.2.md
- release/note/1.0.0.md
- release/note/vnext.md
- Migration Guides:
- release/migrate/2.5.21.md
- release/migrate/2.5.15.md
- release/migrate/2.5.10.md
- release/migrate/2.5.5.md
- release/migrate/2.1.0.md
- release/migrate/2.0.0.md
- release/migrate/march2016_project_structure.md
- release/migrate/vnext.md