Skip to content

Commit 849099f

Browse files
benjimaclellanbenjimaclellan
authored
Merge pull request #3 from OpenQuantumDesign/docs
Update documentation styles
2 parents 6c9e777 + 14a2957 commit 849099f

File tree

8 files changed

+135
-10
lines changed

8 files changed

+135
-10
lines changed

‎docs/img/oqd-icon.png‎

89.2 KB
Loading

‎docs/img/oqd-logo-black.png‎

65.9 KB
Loading

‎docs/img/oqd-logo-text.png‎

-14.4 KB
Binary file not shown.

‎docs/img/oqd-logo-white.png‎

61.9 KB
Loading

‎docs/img/oqd-logo.png‎

-7.64 KB
Binary file not shown.

‎docs/index.md‎

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,18 @@
1-
# ![Open Quantum Design](https://raw.githubusercontent.com/OpenQuantumDesign/oqd-core/main/docs/img/oqd-logo-text.png)
1+
#
22

3-
<h2 align="center">
3+
<p align="center">
4+
<img src="img/oqd-logo-black.png#only-light" alt="Logo" style="max-height: 200px;">
5+
<img src="img/oqd-logo-white.png#only-dark" alt="Logo" style="max-height: 200px;">
6+
</p>
7+
8+
<div align="center">
9+
<h2 align="center">
410
Open Quantum Design: Dataschema
5-
</h2>
11+
</h2>
12+
</div>
613

14+
[![License: Apache 2.0](https://img.shields.io/badge/license-Apache%202.0-brightgreen.svg)](https://opensource.org/licenses/Apache-2.0)
15+
[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
716

817
<!-- prettier-ignore -->
918
/// admonition | Note

‎docs/stylesheets/brand.css‎

Lines changed: 116 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,116 @@
1+
/* Load custom fonts from Google Fonts */
2+
@import url('https://fonts.googleapis.com/css2?family=Raleway:wght@600;700&family=Source+Serif+Pro&display=swap');
3+
4+
/* Base typography */
5+
body, .md-typeset {
6+
font-family: 'Source Serif Pro', serif;
7+
}
8+
9+
/* Headings */
10+
h1, h2, h3, h4, h5, h6,
11+
.md-typeset h1, .md-typeset h2, .md-typeset h3,
12+
.md-typeset h4, .md-typeset h5, .md-typeset h6 {
13+
font-family: 'Raleway', sans-serif;
14+
font-weight: 700; /* Bold for headings */
15+
}
16+
17+
/* Subheadings */
18+
.md-typeset h2, .md-typeset h3 {
19+
font-weight: 600; /* SemiBold for subheadings */
20+
}
21+
22+
/* Light mode overrides */
23+
[data-md-color-scheme="default"] {
24+
--md-default-bg-color: #FFFFFF;
25+
--md-primary-fg-color: #23627D; /* blue accent */
26+
--md-accent-fg-color: #23627D;
27+
}
28+
29+
/* Dark mode overrides */
30+
[data-md-color-scheme="slate"] {
31+
--md-default-bg-color: #141414;
32+
--md-primary-fg-color: #23627D;
33+
--md-accent-fg-color: #23627D;
34+
}
35+
36+
37+
38+
/* Apply Raleway to all navigation and sidebar elements */
39+
.md-nav,
40+
.md-nav__title,
41+
.md-nav__link,
42+
.md-header,
43+
.md-tabs,
44+
.md-sidebar,
45+
.md-sidebar__inner,
46+
.md-nav__item,
47+
.md-footer,
48+
.md-footer__inner {
49+
font-family: 'Raleway', sans-serif;
50+
font-weight: 600; /* SemiBold for ToC/nav for clarity */
51+
}
52+
53+
54+
55+
56+
/* Page heading accent color for light mode */
57+
[data-md-color-scheme="default"] .md-typeset h1,
58+
[data-md-color-scheme="default"] .md-typeset h2,
59+
[data-md-color-scheme="default"] .md-typeset h3,
60+
[data-md-color-scheme="default"] .md-typeset h4,
61+
[data-md-color-scheme="default"] .md-typeset h5,
62+
[data-md-color-scheme="default"] .md-typeset h6 {
63+
color: #7B2328; /* Warm yellow/orange for light mode */
64+
}
65+
66+
/* Page heading accent color for dark mode */
67+
[data-md-color-scheme="slate"] .md-typeset h1,
68+
[data-md-color-scheme="slate"] .md-typeset h2,
69+
[data-md-color-scheme="slate"] .md-typeset h3,
70+
[data-md-color-scheme="slate"] .md-typeset h4,
71+
[data-md-color-scheme="slate"] .md-typeset h5,
72+
[data-md-color-scheme="slate"] .md-typeset h6 {
73+
/* color: #F19D19; Deep red for dark mode */
74+
color: #E45B68; /* Deep red for dark mode */
75+
}
76+
77+
78+
79+
80+
81+
/* Light mode nav/ToC font color */
82+
[data-md-color-scheme="default"] .md-nav,
83+
[data-md-color-scheme="default"] .md-nav__link,
84+
[data-md-color-scheme="default"] .md-header,
85+
[data-md-color-scheme="default"] .md-tabs {
86+
/*color: #222; /* Dark gray or your preferred shade */
87+
color: #141414;
88+
}
89+
90+
/* Dark mode nav/ToC font color */
91+
[data-md-color-scheme="slate"] .md-nav,
92+
[data-md-color-scheme="slate"] .md-nav__link,
93+
[data-md-color-scheme="slate"] .md-header,
94+
[data-md-color-scheme="slate"] .md-tabs {
95+
color: #f0f0f0; /* Light gray or white */
96+
}
97+
98+
99+
100+
/* Top navigation bar text and icons should be light-colored */
101+
.md-header,
102+
.md-header .md-header__title,
103+
.md-header .md-header__button,
104+
.md-header .md-tabs,
105+
.md-header .md-tabs__link,
106+
.md-header .md-header__topic,
107+
.md-header .md-header__option {
108+
color: #f0f0f0 !important; /* Light gray or white text */
109+
fill: #f0f0f0 !important; /* Icons (SVG) */
110+
}
111+
112+
/* Hover state for links in header */
113+
.md-header .md-tabs__link:hover {
114+
color: #ffffff !important;
115+
text-decoration: underline;
116+
}

‎mkdocs.yaml‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -24,22 +24,21 @@ nav:
2424

2525
theme:
2626
name: material
27-
28-
logo: img/oqd-logo.png
29-
favicon: img/oqd-logo.png
27+
logo: img/oqd-icon.png
28+
favicon: img/oqd-icon.png
3029

3130
palette:
3231
- media: "(prefers-color-scheme: light)"
3332
scheme: default
34-
primary: teal
35-
accent: pink
33+
primary: custom
34+
accent: custom
3635
toggle:
3736
icon: material/weather-sunny
3837
name: Switch to dark mode
3938
- media: "(prefers-color-scheme: dark)"
4039
scheme: slate
41-
primary: teal
42-
accent: pink
40+
primary: custom
41+
accent: custom
4342
toggle:
4443
icon: material/weather-night
4544
name: Switch to light mode
@@ -128,3 +127,4 @@ extra_javascript:
128127
extra_css:
129128
- stylesheets/headers.css
130129
- stylesheets/admonitions.css
130+
- stylesheets/brand.css

0 commit comments

Comments
 (0)