Skip to content

Commit b42c069

Browse files
pklaschkapklaschka
authored
Merge pull request #431 from wuespace/fix/frontend-api-reference-generation
2 parents c46782b + af6276d commit b42c069

4 files changed

Lines changed: 97 additions & 72 deletions

File tree

‎docs/docker-compose.yml‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,11 @@ services:
4747
&& mv /tmp/docs-output/* /docs
4848
"
4949
volumes:
50-
- ../frontend-react:/app
50+
- ../frontend-react/package.json:/app/package.json
51+
- ../frontend-react/src:/app/src
52+
- ../frontend-react/typedoc.json:/app/typedoc.json
53+
- ../frontend-react/tsconfig.json:/app/tsconfig.json
54+
- ../frontend-react/tsconfig.node.json:/app/tsconfig.node.json
5155
- frontend-react-docs:/docs
5256
profiles:
5357
- deps

‎docs/docs/_css/custom.css‎

Lines changed: 82 additions & 67 deletions
Original file line numberDiff line numberDiff line change
@@ -1,115 +1,130 @@
11
[data-md-color-scheme="slate"] {
2-
--md-hue: 255;
2+
--md-hue: 255;
33
}
44

55
[data-md-color-scheme="slate"] img.invertible {
6-
filter: invert(1) hue-rotate(180deg) brightness(2);
7-
mix-blend-mode: screen;
6+
filter: invert(1) hue-rotate(180deg) brightness(2);
7+
mix-blend-mode: screen;
88
}
99

1010
:root {
11-
--md-primary-fg-color: #452897;
12-
--md-primary-fg-color--light: #704ed2;
13-
--md-primary-fg-color--dark: #1f0e4f;
14-
--md-accent-fg-color: #452897;
15-
--md-accent-fg-color--light: #704ed2;
16-
--md-accent-fg-color--dark: #1f0e4f;
17-
18-
--md-text-font: "Roboto", Arial, sans-serif;
19-
--md-code-font: "Roboto Mono", monospace;
11+
--md-primary-fg-color: #452897;
12+
--md-primary-fg-color--light: #704ed2;
13+
--md-primary-fg-color--dark: #1f0e4f;
14+
--md-accent-fg-color: #452897;
15+
--md-accent-fg-color--light: #704ed2;
16+
--md-accent-fg-color--dark: #1f0e4f;
17+
18+
--md-text-font: "Roboto", Arial, sans-serif;
19+
--md-code-font: "Roboto Mono", monospace;
2020
}
2121

2222
.md-banner a {
23-
color: white;
24-
text-decoration: underline;
23+
color: white;
24+
text-decoration: underline;
2525
}
2626

2727
.md-banner a:hover {
28-
color: white;
29-
text-decoration: none;
28+
color: white;
29+
text-decoration: none;
3030
}
3131

3232
/*Fonts*/
3333

3434
@font-face {
35-
font-family: 'Roboto';
36-
font-style: normal;
37-
font-weight: 300;
38-
font-display: fallback;
39-
src: url(./Roboto/Roboto-Light.ttf);
35+
font-family: "Roboto";
36+
font-style: normal;
37+
font-weight: 300;
38+
font-display: fallback;
39+
src: url(./Roboto/Roboto-Light.ttf);
4040
}
4141

4242
@font-face {
43-
font-family: 'Roboto';
44-
font-style: italic;
45-
font-weight: 300;
46-
font-display: fallback;
47-
src: url(./Roboto/Roboto-LightItalic.ttf);
43+
font-family: "Roboto";
44+
font-style: italic;
45+
font-weight: 300;
46+
font-display: fallback;
47+
src: url(./Roboto/Roboto-LightItalic.ttf);
4848
}
4949

5050
@font-face {
51-
font-family: 'Roboto';
52-
font-style: normal;
53-
font-weight: 400;
54-
font-display: fallback;
55-
src: url(./Roboto/Roboto-Regular.ttf);
51+
font-family: "Roboto";
52+
font-style: normal;
53+
font-weight: 400;
54+
font-display: fallback;
55+
src: url(./Roboto/Roboto-Regular.ttf);
5656
}
5757

5858
@font-face {
59-
font-family: 'Roboto';
60-
font-style: italic;
61-
font-weight: 400;
62-
font-display: fallback;
63-
src: url(./Roboto/Roboto-Italic.ttf);
59+
font-family: "Roboto";
60+
font-style: italic;
61+
font-weight: 400;
62+
font-display: fallback;
63+
src: url(./Roboto/Roboto-Italic.ttf);
6464
}
6565

