Skip to content

Commit 0defacf

Browse files
committed
docs: refine documentation home experience
1 parent 873bdec commit 0defacf

7 files changed

Lines changed: 480 additions & 41 deletions

File tree

‎README.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@ TypeScript-native MongoDB ODM and enhancement layer with v1-compatible APIs, mul
77
[![MongoDB](https://img.shields.io/badge/MongoDB-6.x%20%2F%207.x-green.svg)](https://www.mongodb.com/)
88
[![Node.js](https://img.shields.io/badge/Node.js-18%2B-brightgreen)](https://nodejs.org/)
99

10+
Documentation: [English](https://vextjs.github.io/monSQLize/) · [简体中文](https://vextjs.github.io/monSQLize/zh/)
11+
1012
```bash
1113
npm install monsqlize
1214
```
@@ -443,6 +445,7 @@ See the current support and verification documents:
443445

444446
Current TypeScript documentation and examples are the source of truth for the v2 package:
445447

448+
- Complete docs: [English](https://vextjs.github.io/monSQLize/) · [简体中文](https://vextjs.github.io/monSQLize/zh/)
446449
- `docs/en/**` - default English documentation.
447450
- `docs/zh/**` - Simplified Chinese documentation.
448451
- `docs/en/recipes.md` / `docs/zh/recipes.md` - shortest copy-ready paths for common setup scenarios.

‎changelogs/unreleased.md‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,7 @@
66

77
## Documentation
88

9-
- No unreleased documentation changes yet.
9+
- Added the complete English and Simplified Chinese documentation entry near the top of the README.
10+
- Refined the documentation home hero alignment and replaced the sparse hero mark with a lightweight animated data-flow scene.
11+
- Expanded the documentation home footer into a bilingual VextJS-style resource section with the VextJS organization link and project navigation.
12+
- Aligned the documentation home feature grid with the hero content width and centered the hero visual weight.

‎docs/en/index.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@ hero:
77
text: TypeScript MongoDB Engine
88
tagline: MongoDB-native APIs with cache-hub L1/L2 caching, multi-pool routing, Saga workflows, and schema-ready models.
99
image:
10-
src: /favicon.svg
11-
alt: monSQLize logo
10+
src: /hero-mark.svg
11+
alt: monSQLize hero mark
1212
actions:
1313
- theme: brand
1414
text: Quick Start

‎docs/public/hero-mark.svg‎

Lines changed: 165 additions & 0 deletions
Loading

‎docs/zh/index.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@ hero:
77
text: TypeScript MongoDB 增强引擎
88
tagline: 保留 MongoDB 原生体验,整合 cache-hub 两级缓存、多连接池路由、Saga 编排与可选 Model 层。
99
image:
10-
src: /favicon.svg
11-
alt: monSQLize logo
10+
src: /hero-mark.svg
11+
alt: monSQLize hero mark
1212
actions:
1313
- theme: brand
1414
text: 快速开始

‎website/rspress.config.ts‎

Lines changed: 89 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,6 +91,88 @@ const navSource: NavSource[] = [
9191
}
9292
];
9393

94+
const englishFooterMessage = `
95+
<div class="msq-footer msq-footer--en" role="presentation">
96+
<section class="msq-footer__brand" aria-label="monSQLize">
97+
<span class="msq-footer__mark" aria-hidden="true"></span>
98+
<div>
99+
<strong>monSQLize</strong>
100+
<span>MongoDB-native TypeScript APIs with cache, multi-pool routing, Saga workflows, and optional models.</span>
101+
</div>
102+
</section>
103+
<nav class="msq-footer__grid" aria-label="monSQLize footer">
104+
<div>
105+
<h2>Docs</h2>
106+
<a href="api-index.html">API Reference</a>
107+
<a href="examples.html">Examples</a>
108+
<a href="model.html">Model</a>
109+
<a href="capability-index.html">Advanced</a>
110+
</div>
111+
<div>
112+
<h2>Ecosystem</h2>
113+
<a href="https://github.com/vextjs" target="_blank" rel="noreferrer">VextJS Organization</a>
114+
<a href="https://vextjs.github.io/vext/" target="_blank" rel="noreferrer">VextJS</a>
115+
<a href="https://vextjs.github.io/schema-dsl/" target="_blank" rel="noreferrer">schema-dsl</a>
116+
<a href="https://vextjs.github.io/flex-rate-limit/" target="_blank" rel="noreferrer">flex-rate-limit</a>
117+
</div>
118+
<div>
119+
<h2>Project</h2>
120+
<a href="https://github.com/vextjs/monSQLize" target="_blank" rel="noreferrer">GitHub</a>
121+
<a href="https://github.com/vextjs/monSQLize/blob/main/CHANGELOG.md" target="_blank" rel="noreferrer">Changelog</a>
122+
<a href="https://github.com/vextjs/monSQLize/releases" target="_blank" rel="noreferrer">Releases</a>
123+
<a href="https://github.com/vextjs/monSQLize/issues" target="_blank" rel="noreferrer">Issues</a>
124+
</div>
125+
<div>
126+
<h2>Runtime</h2>
127+
<span>Apache-2.0</span>
128+
<span>Node.js 18+</span>
129+
<span>MongoDB Driver 6.x</span>
130+
<span>TypeScript ready</span>
131+
</div>
132+
</nav>
133+
</div>`;
134+
135+
const chineseFooterMessage = `
136+
<div class="msq-footer msq-footer--zh" role="presentation">
137+
<section class="msq-footer__brand" aria-label="monSQLize">
138+
<span class="msq-footer__mark" aria-hidden="true"></span>
139+
<div>
140+
<strong>monSQLize</strong>
141+
<span>保留 MongoDB 原生体验,整合缓存、多连接池路由、Saga 编排与可选 Model 层。</span>
142+
</div>
143+
</section>
144+
<nav class="msq-footer__grid" aria-label="monSQLize 页脚">
145+
<div>
146+
<h2>文档</h2>
147+
<a href="api-index.html">API 参考</a>
148+
<a href="examples.html">示例</a>
149+
<a href="model.html">Model</a>
150+
<a href="capability-index.html">高级能力</a>
151+
</div>
152+
<div>
153+
<h2>生态</h2>
154+
<a href="https://github.com/vextjs" target="_blank" rel="noreferrer">VextJS 组织</a>
155+
<a href="https://vextjs.github.io/vext/" target="_blank" rel="noreferrer">VextJS</a>
156+
<a href="https://vextjs.github.io/schema-dsl/" target="_blank" rel="noreferrer">schema-dsl</a>
157+
<a href="https://vextjs.github.io/flex-rate-limit/" target="_blank" rel="noreferrer">flex-rate-limit</a>
158+
</div>
159+
<div>
160+
<h2>项目</h2>
161+
<a href="https://github.com/vextjs/monSQLize" target="_blank" rel="noreferrer">GitHub</a>
162+
<a href="https://github.com/vextjs/monSQLize/blob/main/CHANGELOG.md" target="_blank" rel="noreferrer">更新日志</a>
163+
<a href="https://github.com/vextjs/monSQLize/releases" target="_blank" rel="noreferrer">Releases</a>
164+
<a href="https://github.com/vextjs/monSQLize/issues" target="_blank" rel="noreferrer">Issues</a>
165+
</div>
166+
<div>
167+
<h2>运行基线</h2>
168+
<span>Apache-2.0</span>
169+
<span>Node.js 18+</span>
170+
<span>MongoDB Driver 6.x</span>
171+
<span>TypeScript ready</span>
172+
</div>
173+
</nav>
174+
</div>`;
175+
94176
const sidebarSource: SidebarGroupSource[] = [
95177
{
96178
en: 'Getting Started',
@@ -471,6 +553,9 @@ export default defineConfig({
471553
nav: englishNav,
472554
sidebar: {
473555
'/': englishSidebar
556+
},
557+
footer: {
558+
message: englishFooterMessage
474559
}
475560
},
476561
{
@@ -481,6 +566,9 @@ export default defineConfig({
481566
nav: chineseNav,
482567
sidebar: {
483568
'/zh/': chineseSidebar
569+
},
570+
footer: {
571+
message: chineseFooterMessage
484572
}
485573
}
486574
],
@@ -496,7 +584,7 @@ export default defineConfig({
496584
}
497585
],
498586
footer: {
499-
message: 'Released under the Apache License 2.0.'
587+
message: `${englishFooterMessage}\n${chineseFooterMessage}`
500588
}
501589
}
502590
});

0 commit comments

Comments
 (0)