Skip to content

Commit 53a137c

Browse files
AnsonhkgAnsonhkg
committed
doc: update jsdoc style
1 parent 509882e commit 53a137c

File tree

3 files changed

+319
-5
lines changed

3 files changed

+319
-5
lines changed

‎doc.css‎

Lines changed: 310 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,310 @@
1+
/* Base styles */
2+
:root {
3+
/* Colors */
4+
--background-color: hsl(0, 0%, 100%);
5+
--foreground-color: hsl(222.2, 84%, 4.9%);
6+
7+
--card-bg: hsl(0, 0%, 100%);
8+
--card-color: hsl(222.2, 84%, 4.9%);
9+
10+
--primary-color: hsl(221.2, 83.2%, 53.3%);
11+
--primary-foreground: hsl(210, 40%, 98%);
12+
13+
--secondary-color: hsl(222, 47.4%, 34.7%);
14+
--secondary-foreground: hsl(210, 40%, 98%);
15+
16+
--muted-color: hsl(210, 40%, 96.1%);
17+
--muted-foreground: hsl(215.4, 16.3%, 46.9%);
18+
19+
--accent-color: hsl(210, 40%, 96.1%);
20+
--accent-foreground: hsl(222.2, 47.4%, 11.2%);
21+
22+
--destructive-color: hsl(0, 84.2%, 60.2%);
23+
--destructive-foreground: hsl(210, 40%, 98%);
24+
25+
--border-color: hsl(214.3, 31.8%, 91.4%);
26+
--input-color: hsl(214.3, 31.8%, 91.4%);
27+
--ring-color: hsl(221.2, 83.2%, 53.3%);
28+
29+
/* Spacing & Sizing */
30+
--radius: 0.5rem;
31+
--spacing-1: 0.25rem;
32+
--spacing-2: 0.5rem;
33+
--spacing-3: 0.75rem;
34+
--spacing-4: 1rem;
35+
--spacing-6: 1.5rem;
36+
}
37+
38+
/* Dark mode */
39+
@media (prefers-color-scheme: dark) {
40+
:root {
41+
--background-color: hsl(222.2, 84%, 4.9%);
42+
--foreground-color: hsl(210, 40%, 98%);
43+
44+
--card-bg: hsl(222.2, 84%, 4.9%);
45+
--card-color: hsl(210, 40%, 98%);
46+
47+
--primary-color: hsl(217.2, 91.2%, 59.8%);
48+
--primary-foreground: hsl(222.2, 47.4%, 11.2%);
49+
50+
--secondary-color: hsl(217.2, 32.6%, 17.5%);
51+
--secondary-foreground: hsl(210, 40%, 98%);
52+
53+
--muted-color: hsl(217.2, 32.6%, 17.5%);
54+
--muted-foreground: hsl(215, 20.2%, 65.1%);
55+
56+
--accent-color: hsl(217.2, 32.6%, 17.5%);
57+
--accent-foreground: hsl(210, 40%, 98%);
58+
59+
--destructive-color: hsl(0, 62.8%, 30.6%);
60+
--destructive-foreground: hsl(210, 40%, 98%);
61+
62+
--border-color: hsl(217.2, 32.6%, 17.5%);
63+
--input-color: hsl(217.2, 32.6%, 17.5%);
64+
--ring-color: hsl(224.3, 76.3%, 48%);
65+
}
66+
}
67+
68+
/* Base elements */
69+
* {
70+
margin: 0;
71+
padding: 0;
72+
box-sizing: border-box;
73+
border-color: var(--border-color);
74+
}
75+
76+
body {
77+
background-color: var(--background-color);
78+
color: var(--foreground-color);
79+
font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto,
80+
'Helvetica Neue', Arial, sans-serif;
81+
line-height: 1.6;
82+
-webkit-font-smoothing: antialiased;
83+
-moz-osx-font-smoothing: grayscale;
84+
font-feature-settings: 'rlig' 1, 'calt' 1;
85+
}
86+
87+
/* Typography */
88+
h1,
89+
h2,
90+
h3,
91+
h4,
92+
h5,
93+
h6 {
94+
letter-spacing: -0.025em;
95+
font-weight: 700;
96+
line-height: 1.2;
97+
}
98+
99+
h1 {
100+
font-size: 2.5rem;
101+
}
102+
103+
h2 {
104+
font-size: 2rem;
105+
}
106+
107+
h3 {
108+
font-size: 1.75rem;
109+
}
110+
111+
h4 {
112+
font-size: 1.5rem;
113+
}
114+
115+
p {
116+
line-height: 1.75;
117+
margin-top: 1.5rem;
118+
}
119+
120+
p:first-child {
121+
margin-top: 0;
122+
}
123+
124+
/* Block elements */
125+
blockquote {
126+
margin-top: 1.5rem;
127+
border-left: 4px solid var(--primary-color);
128+
padding-left: 1.5rem;
129+
font-style: italic;
130+
}
131+
132+
code {
133+
position: relative;
134+
border-radius: var(--radius);
135+
background-color: var(--muted-color);
136+
padding: 0.2rem 0.3rem;
137+
font-family: ui-monospace, SFMono-Regular, Menlo, Monaco, Consolas, monospace;
138+
font-size: 0.875rem;
139+
}
140+
141+
pre {
142+
margin: 1.5rem 0 1rem 0;
143+
padding: 1rem;
144+
overflow-x: auto;
145+
border-radius: var(--radius);
146+
border: 1px solid var(--border-color);
147+
background-color: var(--muted-color);
148+
}
149+
150+
pre code {
151+
background-color: transparent;
152+
padding: 0;
153+
}
154+
155+
/* Tables */
156+
table {
157+
width: 100%;
158+
border-collapse: collapse;
159+
}
160+
161+
tr {
162+
margin: 0;
163+
border-top: 1px solid var(--border-color);
164+
padding: 0;
165+
}
166+
167+
th,
168+
td {
169+
border: 1px solid var(--border-color);
170+
padding: 0.5rem 1rem;
171+
text-align: left;
172+
}
173+
174+
th[align='center'],
175+
td[align='center'] {
176+
text-align: center;
177+
}
178+
179+
th[align='right'],
180+
td[align='right'] {
181+
text-align: right;
182+
}
183+
184+
/* Lists */
185+
ul,
186+
ol {
187+
margin: 1.5rem 0;
188+
padding-left: 1.5rem;
189+
}
190+
191+
ul {
192+
list-style-type: disc;
193+
}
194+
195+
ol {
196+
list-style-type: decimal;
197+
}
198+
199+
li {
200+
margin-top: 0.5rem;
201+
}
202+
203+
/* Interactive elements */
204+
details {
205+
border-radius: var(--radius);
206+
border: 1px solid var(--border-color);
207+
padding: 1rem;
208+
}
209+
210+
summary {
211+
cursor: pointer;
212+
font-weight: 600;
213+
}
214+
215+
summary:hover {
216+
color: var(--primary-color);
217+
}
218+
219+
/* Media elements */
220+
img {
221+
max-width: 100%;
222+
height: auto;
223+
border-radius: var(--radius);
224+
}
225+
226+
/* Scrollbar */
227+
::-webkit-scrollbar {
228+
width: 0.5rem;
229+
}
230+
231+
::-webkit-scrollbar-track {
232+
background-color: var(--muted-color);
233+
}
234+
235+
::-webkit-scrollbar-thumb {
236+
border-radius: 9999px;
237+
background-color: color-mix(
238+
in srgb,
239+
var(--muted-foreground) 50%,
240+
transparent
241+
);
242+
}
243+
244+
::-webkit-scrollbar-thumb:hover {
245+
background-color: var(--muted-foreground);
246+
}
247+
248+
/* Selection */
249+
::selection {
250+
background-color: color-mix(in srgb, var(--primary-color) 20%, transparent);
251+
color: var(--foreground-color);
252+
}
253+
254+
/* Focus */
255+
:focus-visible {
256+
outline: none;
257+
box-shadow: 0 0 0 2px var(--background-color), 0 0 0 4px var(--ring-color);
258+
}
259+
260+
/* Animations */
261+
@keyframes enter {
262+
from {
263+
opacity: 0;
264+
}
265+
to {
266+
opacity: 1;
267+
}
268+
}
269+
270+
@keyframes exit {
271+
from {
272+
opacity: 1;
273+
}
274+
to {
275+
opacity: 0;
276+
}
277+
}
278+
279+
.animate-in {
280+
animation: enter 0.2s ease-out;
281+
}
282+
283+
.animate-out {
284+
animation: exit 0.2s ease-in;
285+
}
286+
287+
/* Responsive Design */
288+
@media (min-width: 768px) {
289+
h1 {
290+
font-size: 3rem;
291+
}
292+
293+
h2 {
294+
font-size: 2.5rem;
295+
}
296+
297+
h3 {
298+
font-size: 2rem;
299+
}
300+
301+
h4 {
302+
font-size: 1.75rem;
303+
}
304+
}
305+
.tsd-page-title {
306+
display: none;
307+
}
308+
.col-content {
309+
margin-left: 16px;
310+
}