6666
@font-face {
67-
font-family: 'Roboto';
68-
font-style: normal;
69-
font-weight: 700;
70-
font-display: fallback;
71-
src: url(./Roboto/Roboto-Bold.ttf);
67+
font-family: "Roboto";
68+
font-style: normal;
69+
font-weight: 700;
70+
font-display: fallback;
71+
src: url(./Roboto/Roboto-Bold.ttf);
7272
}
7373

7474
@font-face {
75-
font-family: 'Roboto';
76-
font-style: italic;
77-
font-weight: 700;
78-
font-display: fallback;
79-
src: url(./Roboto/Roboto-BoldItalic.ttf);
75+
font-family: "Roboto";
76+
font-style: italic;
77+
font-weight: 700;
78+
font-display: fallback;
79+
src: url(./Roboto/Roboto-BoldItalic.ttf);
8080
}
8181

82-
8382
/*Roboto Mono*/
8483

8584
@font-face {
86-
font-family: 'Roboto Mono';
87-
font-style: normal;
88-
font-weight: 400;
89-
font-display: fallback;
90-
src: url(./Roboto_Mono/RobotoMono-Regular.ttf);
85+
font-family: "Roboto Mono";
86+
font-style: normal;
87+
font-weight: 400;
88+
font-display: fallback;
89+
src: url(./Roboto_Mono/RobotoMono-Regular.ttf);
9190
}
9291

9392
@font-face {
94-
font-family: 'Roboto Mono';
95-
font-style: italic;
96-
font-weight: 400;
97-
font-display: fallback;
98-
src: url(./Roboto_Mono/RobotoMono-Italic.ttf);
93+
font-family: "Roboto Mono";
94+
font-style: italic;
95+
font-weight: 400;
96+
font-display: fallback;
97+
src: url(./Roboto_Mono/RobotoMono-Italic.ttf);
9998
}
10099

101100
@font-face {
102-
font-family: 'Roboto Mono';
103-
font-style: normal;
104-
font-weight: 700;
105-
font-display: fallback;
106-
src: url(./Roboto_Mono/RobotoMono-Bold.ttf);
101+
font-family: "Roboto Mono";
102+
font-style: normal;
103+
font-weight: 700;
104+
font-display: fallback;
105+
src: url(./Roboto_Mono/RobotoMono-Bold.ttf);
107106
}
108107

109108
@font-face {
110-
font-family: 'Roboto Mono';
111-
font-style: italic;
112-
font-weight: 700;
113-
font-display: fallback;
114-
src: url(./Roboto_Mono/RobotoMono-BoldItalic.ttf);
109+
font-family: "Roboto Mono";
110+
font-style: italic;
111+
font-weight: 700;
112+
font-display: fallback;
113+
src: url(./Roboto_Mono/RobotoMono-BoldItalic.ttf);
114+
}
115+
116+
/* Prevent smallcaps in headers */
117+
.md-typeset h1,
118+
.md-typeset h2,
119+
.md-typeset h3,
120+
.md-typeset h4,
121+
.md-typeset h5,
122+
.md-typeset h6 {
123+
color: var(--md-typeset-color);
124+
text-transform: none;
125+
}
126+
127+
.md-typeset h5,
128+
.md-typeset h6 {
129+
font-size: 1em;
115130
}

‎frontend-react/.gitignore‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ dist
1212
dist-ssr
1313
types
1414
doc
15+
/docs
1516
*.local
1617

1718
# Editor directories and files

‎frontend-react/typedoc.json‎

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@
1515
"./src/lib/utils",
1616
"./src/lib/widget"
1717
],
18+
"entryModule": "index",
1819
"out": "docs",
1920
"githubPages": false,
2021
"validation": {
@@ -24,10 +25,14 @@
2425
},
2526
"hideGenerator": true,
2627
"disableSources": true,
27-
"hideInPageTOC": true,
28-
"outputFileStrategy": "members",
28+
"outputFileStrategy": "modules",
29+
"hideBreadcrumbs": true,
2930
"hidePageTitle": true,
3031
"hidePageHeader": true,
31-
"indexPageTitle": "API Reference",
32-
"readme": "none"
32+
"pageTitleTemplates": {
33+
"index": "API Reference"
34+
},
35+
"useCodeBlocks": true,
36+
"readme": "none",
37+
"useHTMLAnchors": true
3338
}

0 commit comments

Comments
 (0)