varvara-typedoc-theme 0.3.2 → 0.3.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +3 -2
- package/assets/overrides.css +12 -5
- package/dist/index.js +1 -1
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -6,6 +6,7 @@ Varvara TypeDoc Theme is a custom theme for TypeDoc, designed to provide a seaml
|
|
|
6
6
|
|
|
7
7
|
[](https://www.npmjs.com/package/varvara-typedoc-theme)
|
|
8
8
|
[](https://github.com/marcmarine/varvara-js/blob/main/LICENSE)
|
|
9
|
+
[](https://github.com/marcmarine/varvara-js/blob/main/packages/typedoc-theme/CHANGELOG.md)
|
|
9
10
|
|
|
10
11
|
## Installation
|
|
11
12
|
|
|
@@ -24,7 +25,7 @@ npm install varvara-typedoc-theme --save-dev
|
|
|
24
25
|
Use the following command to generate documentation with the Varvara theme:
|
|
25
26
|
|
|
26
27
|
```bash
|
|
27
|
-
npx typedoc --plugin varvara-typedoc-theme --theme varvara
|
|
28
|
+
npx typedoc --plugin varvara-typedoc-theme --theme varvara-css src/index.ts
|
|
28
29
|
```
|
|
29
30
|
|
|
30
31
|
### Method 2: Configuration File
|
|
@@ -41,7 +42,7 @@ const config = {
|
|
|
41
42
|
plugin: ['varvara-typedoc-theme'],
|
|
42
43
|
|
|
43
44
|
// Set the theme to Varvara
|
|
44
|
-
theme: 'varvara',
|
|
45
|
+
theme: 'varvara-css',
|
|
45
46
|
|
|
46
47
|
// Optional: Include version information
|
|
47
48
|
includeVersion: true
|
package/assets/overrides.css
CHANGED
|
@@ -1,3 +1,7 @@
|
|
|
1
|
+
:root {
|
|
2
|
+
--va-link-color: var(--va-color-primary);
|
|
3
|
+
}
|
|
4
|
+
|
|
1
5
|
[data-theme='light'] {
|
|
2
6
|
color-scheme: light;
|
|
3
7
|
}
|
|
@@ -112,10 +116,11 @@ footer {
|
|
|
112
116
|
.container-main {
|
|
113
117
|
grid-template-areas: 'header content' 'sidebar content';
|
|
114
118
|
grid-auto-rows: auto 1fr;
|
|
115
|
-
margin: var(--va-space-
|
|
119
|
+
margin: var(--va-space-6) auto;
|
|
116
120
|
}
|
|
121
|
+
|
|
117
122
|
.container {
|
|
118
|
-
padding: 0 var(--va-space-
|
|
123
|
+
padding: 0 var(--va-space-6);
|
|
119
124
|
}
|
|
120
125
|
|
|
121
126
|
#tsd-toolbar-menu-trigger {
|
|
@@ -125,21 +130,23 @@ footer {
|
|
|
125
130
|
|
|
126
131
|
@media (min-width: 1200px) {
|
|
127
132
|
.container-main {
|
|
128
|
-
grid-template-columns: minmax(0,
|
|
133
|
+
grid-template-columns: minmax(0, 20rem) minmax(0, 2.5fr) minmax(0, 20rem);
|
|
129
134
|
grid-template-areas:
|
|
130
135
|
'header content toc'
|
|
131
136
|
'sidebar content toc';
|
|
132
137
|
}
|
|
133
138
|
.page-menu,
|
|
134
139
|
.site-menu {
|
|
135
|
-
top: var(--va-space-
|
|
136
|
-
max-height: calc(100vh - calc(var(--va-space-
|
|
140
|
+
top: var(--va-space-6);
|
|
141
|
+
max-height: calc(100vh - calc(var(--va-space-6) * 2));
|
|
137
142
|
}
|
|
138
143
|
}
|
|
139
144
|
|
|
140
145
|
@media (min-width: 770px) and (max-width: 1399px) {
|
|
141
146
|
.col-sidebar {
|
|
147
|
+
top: var(--va-space-6);
|
|
142
148
|
padding-top: 0;
|
|
149
|
+
max-height: calc(100vh - calc(var(--va-space-6) * 2));
|
|
143
150
|
}
|
|
144
151
|
.page-menu {
|
|
145
152
|
margin-bottom: 1rem;
|
package/dist/index.js
CHANGED
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "varvara-typedoc-theme",
|
|
3
|
-
"version": "0.3.
|
|
3
|
+
"version": "0.3.4",
|
|
4
4
|
"author": "Marc Mariné <shenobi@gmail.com>",
|
|
5
5
|
"repository": {
|
|
6
6
|
"type": "git",
|
|
@@ -15,7 +15,7 @@
|
|
|
15
15
|
],
|
|
16
16
|
"license": "MIT",
|
|
17
17
|
"dependencies": {
|
|
18
|
-
"varvara-css": "
|
|
18
|
+
"varvara-css": "^0.7.4"
|
|
19
19
|
},
|
|
20
20
|
"devDependencies": {
|
|
21
21
|
"@types/bun": "latest"
|