Skip to content

Commit 56d1691

Browse files
committed
Change documentation to HTML output
1 parent 2aea7a3 commit 56d1691

File tree

128 files changed

+18553
-2616
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

128 files changed

+18553
-2616
lines changed

Diff for: docs/Technical-docs/README.md

-54
This file was deleted.

Diff for: docs/Technical-docs/assets/highlight.css

+92
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
1+
:root {
2+
--light-hl-0: #001080;
3+
--dark-hl-0: #9CDCFE;
4+
--light-hl-1: #000000;
5+
--dark-hl-1: #D4D4D4;
6+
--light-hl-2: #0070C1;
7+
--dark-hl-2: #4FC1FF;
8+
--light-hl-3: #A31515;
9+
--dark-hl-3: #CE9178;
10+
--light-hl-4: #000000;
11+
--dark-hl-4: #C8C8C8;
12+
--light-hl-5: #008000;
13+
--dark-hl-5: #6A9955;
14+
--light-hl-6: #AF00DB;
15+
--dark-hl-6: #C586C0;
16+
--light-hl-7: #0000FF;
17+
--dark-hl-7: #569CD6;
18+
--light-hl-8: #267F99;
19+
--dark-hl-8: #4EC9B0;
20+
--light-hl-9: #795E26;
21+
--dark-hl-9: #DCDCAA;
22+
--light-code-background: #FFFFFF;
23+
--dark-code-background: #1E1E1E;
24+
}
25+
26+
@media (prefers-color-scheme: light) { :root {
27+
--hl-0: var(--light-hl-0);
28+
--hl-1: var(--light-hl-1);
29+
--hl-2: var(--light-hl-2);
30+
--hl-3: var(--light-hl-3);
31+
--hl-4: var(--light-hl-4);
32+
--hl-5: var(--light-hl-5);
33+
--hl-6: var(--light-hl-6);
34+
--hl-7: var(--light-hl-7);
35+
--hl-8: var(--light-hl-8);
36+
--hl-9: var(--light-hl-9);
37+
--code-background: var(--light-code-background);
38+
} }
39+
40+
@media (prefers-color-scheme: dark) { :root {
41+
--hl-0: var(--dark-hl-0);
42+
--hl-1: var(--dark-hl-1);
43+
--hl-2: var(--dark-hl-2);
44+
--hl-3: var(--dark-hl-3);
45+
--hl-4: var(--dark-hl-4);
46+
--hl-5: var(--dark-hl-5);
47+
--hl-6: var(--dark-hl-6);
48+
--hl-7: var(--dark-hl-7);
49+
--hl-8: var(--dark-hl-8);
50+
--hl-9: var(--dark-hl-9);
51+
--code-background: var(--dark-code-background);
52+
} }
53+
54+
:root[data-theme='light'] {
55+
--hl-0: var(--light-hl-0);
56+
--hl-1: var(--light-hl-1);
57+
--hl-2: var(--light-hl-2);
58+
--hl-3: var(--light-hl-3);
59+
--hl-4: var(--light-hl-4);
60+
--hl-5: var(--light-hl-5);
61+
--hl-6: var(--light-hl-6);
62+
--hl-7: var(--light-hl-7);
63+
--hl-8: var(--light-hl-8);
64+
--hl-9: var(--light-hl-9);
65+
--code-background: var(--light-code-background);
66+
}
67+
68+
:root[data-theme='dark'] {
69+
--hl-0: var(--dark-hl-0);
70+
--hl-1: var(--dark-hl-1);
71+
--hl-2: var(--dark-hl-2);
72+
--hl-3: var(--dark-hl-3);
73+
--hl-4: var(--dark-hl-4);
74+
--hl-5: var(--dark-hl-5);
75+
--hl-6: var(--dark-hl-6);
76+
--hl-7: var(--dark-hl-7);
77+
--hl-8: var(--dark-hl-8);
78+
--hl-9: var(--dark-hl-9);
79+
--code-background: var(--dark-code-background);
80+
}
81+
82+
.hl-0 { color: var(--hl-0); }
83+
.hl-1 { color: var(--hl-1); }
84+
.hl-2 { color: var(--hl-2); }
85+
.hl-3 { color: var(--hl-3); }
86+
.hl-4 { color: var(--hl-4); }
87+
.hl-5 { color: var(--hl-5); }
88+
.hl-6 { color: var(--hl-6); }
89+
.hl-7 { color: var(--hl-7); }
90+
.hl-8 { color: var(--hl-8); }
91+
.hl-9 { color: var(--hl-9); }
92+
pre, code { background: var(--code-background); }

