Skip to content

Commit 35e14c9

Browse files
authored
fix(ci,style): improve asset copying and enhance UI contrast for docs site (#979)
* fix: copy website assets properly in CI * chore: remove unnecessary footer content * style: update doc link colors in vars.css for better contrast * style: refine color variables and update styles for better contrast * style: update pagination colors for improved visibility * style: update code highlight and toc colors for contrast * style: change stroke color in home-o.svg to white
1 parent d5a28a8 commit 35e14c9

File tree

11 files changed

+130
-93
lines changed

11 files changed

+130
-93
lines changed

.github/workflows/ci.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -627,6 +627,7 @@ jobs:
627627
mkdir -p ../../build/website
628628
cp index.html ../../build/website/index.html
629629
cp styles.css ../../build/website/styles.css
630+
cp -r assets ../../build/website/assets
630631
631632
- name: Generate Antora UI
632633
working-directory: docs/ui

docs/ui/src/css/custom.css

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -68,10 +68,6 @@
6868
color: var(--navbar-font-color);
6969
}
7070

71-
.toc.sidebar .toc-menu h3 {
72-
color: var(--navbar-font-color);
73-
}
74-
7571
.breadcrumbs li {
7672
color: var(--color-white-50);
7773
}

docs/ui/src/css/doc.css

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -753,7 +753,7 @@
753753

