-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathmkdocs.yml
127 lines (127 loc) · 3.65 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
site_name: Hypercubing Developers
site_url: https://dev.hypercubing.xyz/
docs_dir: docs/
repo_name: Hypercubers/dev.hypercubing.xyz
repo_url: https://github.com/Hypercubers/dev.hypercubing.xyz
edit_uri: edit/main/docs/
theme:
name: material
favicon: assets/images/favicon.png
logo: assets/images/logo.svg
palette:
# Palette toggle for light mode
- media: "(prefers-color-scheme: light)"
scheme: default
primary: black
accent: deep orange
toggle:
icon: material/brightness-7
name: Switch to dark mode
# Palette toggle for dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: black
accent: deep orange
toggle:
icon: material/brightness-4
name: Switch to light mode
features:
- content.action.edit
- content.code.copy
- navigation.footer
- navigation.instant
- navigation.sections
- navigation.top
- navigation.path
icon:
edit: material/pencil
extra:
social:
- icon: fontawesome/brands/github
link: https://github.com/Hypercubers
- icon: fontawesome/brands/discord
link: https://discord.gg/3hVSe8rDKa
extra_css:
- stylesheets/extra.css
markdown_extensions:
- admonition
- abbr
- attr_list
- footnotes
- pymdownx.caret
- pymdownx.tilde
- markdown.extensions.codehilite:
guess_lang: false
- markdown.extensions.toc:
permalink: true
- md_in_html
- pymdownx.details
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
- pymdownx.keys
- pymdownx.snippets:
auto_append:
- includes/abbreviations.md
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- pymdownx.tabbed:
alternate_style: true
- tables
- pymdownx.arithmatex:
generic: true
nav:
- Welcome: index.md
- Prerequisites: prereqs.md
- Hyperspeedcube:
- Puzzle Development:
- 1. Introduction: hsc/puzzle-dev/index.md
- 2. Puzzle Geometry: hsc/puzzle-dev/geometry.md
- 3. First Puzzle: hsc/puzzle-dev/first-puzzle.md
- Lua API Reference:
- hsc/lua/basics.md
- hsc/lua/puzzle-library.md
- hsc/lua/puzzle-generator-library.md
- hsc/lua/color-system-library.md
- Geometry:
- hsc/lua/geometry/space.md
- hsc/lua/geometry/blade.md
- hsc/lua/geometry/hyperplane.md
- hsc/lua/geometry/transform.md
- hsc/lua/geometry/symmetry.md
- hsc/lua/geometry/orbit.md
- hsc/lua/geometry/region.md
- Puzzle construction:
- hsc/lua/puzzle-construction/puzzle.md
- hsc/lua/puzzle-construction/colors.md
- hsc/lua/puzzle-construction/axes.md
- hsc/lua/puzzle-construction/twists.md
- hsc/lua/tags.md
- hsc/lua/versioning.md
- hsc/lua/common.md
- Conventions:
- Piece Types: hsc/conventions/piece-types.md
- Puzzle Versions: hsc/conventions/versions.md
- Internals:
- 1. Introduction: hsc/internals/index.md
- 2. Vectorspace GA: hsc/internals/vga.md
- 3. Projective GA: hsc/internals/pga.md
- 4. Conformal GA: hsc/internals/cga.md
- 5. Slicing: hsc/internals/slicing.md
- Other Software:
- Guidelines: other/guidelines.md
- Infrastructure:
- Server Setup: infrastructure/server.md
extra_javascript:
- javascripts/mathjax.js
- https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js
plugins:
- search
- glightbox
validation:
absolute_links: relative_to_docs
anchors: warn
unrecognized_links: warn