Skip to content

Commit f1cdd37

Browse files
committed
docs: add logo and sage brand theme
Surface the new logo in the README, VitePress navbar, home hero, and favicon. Override VitePress brand tokens with the logo's sage palette (#517158 in light mode, #ADC77F in dark) and recolor the shield.io badges to match. Also widen the .gitignore globs so .vitepress/{cache, dist} are ignored from any workspace location.
1 parent f994c4b commit f1cdd37

7 files changed

Lines changed: 79 additions & 8 deletions

File tree

.gitignore

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,6 @@ logs
1212
node_modules
1313
temp
1414
.turbo
15-
.vitepress/cache
16-
.vitepress/dist
15+
**/.vitepress/cache
16+
**/.vitepress/dist
1717
packages/devframe/skills

README.md

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,10 @@
1-
# Devframe
1+
<p align="center">
2+
<a href="https://devfra.me/" target="_blank" rel="noopener noreferrer">
3+
<img src="https://raw.githubusercontent.com/devframes/devframe/main/docs/public/logo.svg" width="140" alt="Devframe" />
4+
</a>
5+
</p>
6+
7+
<h1 align="center">Devframe</h1>
28

39
[![npm version][npm-version-src]][npm-version-href]
410
[![npm downloads][npm-downloads-src]][npm-downloads-href]
@@ -72,13 +78,13 @@ await createCli(devframe).parse()
7278

7379
<!-- Badges -->
7480

75-
[npm-version-src]: https://img.shields.io/npm/v/devframe?style=flat&colorA=080f12&colorB=1fa669
81+
[npm-version-src]: https://img.shields.io/npm/v/devframe?style=flat&colorA=080f12&colorB=517158
7682
[npm-version-href]: https://npmx.dev/package/devframe
77-
[npm-downloads-src]: https://img.shields.io/npm/dm/devframe?style=flat&colorA=080f12&colorB=1fa669
83+
[npm-downloads-src]: https://img.shields.io/npm/dm/devframe?style=flat&colorA=080f12&colorB=517158
7884
[npm-downloads-href]: https://npmx.dev/package/devframe
79-
[bundle-src]: https://img.shields.io/bundlephobia/minzip/devframe?style=flat&colorA=080f12&colorB=1fa669&label=minzip
85+
[bundle-src]: https://img.shields.io/bundlephobia/minzip/devframe?style=flat&colorA=080f12&colorB=517158&label=minzip
8086
[bundle-href]: https://bundlephobia.com/result?p=devframe
81-
[license-src]: https://img.shields.io/github/license/devframes/devframe.svg?style=flat&colorA=080f12&colorB=1fa669
87+
[license-src]: https://img.shields.io/github/license/devframes/devframe.svg?style=flat&colorA=080f12&colorB=517158
8288
[license-href]: https://github.com/devframes/devframe/blob/main/LICENSE.md
83-
[jsdocs-src]: https://img.shields.io/badge/jsdocs-reference-080f12?style=flat&colorA=080f12&colorB=1fa669
89+
[jsdocs-src]: https://img.shields.io/badge/jsdocs-reference-080f12?style=flat&colorA=080f12&colorB=517158
8490
[jsdocs-href]: https://www.jsdocs.io/package/devframe

docs/.vitepress/config.ts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,11 @@ export function devframeNav(prefix = ''): DefaultTheme.NavItemWithLink[] {
5858
export default withMermaid(defineConfig({
5959
title: 'Devframe',
6060
description: 'Framework-neutral foundation for building generic DevTools — RPC layer, hosts, and adapters.',
61+
head: [
62+
['link', { rel: 'icon', type: 'image/svg+xml', href: '/logo.svg' }],
63+
],
6164
themeConfig: {
65+
logo: { light: '/logo.svg', dark: '/logo.svg' },
6266
nav: [
6367
{ text: 'Guide', items: guideItems('') },
6468
{ text: 'Error Reference', link: '/errors/' },

docs/.vitepress/theme/index.ts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
import DefaultTheme from 'vitepress/theme'
2+
import './style.css'
3+
4+
export default DefaultTheme

docs/.vitepress/theme/style.css

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
:root {
2+
--vp-c-brand-1: #517158;
3+
--vp-c-brand-2: #486954;
4+
--vp-c-brand-3: #3e5c4a;
5+
--vp-c-brand-soft: rgba(81, 113, 88, 0.14);
6+
7+
--vp-button-brand-border: transparent;
8+
--vp-button-brand-text: #ffffff;
9+
--vp-button-brand-bg: #517158;
10+
--vp-button-brand-hover-border: transparent;
11+
--vp-button-brand-hover-text: #ffffff;
12+
--vp-button-brand-hover-bg: #486954;
13+
--vp-button-brand-active-border: transparent;
14+
--vp-button-brand-active-text: #ffffff;
15+
--vp-button-brand-active-bg: #3e5c4a;
16+
17+
--vp-home-hero-name-color: transparent;
18+
--vp-home-hero-name-background: linear-gradient(120deg, #adc77f, #517158);
19+
20+
--vp-local-search-highlight-bg: #517158;
21+
}
22+
23+
.dark {
24+
--vp-c-brand-1: #adc77f;
25+
--vp-c-brand-2: #93b062;
26+
--vp-c-brand-3: #7f9c4e;
27+
--vp-c-brand-soft: rgba(173, 199, 127, 0.16);
28+
29+
--vp-local-search-highlight-bg: #adc77f;
30+
}

docs/index.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,10 @@ hero:
55
name: Devframe
66
text: Framework-neutral foundation for DevTools
77
tagline: One devframe definition. Seven adapters. RPC, hosts, shared state, and agent-native — independent of Vite and any UI framework.
8+
image:
9+
src: /logo.svg
10+
alt: Devframe
11+
width: 240
812
actions:
913
- theme: brand
1014
text: Get Started

docs/public/logo.svg

Lines changed: 23 additions & 0 deletions
Loading

0 commit comments

Comments
 (0)