754754
.doc .exampleblock > .content,
755755
.doc details.result > .content {
756-
background: var(--example-background);
756+
background: var(--pre-background);
757757
border: 0.25rem solid var(--example-border-color);
758758
border-radius: 0.5rem;
759759
padding: 0.75rem;

docs/ui/src/css/highlight.css

Lines changed: 54 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -1,86 +1,85 @@
1-
/*! Adapted from the GitHub style by Vasily Polovnyov <[email protected]> */
2-
.hljs-comment,
3-
.hljs-quote {
4-
color: #998;
5-
font-style: italic;
1+
/* atom one dark theme */
2+
pre code.hljs {
3+
display: block;
4+
overflow-x: auto;
5+
padding: 1em;
66
}
77

8-
.hljs-keyword,
9-
.hljs-selector-tag,
10-
.hljs-subst {
11-
color: #333;
12-
font-weight: var(--monospace-font-weight-bold);
8+
code.hljs {
9+
padding: 3px 5px;
1310
}
1411

15-
.hljs-number,
16-
.hljs-literal,
17-
.hljs-variable,
18-
.hljs-template-variable,
19-
.hljs-tag .hljs-attr {
20-
color: #008080;
12+
.hljs {
13+
color: #abb2bf;
14+
background: #282c34;
2115
}
2216

23-
.hljs-string,
24-
.hljs-doctag {
25-
color: #d14;
17+
.hljs-comment,
18+
.hljs-quote {
19+
color: #5c6370;
20+
font-style: italic;
2621
}
2722

28-
.hljs-title,
29-
.hljs-section,
30-
.hljs-selector-id {
31-
color: #900;
32-
font-weight: var(--monospace-font-weight-bold);
23+
.hljs-doctag,
24+
.hljs-formula,
25+
.hljs-keyword {
26+
color: #c678dd;
3327
}
3428

29+
.hljs-deletion,
30+
.hljs-name,
31+
.hljs-section,
32+
.hljs-selector-tag,
3533
.hljs-subst {
36-
font-weight: normal;
34+
color: #e06c75;
3735
}
3836

39-
.hljs-type,
40-
.hljs-class .hljs-title {
41-
color: #458;
42-
font-weight: var(--monospace-font-weight-bold);
37+
.hljs-literal {
38+
color: #56b6c2;
4339
}
4440

45-
.hljs-tag,
46-
.hljs-name,
47-
.hljs-attribute {
48-
color: #000080;
49-
font-weight: normal;
41+
.hljs-addition,
42+
.hljs-attribute,
43+
.hljs-meta .hljs-string,
44+
.hljs-regexp,
45+
.hljs-string {
46+
color: #98c379;
5047
}
5148

52-
.hljs-regexp,
53-
.hljs-link {
54-
color: #009926;
49+
.hljs-attr,
50+
.hljs-number,
51+
.hljs-selector-attr,
52+
.hljs-selector-class,
53+
.hljs-selector-pseudo,
54+
.hljs-template-variable,
55+
.hljs-type,
56+
.hljs-variable {
57+
color: #d19a66;
5558
}
5659

60+
.hljs-bullet,
61+
.hljs-link,
62+
.hljs-meta,
63+
.hljs-selector-id,
5764
.hljs-symbol,
58-
.hljs-bullet {
59-
color: #990073;
65+
.hljs-title {
66+
color: #61aeee;
6067
}
6168

6269
.hljs-built_in,
63-
.hljs-builtin-name {
64-
color: #0086b3;
65-
}
66-
67-
.hljs-meta {
68-
color: #999;
69-
font-weight: var(--monospace-font-weight-bold);
70-
}
71-
72-
.hljs-deletion {
73-
background: #fdd;
74-
}
75-
76-
.hljs-addition {
77-
background: #dfd;
70+
.hljs-class .hljs-title,
71+
.hljs-title.class_ {
72+
color: #e6c07b;
7873
}
7974

8075
.hljs-emphasis {
8176
font-style: italic;
8277
}
8378

8479
.hljs-strong {
85-
font-weight: var(--monospace-font-weight-bold);
80+
font-weight: 700;
81+
}
82+
83+
.hljs-link {
84+
text-decoration: underline;
8685
}

docs/ui/src/css/pagination.css

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ nav.pagination .next {
2323
}
2424

2525
nav.pagination span::before {
26-
color: var(--toolbar-muted-color);
26+
color: var(--color-white-50);
2727
font-size: 0.75em;
2828
padding-bottom: 0.1em;
2929
}
@@ -37,14 +37,15 @@ nav.pagination .next::before {
3737
}
3838

3939
nav.pagination a {
40+
color: var(--color-white);
4041
font-weight: var(--body-font-weight-bold);
4142
line-height: 1.3;
4243
position: relative;
4344
}
4445

4546
nav.pagination a::before,
4647
nav.pagination a::after {
47-
color: var(--toolbar-muted-color);
48+
color: var(--color-white-50);
4849
font-weight: normal;
4950
font-size: 1.5em;
5051
line-height: 0.75;

docs/ui/src/css/toc.css

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@
7272
}
7373

7474
.toc .toc-menu a {
75-
color: inherit;
75+
color: var(--color-white-75);
7676
border-left: 2px solid var(--toc-border-color);
7777
display: inline-block;
7878
padding: 0.25rem 0 0.25rem 0.5rem;
@@ -85,14 +85,14 @@
8585
}
8686

8787
.toc .toc-menu a:hover {
88-
color: var(--link-font-color);
88+
color: var(--color-white);
8989
}
9090

9191
.toc .toc-menu a.is-active {
92-
border-left-color: var(--link-font-color);
92+
border-left-color: var(--color-white);
9393
color: var(--doc-font-color);
9494
}
9595

9696
.sidebar.toc .toc-menu a:focus {
97-
background: var(--panel-background);
97+
background: var(--color-black-20);
9898
}

docs/ui/src/css/vars.css

Lines changed: 17 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22
/* colors */
33
--color-white: rgba(255, 255, 255, 1);
44
--color-white-50: rgba(255, 255, 255, 0.5);
5+
--color-white-75: rgba(255, 255, 255, 0.75);
6+
--color-white-15: rgba(255, 255, 255, 0.15);
57
--color-smoke-10: rgba(254, 254, 254, 0.95);
68
--color-smoke-30: rgba(250, 250, 250, 0.9);
79
--color-smoke-50: rgba(245, 245, 245, 0.85);
@@ -18,6 +20,8 @@
1820
--color-jet-70: rgba(34, 34, 34, 0.3);
1921
--color-jet-80: rgba(25, 25, 25, 0.25);
2022
--color-black: rgba(0, 0, 0, 0.2);
23+
--color-black-75: rgba(0, 0, 0, 0.75);
24+
--color-black-15: rgba(0, 0, 0, 0.15);
2125
/* fonts */
2226
--rem-base: 18; /* used to compute rem value from desired pixel value (e.g., calc(18 / var(--rem-base) * 1rem) = 18px) */
2327
--body-font-size: 1.0625em; /* 17px */
@@ -31,7 +35,7 @@
3135
--monospace-font-weight-bold: 600;
3236
/* base */
3337
--body-background: var(--color-white);
34-
--panel-background: var(--color-smoke-30);
38+
--panel-background: var(--color-black-75);
3539
--panel-border-color: var(--color-smoke-90);
3640
--scrollbar-track-color: var(--color-smoke-30);
3741
--scrollbar-thumb-color: var(--color-gray-10);
@@ -84,42 +88,42 @@
8488
--heading-font-weight: normal;
8589
--alt-heading-font-weight: var(--body-font-weight-bold);
8690
--section-divider-color: var(--panel-border-color);
87-
--link-font-color: #1565c0;
88-
--link_hover-font-color: #104d92;
91+
--link-font-color: #ffc;
92+
--link_hover-font-color: #fff5b3;
8993
--link_unresolved-font-color: var(--important-color);
9094
--abstract-background: var(--color-smoke-70);
9195
--abstract-font-color: var(--color-jet-20);
9296
--abstract-border-color: var(--panel-border-color);
93-
--admonition-background: var(--panel-background);
97+
--admonition-background: var(--color-white-15);
9498
--admonition-label-font-weight: var(--body-font-weight-bold);
95-
--caption-font-color: var(--color-gray-70);
99+
--caption-font-color: var(--color-white-50);
96100
--caption-font-style: italic;
97101
--caption-font-weight: var(--body-font-weight-bold);
98-
--code-background: var(--panel-background);
99-
--code-font-color: var(--body-font-color);
102+
--code-background: var(--color-black-15);
103+
--code-font-color: var(--color-white);
100104
--example-background: var(--color-white);
101105
--example-border-color: var(--color-gray-70);
102106
--kbd-background: var(--panel-background);
103107
--kbd-border-color: var(--color-gray-10);
104-
--pre-background: var(--panel-background);
108+
--pre-background: rgb(40, 44, 52);
105109
--pre-border-color: var(--panel-border-color);
106110
--pre-annotation-font-color: var(--color-gray-50);
107111
--quote-background: var(--panel-background);
108112
--quote-border-color: var(--color-gray-70);
109-
--quote-font-color: var(--color-gray-70);
113+
--quote-font-color: var(--color-white-50);
110114
--quote-attribution-font-color: var(--color-gray-40);
111-
--sidebar-background: var(--color-smoke-90);
115+
--sidebar-background: var(--color-black-15);
112116
--table-border-color: var(--panel-border-color);
113117
--table-stripe-background: var(--panel-background);
114118
--table-footer-background:
115119
linear-gradient(
116120
to bottom,
117-
var(--color-smoke-70) 0%,
118-
var(--color-white) 100%
121+
var(--color-black-15) 0%,
122+
var(--color-black-15) 100%
119123
);
120124
/* toc */
121125
--toc-font-color: var(--nav-muted-color);
122-
--toc-heading-font-color: var(--doc-font-color);
126+
--toc-heading-font-color: var(--color-white);
123127
--toc-border-color: var(--panel-border-color);
124128
--toc-line-height: 1.2;
125129
/* footer */

docs/ui/src/img/home-o.svg

Lines changed: 4 additions & 4 deletions
Loading

docs/ui/src/img/menu.svg

Lines changed: 8 additions & 8 deletions
Loading

docs/ui/src/partials/footer.hbs

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1 @@
1-
{{> footer-content}}
21
{{> footer-scripts}}

0 commit comments

Comments
 (0)