Skip to content

Commit 1dffa54

Browse files
committed
Enhance documentation configuration and styles
- Added logo configuration for light and dark modes in `docmd.config.js`. - Introduced a sponsor section in the configuration. - Updated theme settings to include custom CSS. - Bumped `@mgks/docmd` version to 0.3.8 in `package.json` and updated lock file. - Added new CSS files for base styles and Vercel theme. - Included SVG logo asset for branding.
1 parent d28edbf commit 1dffa54

6 files changed

Lines changed: 72 additions & 1561 deletions

File tree

assets/css/base.css

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
.sidebar-header {
2+
height: 2.9em;
3+
}

assets/images/vds.svg

Lines changed: 13 additions & 0 deletions
Loading

docmd.config.js

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,15 +15,28 @@ module.exports = {
1515
collapsible: true,
1616
defaultCollapsed: false,
1717
},
18+
logo: {
19+
light: "/assets/images/vds.svg", // Path to logo for light mode
20+
dark: "/assets/images/vds.svg", // Path to logo for dark mode
21+
alt: "Variable Design Standard (VDS) Logo", // Alt text for the logo
22+
href: "/", // Optional: link for the logo, defaults to site root
23+
height: "100px", // Optional: specify height via CSS is often better
24+
},
1825
theme: {
1926
name: "default",
2027
defaultMode: "dark",
2128
enableModeToggle: true,
2229
positionMode: "top",
30+
customCss: ["/assets/css/base.css"],
2331
// customCss: ["/assets/css/vercel-theme.css"],
2432
},
2533
autoTitleFromH1: true,
2634
copyCode: true,
35+
sponsor: {
36+
enabled: true,
37+
title: "Sponsor the Project",
38+
link: "https://github.com/sponsors/marklearst",
39+
},
2740
customJs: ["/assets/js/vercel-analytics.js"],
2841
navigation: [
2942
{ title: "Home", path: ".", icon: "home" },
@@ -224,7 +237,11 @@ module.exports = {
224237
children: [
225238
{ title: "CSS", path: "consumption/css", icon: "file-code" },
226239
{ title: "TypeScript", path: "consumption/typescript", icon: "type" },
227-
{ title: "UI Libraries", path: "consumption/frameworks", icon: "layers" },
240+
{
241+
title: "UI Libraries",
242+
path: "consumption/frameworks",
243+
icon: "layers",
244+
},
228245
],
229246
},
230247
{

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,6 @@
1212
"version:check": "node scripts/check-version.js"
1313
},
1414
"devDependencies": {
15-
"@mgks/docmd": "^0.3.2"
15+
"@mgks/docmd": "^0.3.8"
1616
}
1717
}

0 commit comments

Comments
 (0)