Skip to content

Commit

Permalink
Fix broken Docs build through updating Frontend API Reference Pipeline
Browse files Browse the repository at this point in the history
The dependency upgrades took a few configuration changes which are implemented
with this commit.
  • Loading branch information
pklaschka committed Dec 14, 2024
1 parent 2024a2c commit af6276d
Show file tree
Hide file tree
Showing 4 changed files with 97 additions and 72 deletions.
6 changes: 5 additions & 1 deletion docs/docker-compose.yml
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,11 @@ services:
&& mv /tmp/docs-output/* /docs
"
volumes:
- ../frontend-react:/app
- ../frontend-react/package.json:/app/package.json
- ../frontend-react/src:/app/src
- ../frontend-react/typedoc.json:/app/typedoc.json
- ../frontend-react/tsconfig.json:/app/tsconfig.json
- ../frontend-react/tsconfig.node.json:/app/tsconfig.node.json
- frontend-react-docs:/docs
profiles:
- deps
Expand Down
149 changes: 82 additions & 67 deletions docs/docs/_css/custom.css
Original file line number Diff line number Diff line change
@@ -1,115 +1,130 @@
[data-md-color-scheme="slate"] {
--md-hue: 255;
--md-hue: 255;
}

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

:root {
--md-primary-fg-color: #452897;
--md-primary-fg-color--light: #704ed2;
--md-primary-fg-color--dark: #1f0e4f;
--md-accent-fg-color: #452897;
--md-accent-fg-color--light: #704ed2;
--md-accent-fg-color--dark: #1f0e4f;

--md-text-font: "Roboto", Arial, sans-serif;
--md-code-font: "Roboto Mono", monospace;
--md-primary-fg-color: #452897;
--md-primary-fg-color--light: #704ed2;
--md-primary-fg-color--dark: #1f0e4f;
--md-accent-fg-color: #452897;
--md-accent-fg-color--light: #704ed2;
--md-accent-fg-color--dark: #1f0e4f;

--md-text-font: "Roboto", Arial, sans-serif;
--md-code-font: "Roboto Mono", monospace;
}

.md-banner a {
color: white;
text-decoration: underline;
color: white;
text-decoration: underline;
}

.md-banner a:hover {
color: white;
text-decoration: none;
color: white;
text-decoration: none;
}

/*Fonts*/

@font-face {
font-family: 'Roboto';
font-style: normal;
font-weight: 300;
font-display: fallback;
src: url(./Roboto/Roboto-Light.ttf);
font-family: "Roboto";
font-style: normal;
font-weight: 300;
font-display: fallback;
src: url(./Roboto/Roboto-Light.ttf);
}

@font-face {
font-family: 'Roboto';
font-style: italic;
font-weight: 300;
font-display: fallback;
src: url(./Roboto/Roboto-LightItalic.ttf);
font-family: "Roboto";
font-style: italic;
font-weight: 300;
font-display: fallback;
src: url(./Roboto/Roboto-LightItalic.ttf);
}

@font-face {
font-family: 'Roboto';
font-style: normal;
font-weight: 400;
font-display: fallback;
src: url(./Roboto/Roboto-Regular.ttf);
font-family: "Roboto";
font-style: normal;
font-weight: 400;
font-display: fallback;
src: url(./Roboto/Roboto-Regular.ttf);
}

@font-face {
font-family: 'Roboto';
font-style: italic;
font-weight: 400;
font-display: fallback;
src: url(./Roboto/Roboto-Italic.ttf);
font-family: "Roboto";
font-style: italic;
font-weight: 400;
font-display: fallback;
src: url(./Roboto/Roboto-Italic.ttf);
}

@font-face {
font-family: 'Roboto';
font-style: normal;
font-weight: 700;
font-display: fallback;
src: url(./Roboto/Roboto-Bold.ttf);
font-family: "Roboto";
font-style: normal;
font-weight: 700;
font-display: fallback;
src: url(./Roboto/Roboto-Bold.ttf);
}

@font-face {
font-family: 'Roboto';
font-style: italic;
font-weight: 700;
font-display: fallback;
src: url(./Roboto/Roboto-BoldItalic.ttf);
font-family: "Roboto";
font-style: italic;
font-weight: 700;
font-display: fallback;
src: url(./Roboto/Roboto-BoldItalic.ttf);
}


/*Roboto Mono*/

@font-face {
font-family: 'Roboto Mono';
font-style: normal;
font-weight: 400;
font-display: fallback;
src: url(./Roboto_Mono/RobotoMono-Regular.ttf);
font-family: "Roboto Mono";
font-style: normal;
font-weight: 400;
font-display: fallback;
src: url(./Roboto_Mono/RobotoMono-Regular.ttf);
}

@font-face {
font-family: 'Roboto Mono';
font-style: italic;
font-weight: 400;
font-display: fallback;
src: url(./Roboto_Mono/RobotoMono-Italic.ttf);
font-family: "Roboto Mono";
font-style: italic;
font-weight: 400;
font-display: fallback;
src: url(./Roboto_Mono/RobotoMono-Italic.ttf);
}

@font-face {
font-family: 'Roboto Mono';
font-style: normal;
font-weight: 700;
font-display: fallback;
src: url(./Roboto_Mono/RobotoMono-Bold.ttf);
font-family: "Roboto Mono";
font-style: normal;
font-weight: 700;
font-display: fallback;
src: url(./Roboto_Mono/RobotoMono-Bold.ttf);
}

@font-face {
font-family: 'Roboto Mono';
font-style: italic;
font-weight: 700;
font-display: fallback;
src: url(./Roboto_Mono/RobotoMono-BoldItalic.ttf);
font-family: "Roboto Mono";
font-style: italic;
font-weight: 700;
font-display: fallback;
src: url(./Roboto_Mono/RobotoMono-BoldItalic.ttf);
}

/* Prevent smallcaps in headers */
.md-typeset h1,
.md-typeset h2,
.md-typeset h3,
.md-typeset h4,
.md-typeset h5,
.md-typeset h6 {
color: var(--md-typeset-color);
text-transform: none;
}

.md-typeset h5,
.md-typeset h6 {
font-size: 1em;
}
1 change: 1 addition & 0 deletions frontend-react/.gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ dist
dist-ssr
types
doc
/docs
*.local

# Editor directories and files
Expand Down
13 changes: 9 additions & 4 deletions frontend-react/typedoc.json
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
"./src/lib/utils",
"./src/lib/widget"
],
"entryModule": "index",
"out": "docs",
"githubPages": false,
"validation": {
Expand All @@ -24,10 +25,14 @@
},
"hideGenerator": true,
"disableSources": true,
"hideInPageTOC": true,
"outputFileStrategy": "members",
"outputFileStrategy": "modules",
"hideBreadcrumbs": true,
"hidePageTitle": true,
"hidePageHeader": true,
"indexPageTitle": "API Reference",
"readme": "none"
"pageTitleTemplates": {
"index": "API Reference"
},
"useCodeBlocks": true,
"readme": "none",
"useHTMLAnchors": true
}

0 comments on commit af6276d

Please sign in to comment.