@vantagecompute/docusaurus-theme 0.4.6 → 0.4.7
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 +67 -13
- package/lib/index.cjs +56 -1
- package/lib/index.cjs.map +1 -1
- package/lib/index.d.cts +52 -0
- package/lib/index.d.cts.map +1 -1
- package/package.json +2 -2
- package/src/index.cts +71 -0
- package/static/img/vantage-logo-color.svg +30 -0
package/README.md
CHANGED
|
@@ -13,13 +13,27 @@ npm install @vantagecompute/docusaurus-theme
|
|
|
13
13
|
Add the theme to your `docusaurus.config.js`:
|
|
14
14
|
|
|
15
15
|
```js
|
|
16
|
-
const {
|
|
16
|
+
const {
|
|
17
|
+
staticDir,
|
|
18
|
+
rehypeTabsTransform,
|
|
19
|
+
navbarLogo,
|
|
20
|
+
footerLogo,
|
|
21
|
+
getProjectVersion,
|
|
22
|
+
} = require('@vantagecompute/docusaurus-theme');
|
|
23
|
+
|
|
24
|
+
const projectVersion = getProjectVersion();
|
|
17
25
|
|
|
18
26
|
const config = {
|
|
27
|
+
title: 'my-project',
|
|
28
|
+
|
|
29
|
+
// The project version belongs here, not in the navbar title: a title that
|
|
30
|
+
// grows and shrinks reflows the header on every release.
|
|
31
|
+
tagline: `What this project does (${projectVersion})`,
|
|
32
|
+
|
|
19
33
|
// Add the Vantage theme
|
|
20
34
|
themes: ['@vantagecompute/docusaurus-theme'],
|
|
21
35
|
|
|
22
|
-
// Serve shared static assets (fonts, icons,
|
|
36
|
+
// Serve shared static assets (fonts, icons, brand mark)
|
|
23
37
|
staticDirectories: ['static', staticDir],
|
|
24
38
|
|
|
25
39
|
presets: [
|
|
@@ -28,27 +42,49 @@ const config = {
|
|
|
28
42
|
// Optional: use the shared rehype plugin for lowercase <tabs>/<tabitem> support
|
|
29
43
|
rehypePlugins: [rehypeTabsTransform],
|
|
30
44
|
},
|
|
31
|
-
// Do NOT set customCss
|
|
45
|
+
// Do NOT set customCss - the theme injects it automatically
|
|
32
46
|
}],
|
|
33
47
|
],
|
|
48
|
+
|
|
49
|
+
themeConfig: {
|
|
50
|
+
navbar: {
|
|
51
|
+
title: 'my-project',
|
|
52
|
+
logo: navbarLogo,
|
|
53
|
+
items: [/* ... */],
|
|
54
|
+
},
|
|
55
|
+
footer: {
|
|
56
|
+
style: 'dark',
|
|
57
|
+
logo: footerLogo,
|
|
58
|
+
links: [/* ... */],
|
|
59
|
+
},
|
|
60
|
+
},
|
|
34
61
|
};
|
|
35
62
|
```
|
|
36
63
|
|
|
64
|
+
`navbarLogo` and `footerLogo` carry the Vantage brand mark, its alt text, and
|
|
65
|
+
the right link target for each position. Your site needs no copy of the SVG:
|
|
66
|
+
it is served out of `staticDir`.
|
|
67
|
+
|
|
37
68
|
## What's included
|
|
38
69
|
|
|
39
70
|
### Design System CSS
|
|
40
71
|
The full Vantage design system (`custom.css`) is automatically loaded as a client module. It provides:
|
|
41
|
-
- **Design tokens
|
|
42
|
-
- **Dark/light themes
|
|
43
|
-
- **Typography
|
|
44
|
-
- **Component styles
|
|
72
|
+
- **Design tokens**: Ink (neutral) and Iris (accent) color palettes with CSS variables
|
|
73
|
+
- **Dark/light themes**: Complete dark mode support
|
|
74
|
+
- **Typography**: Satoshi + Open Sans body, JetBrains Mono code
|
|
75
|
+
- **Component styles**: Navbar, sidebar, TOC, admonitions/callouts, tables, code blocks, breadcrumbs, tabs, guided how-to steps, and more
|
|
45
76
|
|
|
46
77
|
### Brand Assets (static files)
|
|
47
|
-
Served
|
|
48
|
-
- **Fonts
|
|
49
|
-
- **Icons
|
|
50
|
-
- **
|
|
51
|
-
|
|
78
|
+
Served from the package once `staticDir` is in your `staticDirectories`, so no site needs its own copy:
|
|
79
|
+
- **Fonts**: Satoshi (Regular, Medium, Bold + italics) as `.woff` files
|
|
80
|
+
- **Icons**: Sun/moon toggles, search, external link, GitHub, chevron SVGs
|
|
81
|
+
- **Brand mark**: `vantage-logo-color.svg`, the current Vantage mark, used by
|
|
82
|
+
`navbarLogo` and `footerLogo`. It has no dark variant on purpose: the one
|
|
83
|
+
colour mark is drawn to read in both colour modes.
|
|
84
|
+
- **Legacy logo**: `vantage-logo.svg`, the older monochrome mark. Kept for the
|
|
85
|
+
`vantage-docs` hub, which still points at it. New sites should use the
|
|
86
|
+
brand mark above.
|
|
87
|
+
- **Favicon**: `favicon.ico`
|
|
52
88
|
|
|
53
89
|
### Theme Component Overrides
|
|
54
90
|
| Component | Description |
|
|
@@ -62,7 +98,11 @@ Served automatically via `configureStaticDirs`:
|
|
|
62
98
|
### Utilities
|
|
63
99
|
| Export | Description |
|
|
64
100
|
|---|---|
|
|
101
|
+
| `staticDir` | Absolute path to this package's `static/` directory; add it to `staticDirectories` |
|
|
65
102
|
| `rehypeTabsTransform` | Rehype plugin that transforms lowercase `<tabs>`/`<tabitem>` to React components |
|
|
103
|
+
| `getProjectVersion()` | Project version inferred from git tags (`git describe --tags --always`), or `"dev"` |
|
|
104
|
+
| `navbarLogo` | Navbar logo config: the brand mark, linking to `https://docs.vantagecompute.ai` |
|
|
105
|
+
| `footerLogo` | Footer logo config: the same mark, linking to `https://vantagecompute.ai` |
|
|
66
106
|
|
|
67
107
|
## Customization
|
|
68
108
|
|
|
@@ -77,6 +117,20 @@ your-docs-site/
|
|
|
77
117
|
index.js
|
|
78
118
|
```
|
|
79
119
|
|
|
120
|
+
### Overriding the logo
|
|
121
|
+
|
|
122
|
+
`navbarLogo` and `footerLogo` are plain objects. Spread one to change a field,
|
|
123
|
+
and leave the rest to the theme:
|
|
124
|
+
|
|
125
|
+
```js
|
|
126
|
+
navbar: {
|
|
127
|
+
logo: { ...navbarLogo, href: 'https://docs.vantagecompute.ai/developer/' },
|
|
128
|
+
},
|
|
129
|
+
```
|
|
130
|
+
|
|
131
|
+
Spread rather than mutate: the objects are shared by everything that imports
|
|
132
|
+
them. To render no logo at all, just omit `logo`.
|
|
133
|
+
|
|
80
134
|
### Extending CSS
|
|
81
135
|
Add your own CSS in `src/css/custom.css` and reference it in your preset config. Your styles will layer on top of the shared design system:
|
|
82
136
|
|
|
@@ -107,7 +161,7 @@ npm install
|
|
|
107
161
|
npm run build # Compile TypeScript entry point
|
|
108
162
|
```
|
|
109
163
|
|
|
110
|
-
The package uses TypeScript for the plugin entry point (`src/index.
|
|
164
|
+
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.
|
|
111
165
|
|
|
112
166
|
## License
|
|
113
167
|
|
package/lib/index.cjs
CHANGED
|
@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
|
3
3
|
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
4
4
|
};
|
|
5
5
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
6
|
-
exports.rehypeTabsTransform = exports.staticDir = void 0;
|
|
6
|
+
exports.footerLogo = exports.navbarLogo = exports.rehypeTabsTransform = exports.staticDir = void 0;
|
|
7
7
|
exports.default = themeVantage;
|
|
8
8
|
exports.getProjectVersion = getProjectVersion;
|
|
9
9
|
const node_path_1 = __importDefault(require("node:path"));
|
|
@@ -53,4 +53,59 @@ function getProjectVersion() {
|
|
|
53
53
|
}
|
|
54
54
|
// Re-export the rehype utility (plain JS, lives in src/utils/)
|
|
55
55
|
exports.rehypeTabsTransform = require(node_path_1.default.resolve(__dirname, '../src/utils/rehypeTabsTransform'));
|
|
56
|
+
/**
|
|
57
|
+
* The Vantage colour brand mark, as a path relative to a served static
|
|
58
|
+
* directory. It resolves once `staticDir` is in `staticDirectories`; no site
|
|
59
|
+
* needs its own copy of the SVG.
|
|
60
|
+
*/
|
|
61
|
+
const VANTAGE_LOGO_SRC = 'img/vantage-logo-color.svg';
|
|
62
|
+
/**
|
|
63
|
+
* Navbar logo for a Vantage documentation site.
|
|
64
|
+
*
|
|
65
|
+
* ```js
|
|
66
|
+
* const { navbarLogo } = require('@vantagecompute/docusaurus-theme');
|
|
67
|
+
* themeConfig: { navbar: { title: 'v8x', logo: navbarLogo, items: [...] } }
|
|
68
|
+
* ```
|
|
69
|
+
*
|
|
70
|
+
* Deliberately has no `srcDark`. The single colour mark is drawn to read on
|
|
71
|
+
* both colour modes, and a second asset would only be a second thing to keep
|
|
72
|
+
* in sync.
|
|
73
|
+
*
|
|
74
|
+
* `href` points at the docs hub rather than the marketing site: from a spoke's
|
|
75
|
+
* documentation the useful "home" is the rest of the documentation. `target`
|
|
76
|
+
* is `_self` so that jump replaces the tab instead of opening a new one.
|
|
77
|
+
*
|
|
78
|
+
* Override by spreading, never by mutating -- the object is shared by every
|
|
79
|
+
* site in the process:
|
|
80
|
+
*
|
|
81
|
+
* ```js
|
|
82
|
+
* logo: { ...navbarLogo, href: 'https://docs.vantagecompute.ai/developer/' }
|
|
83
|
+
* ```
|
|
84
|
+
*
|
|
85
|
+
* Omit `logo` entirely to render no navbar logo.
|
|
86
|
+
*/
|
|
87
|
+
exports.navbarLogo = {
|
|
88
|
+
alt: 'Vantage Compute Logo',
|
|
89
|
+
src: VANTAGE_LOGO_SRC,
|
|
90
|
+
href: 'https://docs.vantagecompute.ai',
|
|
91
|
+
target: '_self',
|
|
92
|
+
};
|
|
93
|
+
/**
|
|
94
|
+
* Footer logo for a Vantage documentation site.
|
|
95
|
+
*
|
|
96
|
+
* ```js
|
|
97
|
+
* const { footerLogo } = require('@vantagecompute/docusaurus-theme');
|
|
98
|
+
* themeConfig: { footer: { style: 'dark', logo: footerLogo, links: [...] } }
|
|
99
|
+
* ```
|
|
100
|
+
*
|
|
101
|
+
* Same mark as {@link navbarLogo}, but `href` points at the marketing site:
|
|
102
|
+
* the footer is where a reader who has finished reading looks for the company.
|
|
103
|
+
*
|
|
104
|
+
* Override by spreading; omit `logo` to render no footer logo.
|
|
105
|
+
*/
|
|
106
|
+
exports.footerLogo = {
|
|
107
|
+
alt: 'Vantage Compute Logo',
|
|
108
|
+
src: VANTAGE_LOGO_SRC,
|
|
109
|
+
href: 'https://vantagecompute.ai',
|
|
110
|
+
};
|
|
56
111
|
//# sourceMappingURL=index.cjs.map
|
package/lib/index.cjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.cjs","sourceRoot":"","sources":["../src/index.cts"],"names":[],"mappings":";;;;;;;;AAAA,0DAA6B;AAC7B,2DAA8C;AAG9C;IACE,OAAO;QACL,IAAI,EAAE,kCAAkC;QAExC,YAAY;YACV,OAAO,mBAAI,CAAC,OAAO,CAAC,SAAS,EAAE,cAAc,CAAC,CAAC;QACjD,CAAC;QAED,eAAe;YACb,OAAO,CAAC,mBAAI,CAAC,OAAO,CAAC,SAAS,EAAE,uCAAuC,CAAC,CAAC,CAAC;QAC5E,CAAC;QAED,gBAAgB;YACd,OAAO,CAAC,mBAAI,CAAC,OAAO,CAAC,SAAS,EAAE,uBAAuB,CAAC,CAAC,CAAC;QAC5D,CAAC;KACF,CAAC;AACJ,CAAC;AAED;;;;;;;;;;GAUG;AACU,QAAA,SAAS,GAAG,mBAAI,CAAC,OAAO,CAAC,SAAS,EAAE,WAAW,CAAC,CAAC;AAE9D;;;;GAIG;AACH;IACE,IAAI,CAAC;QACH,MAAM,OAAO,GAAG,IAAA,6BAAQ,EAAC,8BAA8B,EAAE;YACvD,QAAQ,EAAE,MAAM;YAChB,KAAK,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC;SAChC,CAAC,CAAC,IAAI,EAAE,CAAC;QACV,OAAO,OAAO,CAAC;IACjB,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,KAAK,CAAC;IACf,CAAC;AACH,CAAC;AAED,+DAA+D;AAClD,QAAA,mBAAmB,GAAG,OAAO,CAAC,mBAAI,CAAC,OAAO,CAAC,SAAS,EAAE,kCAAkC,CAAC,CAAC,CAAC"}
|
|
1
|
+
{"version":3,"file":"index.cjs","sourceRoot":"","sources":["../src/index.cts"],"names":[],"mappings":";;;;;;;;AAAA,0DAA6B;AAC7B,2DAA8C;AAG9C;IACE,OAAO;QACL,IAAI,EAAE,kCAAkC;QAExC,YAAY;YACV,OAAO,mBAAI,CAAC,OAAO,CAAC,SAAS,EAAE,cAAc,CAAC,CAAC;QACjD,CAAC;QAED,eAAe;YACb,OAAO,CAAC,mBAAI,CAAC,OAAO,CAAC,SAAS,EAAE,uCAAuC,CAAC,CAAC,CAAC;QAC5E,CAAC;QAED,gBAAgB;YACd,OAAO,CAAC,mBAAI,CAAC,OAAO,CAAC,SAAS,EAAE,uBAAuB,CAAC,CAAC,CAAC;QAC5D,CAAC;KACF,CAAC;AACJ,CAAC;AAED;;;;;;;;;;GAUG;AACU,QAAA,SAAS,GAAG,mBAAI,CAAC,OAAO,CAAC,SAAS,EAAE,WAAW,CAAC,CAAC;AAE9D;;;;GAIG;AACH;IACE,IAAI,CAAC;QACH,MAAM,OAAO,GAAG,IAAA,6BAAQ,EAAC,8BAA8B,EAAE;YACvD,QAAQ,EAAE,MAAM;YAChB,KAAK,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC;SAChC,CAAC,CAAC,IAAI,EAAE,CAAC;QACV,OAAO,OAAO,CAAC;IACjB,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,KAAK,CAAC;IACf,CAAC;AACH,CAAC;AAED,+DAA+D;AAClD,QAAA,mBAAmB,GAAG,OAAO,CAAC,mBAAI,CAAC,OAAO,CAAC,SAAS,EAAE,kCAAkC,CAAC,CAAC,CAAC;AAexG;;;;GAIG;AACH,MAAM,gBAAgB,GAAG,4BAA4B,CAAC;AAEtD;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACU,QAAA,UAAU,GAAc;IACnC,GAAG,EAAE,sBAAsB;IAC3B,GAAG,EAAE,gBAAgB;IACrB,IAAI,EAAE,gCAAgC;IACtC,MAAM,EAAE,OAAO;CAChB,CAAC;AAEF;;;;;;;;;;;;GAYG;AACU,QAAA,UAAU,GAAc;IACnC,GAAG,EAAE,sBAAsB;IAC3B,GAAG,EAAE,gBAAgB;IACrB,IAAI,EAAE,2BAA2B;CAClC,CAAC"}
|
package/lib/index.d.cts
CHANGED
|
@@ -19,4 +19,56 @@ export declare const staticDir: string;
|
|
|
19
19
|
*/
|
|
20
20
|
export declare function getProjectVersion(): string;
|
|
21
21
|
export declare const rehypeTabsTransform: any;
|
|
22
|
+
/**
|
|
23
|
+
* Shape of a Docusaurus navbar or footer logo entry.
|
|
24
|
+
*/
|
|
25
|
+
export interface ThemeLogo {
|
|
26
|
+
alt: string;
|
|
27
|
+
src: string;
|
|
28
|
+
srcDark?: string;
|
|
29
|
+
href: string;
|
|
30
|
+
target?: string;
|
|
31
|
+
width?: number;
|
|
32
|
+
height?: number;
|
|
33
|
+
}
|
|
34
|
+
/**
|
|
35
|
+
* Navbar logo for a Vantage documentation site.
|
|
36
|
+
*
|
|
37
|
+
* ```js
|
|
38
|
+
* const { navbarLogo } = require('@vantagecompute/docusaurus-theme');
|
|
39
|
+
* themeConfig: { navbar: { title: 'v8x', logo: navbarLogo, items: [...] } }
|
|
40
|
+
* ```
|
|
41
|
+
*
|
|
42
|
+
* Deliberately has no `srcDark`. The single colour mark is drawn to read on
|
|
43
|
+
* both colour modes, and a second asset would only be a second thing to keep
|
|
44
|
+
* in sync.
|
|
45
|
+
*
|
|
46
|
+
* `href` points at the docs hub rather than the marketing site: from a spoke's
|
|
47
|
+
* documentation the useful "home" is the rest of the documentation. `target`
|
|
48
|
+
* is `_self` so that jump replaces the tab instead of opening a new one.
|
|
49
|
+
*
|
|
50
|
+
* Override by spreading, never by mutating -- the object is shared by every
|
|
51
|
+
* site in the process:
|
|
52
|
+
*
|
|
53
|
+
* ```js
|
|
54
|
+
* logo: { ...navbarLogo, href: 'https://docs.vantagecompute.ai/developer/' }
|
|
55
|
+
* ```
|
|
56
|
+
*
|
|
57
|
+
* Omit `logo` entirely to render no navbar logo.
|
|
58
|
+
*/
|
|
59
|
+
export declare const navbarLogo: ThemeLogo;
|
|
60
|
+
/**
|
|
61
|
+
* Footer logo for a Vantage documentation site.
|
|
62
|
+
*
|
|
63
|
+
* ```js
|
|
64
|
+
* const { footerLogo } = require('@vantagecompute/docusaurus-theme');
|
|
65
|
+
* themeConfig: { footer: { style: 'dark', logo: footerLogo, links: [...] } }
|
|
66
|
+
* ```
|
|
67
|
+
*
|
|
68
|
+
* Same mark as {@link navbarLogo}, but `href` points at the marketing site:
|
|
69
|
+
* the footer is where a reader who has finished reading looks for the company.
|
|
70
|
+
*
|
|
71
|
+
* Override by spreading; omit `logo` to render no footer logo.
|
|
72
|
+
*/
|
|
73
|
+
export declare const footerLogo: ThemeLogo;
|
|
22
74
|
//# sourceMappingURL=index.d.cts.map
|
package/lib/index.d.cts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.cts","sourceRoot":"","sources":["../src/index.cts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAEhD,MAAM,CAAC,OAAO,UAAU,YAAY,IAAI,MAAM,CAgB7C;AAED;;;;;;;;;;GAUG;AACH,eAAO,MAAM,SAAS,QAAuC,CAAC;AAE9D;;;;GAIG;AACH,wBAAgB,iBAAiB,IAAI,MAAM,CAU1C;AAGD,eAAO,MAAM,mBAAmB,KAAuE,CAAC"}
|
|
1
|
+
{"version":3,"file":"index.d.cts","sourceRoot":"","sources":["../src/index.cts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAEhD,MAAM,CAAC,OAAO,UAAU,YAAY,IAAI,MAAM,CAgB7C;AAED;;;;;;;;;;GAUG;AACH,eAAO,MAAM,SAAS,QAAuC,CAAC;AAE9D;;;;GAIG;AACH,wBAAgB,iBAAiB,IAAI,MAAM,CAU1C;AAGD,eAAO,MAAM,mBAAmB,KAAuE,CAAC;AAExG;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;IACZ,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AASD;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,eAAO,MAAM,UAAU,EAAE,SAKxB,CAAC;AAEF;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,UAAU,EAAE,SAIxB,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@vantagecompute/docusaurus-theme",
|
|
3
|
-
"version": "0.4.
|
|
4
|
-
"description": "Shared Vantage Compute Docusaurus theme
|
|
3
|
+
"version": "0.4.7",
|
|
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",
|
|
7
7
|
"types": "lib/index.d.cts",
|
package/src/index.cts
CHANGED
|
@@ -52,3 +52,74 @@ export function getProjectVersion(): string {
|
|
|
52
52
|
|
|
53
53
|
// Re-export the rehype utility (plain JS, lives in src/utils/)
|
|
54
54
|
export const rehypeTabsTransform = require(path.resolve(__dirname, '../src/utils/rehypeTabsTransform'));
|
|
55
|
+
|
|
56
|
+
/**
|
|
57
|
+
* Shape of a Docusaurus navbar or footer logo entry.
|
|
58
|
+
*/
|
|
59
|
+
export interface ThemeLogo {
|
|
60
|
+
alt: string;
|
|
61
|
+
src: string;
|
|
62
|
+
srcDark?: string;
|
|
63
|
+
href: string;
|
|
64
|
+
target?: string;
|
|
65
|
+
width?: number;
|
|
66
|
+
height?: number;
|
|
67
|
+
}
|
|
68
|
+
|
|
69
|
+
/**
|
|
70
|
+
* The Vantage colour brand mark, as a path relative to a served static
|
|
71
|
+
* directory. It resolves once `staticDir` is in `staticDirectories`; no site
|
|
72
|
+
* needs its own copy of the SVG.
|
|
73
|
+
*/
|
|
74
|
+
const VANTAGE_LOGO_SRC = 'img/vantage-logo-color.svg';
|
|
75
|
+
|
|
76
|
+
/**
|
|
77
|
+
* Navbar logo for a Vantage documentation site.
|
|
78
|
+
*
|
|
79
|
+
* ```js
|
|
80
|
+
* const { navbarLogo } = require('@vantagecompute/docusaurus-theme');
|
|
81
|
+
* themeConfig: { navbar: { title: 'v8x', logo: navbarLogo, items: [...] } }
|
|
82
|
+
* ```
|
|
83
|
+
*
|
|
84
|
+
* Deliberately has no `srcDark`. The single colour mark is drawn to read on
|
|
85
|
+
* both colour modes, and a second asset would only be a second thing to keep
|
|
86
|
+
* in sync.
|
|
87
|
+
*
|
|
88
|
+
* `href` points at the docs hub rather than the marketing site: from a spoke's
|
|
89
|
+
* documentation the useful "home" is the rest of the documentation. `target`
|
|
90
|
+
* is `_self` so that jump replaces the tab instead of opening a new one.
|
|
91
|
+
*
|
|
92
|
+
* Override by spreading, never by mutating -- the object is shared by every
|
|
93
|
+
* site in the process:
|
|
94
|
+
*
|
|
95
|
+
* ```js
|
|
96
|
+
* logo: { ...navbarLogo, href: 'https://docs.vantagecompute.ai/developer/' }
|
|
97
|
+
* ```
|
|
98
|
+
*
|
|
99
|
+
* Omit `logo` entirely to render no navbar logo.
|
|
100
|
+
*/
|
|
101
|
+
export const navbarLogo: ThemeLogo = {
|
|
102
|
+
alt: 'Vantage Compute Logo',
|
|
103
|
+
src: VANTAGE_LOGO_SRC,
|
|
104
|
+
href: 'https://docs.vantagecompute.ai',
|
|
105
|
+
target: '_self',
|
|
106
|
+
};
|
|
107
|
+
|
|
108
|
+
/**
|
|
109
|
+
* Footer logo for a Vantage documentation site.
|
|
110
|
+
*
|
|
111
|
+
* ```js
|
|
112
|
+
* const { footerLogo } = require('@vantagecompute/docusaurus-theme');
|
|
113
|
+
* themeConfig: { footer: { style: 'dark', logo: footerLogo, links: [...] } }
|
|
114
|
+
* ```
|
|
115
|
+
*
|
|
116
|
+
* Same mark as {@link navbarLogo}, but `href` points at the marketing site:
|
|
117
|
+
* the footer is where a reader who has finished reading looks for the company.
|
|
118
|
+
*
|
|
119
|
+
* Override by spreading; omit `logo` to render no footer logo.
|
|
120
|
+
*/
|
|
121
|
+
export const footerLogo: ThemeLogo = {
|
|
122
|
+
alt: 'Vantage Compute Logo',
|
|
123
|
+
src: VANTAGE_LOGO_SRC,
|
|
124
|
+
href: 'https://vantagecompute.ai',
|
|
125
|
+
};
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
<svg width="175" height="40" viewBox="0 0 175 40" fill="none" xmlns="http://www.w3.org/2000/svg">
|
|
2
|
+
<path d="M57.9554 4.46494H47.5905C44.1532 4.46494 41.0348 6.46706 39.5819 9.58542L28.1893 34.9043C27.392 36.623 28.65 38.5897 30.5458 38.5897H39.2807C41.3892 38.5897 43.3027 37.3671 44.1886 35.4536L45.0214 33.6286L57.9554 4.46494Z" fill="url(#paint0_linear_10505_31357)"/>
|
|
3
|
+
<path d="M10.241 0H0L19.596 35.489C20.6591 37.4026 22.679 38.5897 24.8583 38.5897H24.9291H35.1524H39.3515C37.314 38.3948 35.2941 34.5322 35.2941 34.5322L19.1531 5.26223C17.3636 2.01984 13.944 0 10.241 0Z" fill="url(#paint1_linear_10505_31357)"/>
|
|
4
|
+
<path d="M63.5723 9.16017H67.9309L74.0613 24.6279L80.2448 9.14246H84.5857L75.8862 29.837H71.9706L63.5723 9.16017Z" fill="white"/>
|
|
5
|
+
<path d="M98.1044 29.8547H94.5608V28.5791C93.2851 29.6598 91.6374 30.28 89.8479 30.28C85.6841 30.28 82.3354 26.8781 82.3354 22.6258C82.3354 18.3735 85.6841 14.9717 89.8479 14.9717C91.6374 14.9717 93.2851 15.5918 94.5608 16.6726V15.3969H98.1044V29.8547ZM90.344 26.825C92.5764 26.825 94.3659 25.0177 94.3659 22.6258C94.3659 20.2339 92.5764 18.4267 90.344 18.4267C88.0761 18.4267 86.2865 20.2339 86.2865 22.6258C86.2865 25.0177 88.0761 26.825 90.344 26.825Z" fill="white"/>
|
|
6
|
+
<path d="M100 15.3969H103.49V16.4245C104.376 15.4677 105.758 14.9185 107.406 14.9185C110.773 14.9185 113.129 17.2927 113.129 20.73V29.8547H109.391V21.3501C109.391 19.6492 108.257 18.3735 106.644 18.3735C105.032 18.3735 103.756 19.6492 103.756 21.2438V29.8547H100.018V15.3969H100Z" fill="white"/>
|
|
7
|
+
<path d="M124.752 29.3764C124.415 29.6421 123.99 29.837 123.512 29.9788C123.016 30.1205 122.466 30.1914 121.846 30.1914C120.198 30.1914 118.905 29.7484 117.984 28.8625C117.045 27.9766 116.584 26.7541 116.584 25.1772V18.6039H114.918V15.3438H116.584V9.97522H120.5V15.326H122.661L123.671 18.6039H120.464L120.429 25.0355C120.429 26.2226 121.084 26.825 122.413 26.825C122.679 26.825 122.909 26.7895 123.122 26.7364C123.334 26.6832 123.547 26.5769 123.777 26.4175L124.752 29.3764Z" fill="white"/>
|
|
8
|
+
<path d="M141.336 29.8547H137.793V28.5791C136.517 29.6598 134.869 30.28 133.08 30.28C128.916 30.28 125.567 26.8781 125.567 22.6258C125.567 18.3735 128.916 14.9717 133.08 14.9717C134.869 14.9717 136.517 15.5918 137.793 16.6726V15.3969H141.336V29.8547ZM133.558 26.825C135.791 26.825 137.58 25.0177 137.58 22.6258C137.58 20.2339 135.808 18.4267 133.558 18.4267C131.29 18.4267 129.501 20.2339 129.501 22.6258C129.501 25.0177 131.29 26.825 133.558 26.825Z" fill="white"/>
|
|
9
|
+
<path d="M158.469 29.0574C158.469 33.7704 155.298 36.6584 150.159 36.6584C147.502 36.6584 145.021 35.8611 143.249 34.4791L145.004 31.219C146.616 32.601 148.299 33.2034 150.195 33.2034C153.225 33.2034 154.926 31.5911 154.926 28.7562V28.5613C153.65 29.6067 152.002 30.2622 150.213 30.2622C146.049 30.2622 142.7 26.8604 142.7 22.6081C142.7 18.3912 146.049 14.9894 150.213 14.9894C152.002 14.9894 153.65 15.6095 154.926 16.6549V15.4146H158.469V29.0574ZM150.709 26.7895C152.941 26.7895 154.731 24.9823 154.731 22.6258C154.731 20.2516 152.941 18.4267 150.709 18.4267C148.441 18.4267 146.651 20.2339 146.651 22.6258C146.651 24.9823 148.441 26.7895 150.709 26.7895Z" fill="white"/>
|
|
10
|
+
<path d="M168.055 30.28C163.342 30.28 159.887 27.0553 159.887 22.679C159.887 18.3381 163.289 14.9717 167.647 14.9717C171.899 14.9717 174.982 18.2318 174.982 22.5195C174.982 22.9447 174.947 23.4763 174.894 24.0255H163.98C164.352 25.7796 165.787 26.9136 167.948 26.9136C169.419 26.9136 170.464 26.382 171.527 25.1241L174.504 27.3388C173.051 29.2346 170.748 30.28 168.055 30.28ZM171.014 21.0312C170.783 19.3834 169.49 18.2849 167.647 18.2849C165.751 18.2849 164.582 19.4543 164.139 21.0312H171.014Z" fill="white"/>
|
|
11
|
+
<defs>
|
|
12
|
+
<linearGradient id="paint0_linear_10505_31357" x1="35.64" y1="35.7819" x2="48.0775" y2="9.39235" gradientUnits="userSpaceOnUse">
|
|
13
|
+
<stop stop-color="#372A56"/>
|
|
14
|
+
<stop offset="0.0423373" stop-color="#3C2F67"/>
|
|
15
|
+
<stop offset="0.1589" stop-color="#483B90"/>
|
|
16
|
+
<stop offset="0.2785" stop-color="#5245B1"/>
|
|
17
|
+
<stop offset="0.4002" stop-color="#594CCC"/>
|
|
18
|
+
<stop offset="0.5246" stop-color="#5F52DE"/>
|
|
19
|
+
<stop offset="0.6535" stop-color="#6255E9"/>
|
|
20
|
+
<stop offset="0.794" stop-color="#6356ED"/>
|
|
21
|
+
</linearGradient>
|
|
22
|
+
<linearGradient id="paint1_linear_10505_31357" x1="10.9949" y1="2.58894" x2="30.87" y2="40.837" gradientUnits="userSpaceOnUse">
|
|
23
|
+
<stop stop-color="#89EFEC"/>
|
|
24
|
+
<stop offset="0.1188" stop-color="#85E1EC"/>
|
|
25
|
+
<stop offset="0.3426" stop-color="#7CBDEB"/>
|
|
26
|
+
<stop offset="0.6448" stop-color="#6D83EB"/>
|
|
27
|
+
<stop offset="0.869" stop-color="#6153EA"/>
|
|
28
|
+
</linearGradient>
|
|
29
|
+
</defs>
|
|
30
|
+
</svg>
|