@vantagecompute/docusaurus-theme 0.4.7 → 0.4.8
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 +28 -1
- package/package.json +6 -6
package/README.md
CHANGED
|
@@ -91,8 +91,8 @@ Served from the package once `staticDir` is in your `staticDirectories`, so no s
|
|
|
91
91
|
|---|---|
|
|
92
92
|
| `ColorModeToggle` | Custom sun/moon SVG icon toggle |
|
|
93
93
|
| `DocBreadcrumbs` | Full-path breadcrumb rendering |
|
|
94
|
+
| `Navbar/Logo` | Centered site title with the version badge beside it |
|
|
94
95
|
| `Tabs` | Bugfix for Docusaurus 3.10 whitespace crash |
|
|
95
|
-
| `MDXComponents` | Global `Tabs`/`TabItem` registration |
|
|
96
96
|
| `Navbar/MobileSidebar/SecondaryMenu` | Clean secondary menu render |
|
|
97
97
|
|
|
98
98
|
### Utilities
|
|
@@ -154,6 +154,23 @@ Override any design token in your custom CSS:
|
|
|
154
154
|
}
|
|
155
155
|
```
|
|
156
156
|
|
|
157
|
+
## Documentation
|
|
158
|
+
|
|
159
|
+
Full documentation is published as a spoke site on the Vantage docs hub:
|
|
160
|
+
|
|
161
|
+
**https://docs.vantagecompute.ai/developer/docusaurus-theme/**
|
|
162
|
+
|
|
163
|
+
It lives in `docusaurus/` in this repository and installs the theme from npm, so
|
|
164
|
+
it renders what consumers actually get rather than the working tree. The
|
|
165
|
+
declared range is `^0.4.7`, so patch releases reach the site on the next deploy
|
|
166
|
+
with no commit.
|
|
167
|
+
|
|
168
|
+
```bash
|
|
169
|
+
just docs-serve # local preview at /developer/docusaurus-theme/
|
|
170
|
+
just docs-build # build and link-check
|
|
171
|
+
just docs-pin 0.5.0 # move the range across a minor
|
|
172
|
+
```
|
|
173
|
+
|
|
157
174
|
## Development
|
|
158
175
|
|
|
159
176
|
```bash
|
|
@@ -163,6 +180,16 @@ npm run build # Compile TypeScript entry point
|
|
|
163
180
|
|
|
164
181
|
The package uses TypeScript for the plugin entry point (`src/index.cts` -> `lib/index.cjs`). Theme components, CSS, and static assets are shipped as source and resolved by Docusaurus at build time.
|
|
165
182
|
|
|
183
|
+
`tsconfig.json` deliberately excludes `src/theme`, `src/css` and `src/utils`: only the entry point is compiled here, and everything else is compiled by each consuming site's own toolchain.
|
|
184
|
+
|
|
185
|
+
## Releasing
|
|
186
|
+
|
|
187
|
+
```bash
|
|
188
|
+
just release 0.4.8
|
|
189
|
+
```
|
|
190
|
+
|
|
191
|
+
Bumps `package.json`, commits, tags, pushes, and creates the GitHub release. The npm publish runs in CI on `release: published`, with provenance attestation. A patch release needs nothing else; a new minor needs `just docs-pin` for the docs site.
|
|
192
|
+
|
|
166
193
|
## License
|
|
167
194
|
|
|
168
195
|
MIT
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@vantagecompute/docusaurus-theme",
|
|
3
|
-
"version": "0.4.
|
|
3
|
+
"version": "0.4.8",
|
|
4
4
|
"description": "Shared Vantage Compute Docusaurus theme: design system, brand assets, and common theme overrides for all vantagecompute documentation sites.",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"main": "lib/index.cjs",
|
|
@@ -26,11 +26,11 @@
|
|
|
26
26
|
"unist-util-visit": "^5.1.0"
|
|
27
27
|
},
|
|
28
28
|
"devDependencies": {
|
|
29
|
-
"@docusaurus/module-type-aliases": "^3.10.
|
|
30
|
-
"@docusaurus/tsconfig": "^3.10.
|
|
31
|
-
"@docusaurus/types": "^3.10.
|
|
32
|
-
"@types/node": "^26.
|
|
33
|
-
"@types/react": "^19.2.
|
|
29
|
+
"@docusaurus/module-type-aliases": "^3.10.2",
|
|
30
|
+
"@docusaurus/tsconfig": "^3.10.2",
|
|
31
|
+
"@docusaurus/types": "^3.10.2",
|
|
32
|
+
"@types/node": "^26.4.1",
|
|
33
|
+
"@types/react": "^19.2.18",
|
|
34
34
|
"typescript": "~7.0.2"
|
|
35
35
|
},
|
|
36
36
|
"repository": {
|