Diff for: docs/Technical-docs/assets/main.js

+58
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Diff for: docs/Technical-docs/assets/material-style.css

+247
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,247 @@
1+
@import url("https://fonts.googleapis.com/css2?family=Space+Grotesk:wght@300;400;500;600;700&family=Space+Mono:ital,wght@0,400;0,700;1,400;1,700&display=swap");
2+
3+
:root,
4+
:root[data-theme="light"],
5+
:root[data-theme="dark"] {
6+
--font-sans: "Space Grotesk", sans-serif;
7+
--font-mono: "Space Mono", monospace;
8+
9+
--color-background: var(--md-sys-color-surface-container);
10+
--color-background-secondary: var(--md-sys-color-surface-container-high);
11+
--color-background-warning: var(--md-sys-color-error-container);
12+
--color-warning-text: var(--md-sys-color-on-error-container);
13+
--color-icon-background: var(--md-sys-color-on-primary);
14+
--color-accent: var(--md-sys-color-secondary-container);
15+
--color-active-menu-item: var(--md-sys-color-surface-container-highest);
16+
--color-text: var(--md-sys-color-on-surface);
17+
--color-text-aside: var(--md-sys-color-on-surface-variant);
18+
--color-link: var(--md-sys-color-primary);
19+
20+
--color-ts-project: var(--md-sys-color-secondary);
21+
--color-ts-module: var(--color-ts-project);
22+
--color-ts-namespace: var(--color-ts-project);
23+
24+
--color-ts-enum: var(--md-sys-color-tertiary);
25+
--color-ts-enum-member: var(--color-ts-enum);
26+
27+
--color-ts-variable: var(--md-sys-color-primary);
28+
--color-ts-function: var(--md-sys-color-secondary);
29+
--color-ts-class: var(--md-sys-color-tertiary);
30+
--color-ts-interface: var(--md-sys-color-tertiary);
31+
32+
--color-ts-constructor: var(--md-sys-color-inverse-primary);
33+
34+
--color-ts-property: var(--md-sys-color-on-background);
35+
--color-ts-method: var(--color-ts-function);
36+
37+
--color-ts-call-signature: var(--color-ts-method);
38+
--color-ts-index-signature: var(--color-ts-property); /* ? */
39+
--color-ts-constructor-signature: var(--color-ts-function);
40+
--color-ts-parameter: var(--md-sys-color-primary);
41+
42+
--color-ts-type-parameter: var(--md-sys-color-tertiary);
43+
--color-ts-accessor: var(--color-ts-property);
44+
--color-ts-get-signature: var(--color-ts-accessor);
45+
--color-ts-set-signature: var(--color-ts-accessor);
46+
--color-ts-type-alias: var(--md-sys-color-tertiary);
47+
48+
/* --external-icon: var(--md-sys-external-icon);
49+
--color-scheme: var(--md-sys-color-scheme); */
50+
51+
--top-app-bar-height: 4.5rem;
52+
--footer-height: 3.5rem;
53+
}
54+
55+
body {
56+
font-family: var(--font-sans);
57+
}
58+
code,
59+
pre {
60+
font-family: var(--font-mono);
61+
}
62+
63+
img {
64+
max-width: 100%;
65+
}
66+
67+
*::-webkit-scrollbar {
68+
width: 8px;
69+
height: 8px;
70+
}
71+
*::-webkit-scrollbar-track {
72+
background: none;
73+
}
74+
*::-webkit-scrollbar-thumb {
75+
border: none;
76+
}
77+
78+
.container-main {
79+
min-height: calc(100vh - var(--top-app-bar-height) - var(--footer-height));
80+
}
81+
.col-content {
82+
overflow: hidden;
83+
box-sizing: border-box;
84+
padding: 1.75rem;
85+
border-radius: 28px;
86+
background-color: var(--md-sys-color-surface);
87+
}
88+
.page-menu {
89+
height: fit-content;
90+
padding: 0.75rem 1.75rem;
91+
border-radius: 28px;
92+
background-color: var(--md-sys-color-surface);
93+
}
94+
.site-menu > *,
95+
.page-menu > * {
96+
position: relative;
97+
}
98+
.title {
99+
display: block;
100+
max-width: calc(100% - 5rem);
101+
white-space: nowrap;
102+
overflow: hidden;
103+
text-overflow: ellipsis;
104+
font-size: 22px;
105+
}
106+
107+
.tsd-page-toolbar {
108+
padding: 8px 0;
109+
height: calc(var(--top-app-bar-height) - 16px);
110+
background-color: var(--color-background);
111+
border-bottom: none;
112+
}
113+
.tsd-page-toolbar .tsd-toolbar-contents {
114+
height: 56px;
115+
}
116+
.tsd-page-toolbar .table-cell {
117+
height: 56px;
118+
margin-left: 1.5rem;
119+
}
120+
.tsd-page-toolbar .tsd-toolbar-icon {
121+
padding: 20px 0;
122+
}
123+
#tsd-search {
124+
line-height: 56px;
125+
border-radius: 22px;
126+
}
127+
#tsd-search .results {
128+
z-index: -1;
129+
top: calc(56px - 22px);
130+
padding-top: 22px;
131+
box-shadow: 0px 4px 2px rgba(0, 0, 0, 0.125);
132+
background-color: var(--color-background-secondary);
133+
border-bottom-left-radius: 22px;
134+
border-bottom-right-radius: 22px;
135+
overflow: hidden;
136+
}
137+
#tsd-search .results li {
138+
background: none;
139+
}
140+
#tsd-search .results a {
141+
padding: 1rem 0.25rem;
142+
}
143+
.col-sidebar {
144+
padding-top: 0;
145+
margin-right: 1rem;
146+
}
147+
148+
.tsd-signature {
149+
padding: 1rem 1.5rem;
150+
border-radius: 24px;
151+
background-color: var(--md-sys-color-surface-container);
152+
}
153+
154+
.tsd-page-navigation ul {
155+
padding-left: 0.44rem;
156+
}
157+
.tsd-navigation a,
158+
.tsd-navigation summary > span,
159+
.tsd-page-navigation a {
160+
padding: 0.88rem;
161+
border-radius: 24px;
162+
}
163+
.tsd-navigation a:hover,
164+
.tsd-page-navigation a:hover {
165+
text-decoration: none;
166+
background-color: var(--md-sys-color-surface-container-high);
167+
}
168+
.page-menu .tsd-accordion-summary svg {
169+
position: absolute;
170+
right: 0;
171+
}
172+
.site-menu .tsd-navigation .tsd-accordion-summary {
173+
display: flex;
174+
flex-direction: row-reverse;
175+
width: 100%;
176+
}
177+
178+
.tsd-small-nested-navigation {
179+
margin-left: 1rem;
180+
}
181+
.tsd-nested-navigation {
182+
margin-left: 2.5rem;
183+
}
184+
.tsd-nested-navigation > li > a,
185+
.tsd-nested-navigation > li > span {
186+
width: 100%;
187+
}
188+
.tsd-navigation > a,
189+
.tsd-navigation .tsd-accordion-summary {
190+
width: 100%;
191+
}
192+
.tsd-index-accordion .tsd-accordion-summary > svg {
193+
position: absolute;
194+
right: 1.5rem;
195+
margin-top: 1rem;
196+
}
197+
.tsd-accordion-summary .tsd-kind-icon ~ span {
198+
margin-right: 2.5rem;
199+
}
200+
.tsd-accordion-summary .tsd-nested-navigation > li > a,
201+
.tsd-nested-navigation > li > span {
202+
width: calc(100% - 0.44rem);
203+
}
204+
.tsd-kind-icon ~ span {
205+
white-space: nowrap;
206+
overflow: hidden;
207+
text-overflow: ellipsis;
208+
}
209+
.tsd-generator {
210+
padding: 0;
211+
border-top: none;
212+
height: var(--footer-height);
213+
line-height: var(--footer-height);
214+
}
215+
.tsd-generator > p {
216+
padding: 0 2rem;
217+
}
218+
219+
@media (max-width: 769px) {
220+
.container {
221+
padding: 1rem;
222+
}
223+
.col-sidebar {
224+
margin-right: 0;
225+
}
226+
}
227+
@media (min-width: 770px) {
228+
.container-main {
229+
margin: 0 auto;
230+
}
231+
.site-menu {
232+
margin-right: 0.5rem;
233+
}
234+
}
235+
@media (min-width: 1200px) {
236+
.page-menu,
237+
.site-menu {
238+
max-height: calc(100vh - var(--footer-height) - var(--top-app-bar-height));
239+
top: var(--top-app-bar-height);
240+
}
241+
.page-menu {
242+
margin-left: 1rem;
243+
}
244+
.col-sidebar {
245+
margin-right: 0;
246+
}
247+
}

Diff for: docs/Technical-docs/assets/search.js

+1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)