‎package.json‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -120,6 +120,7 @@
120120
"prettier": "^2.6.2",
121121
"ts-jest": "29.2.5",
122122
"typedoc": "^0.26.6",
123+
"typedoc-theme-hierarchy": "^5.0.0",
123124
"typescript": "5.5.4"
124125
},
125126
"workspaces": [

‎typedoc.json‎

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,10 @@
44
"./packages/access-control-conditions/src/index.ts",
55
"./packages/auth-browser/src/index.ts",
66
"./packages/auth-helpers/src/index.ts",
7-
"./packages/bls-sdk/src/index.ts",
87
"./packages/constants/src/index.ts",
98
"./packages/contracts-sdk/src/index.ts",
109
"./packages/core/src/index.ts",
1110
"./packages/crypto/src/index.ts",
12-
"./packages/ecdsa-sdk/src/index.ts",
1311
"./packages/encryption/src/index.ts",
1412
"./packages/lit-auth-client/src/index.ts",
1513
"./packages/lit-node-client/src/index.ts",
@@ -23,12 +21,17 @@
2321
"./packages/pkp-ethers/src/index.ts",
2422
"./packages/pkp-sui/src/index.ts",
2523
"./packages/pkp-walletconnect/src/index.ts",
26-
"./packages/sev-snp-utils-sdk/src/index.ts",
2724
"./packages/types/src/index.ts",
2825
"./packages/uint8arrays/src/index.ts",
26+
"./packages/wasm/src/index.ts",
2927
"./packages/wrapped-keys/src/index.ts",
3028
"./packages/wrapped-keys-lit-actions/src/index.ts"
3129
],
3230
"out": "doc",
33-
"skipErrorChecking": true
34-
}
31+
"skipErrorChecking": true,
32+
"plugin": [
33+
"typedoc-theme-hierarchy"
34+
],
35+
"theme": "hierarchy",
36+
"customCss": "doc.css"
37+
}

0 commit comments

Comments
 (0)