Skip to content

Commit 463af21

Browse files
committed
feat: update readme
1 parent d000474 commit 463af21

File tree

3 files changed

+52
-30
lines changed

3 files changed

+52
-30
lines changed

README.md

Lines changed: 31 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,31 @@
1-
blog
1+
## 仿 Shiro 纯前端博客
2+
3+
### :wrench: 技术栈
4+
5+
- **Next.js (App Router)**
6+
- **Zustand**
7+
- **Framer Motion**
8+
- **TailwindCSS**
9+
10+
### :sparkles: 特色功能
11+
12+
-**快速**:通过 Next.js 的 SSR 和 RSC 优化首屏加载时间,部分内链实现跳转路由预加载,提升用户体验。
13+
- 🌱 **简洁易用**:纯前端架构,搭建简单,支持在 Vercel 上一键部署。用户可通过修改配置文件轻松自定义元数据(MetaData)、主题色等内容。
14+
- 🔮 **UI**:响应式布局,完美适配移动端与 PC 端,基于 Framer Motion 实现流畅的弹性动画,增强用户互动体验。
15+
16+
### 📄 使用
17+
18+
- 克隆此仓库,使用 `pnpm i` 下载依赖,`pnpm run dev` 启动项目。
19+
- 用户可以修改 `config` 文件配置:
20+
- `about.ts`:修改首页的 Hero 区域文字。
21+
- `color.ts`:自定义主题色。
22+
- `friends.ts`:配置友链。
23+
- `introduction.ts`:配置个人介绍。
24+
- `projects.ts`:配置项目列表。
25+
- `seo.ts`:配置 SEO 优化项(如网页的 title、description 等 MetaData)。
26+
- 文章存放在 `markdown` 文件夹下,同时需要修改 `markdown/index.json` 文件,添加文章的元数据。
27+
- 文章的封面图片需放在 `public/postCoverImage` 目录下。
28+
29+
## :heart: 鸣谢
30+
31+
项目参考了 [Innei](https://github.com/innei/)[个人网站](https://innei.in/),感谢大佬的开源!

markdown/index.json

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
11
[
2-
{
3-
"authors": ["yy"],
4-
"path": "yyblog.md",
5-
"title": "yyblog",
6-
"tag": "技术/react",
7-
"coverImage": "https://p6-xtjj-sign.byteimg.com/tos-cn-i-73owjymdk6/0b76076eab124179816d68b846280cdc~tplv-73owjymdk6-jj-mark-v1:0:0:0:0:5o6Y6YeR5oqA5pyv56S-5Yy6IEAgTWVnYXRyb25LaW5n:q75.awebp?rk3s=f64ab15b&x-expires=1731736114&x-signature=3ggdE9od5WvMZaVJ7VFlQtt48rA%3D"
8-
},
9-
{
10-
"authors": ["yy"],
11-
"path": "react19.md",
12-
"title": "react19",
13-
"tag": "随笔/生活",
14-
"summary": "这篇文章记录了react19相关的一些内容",
15-
"coverImage": "https://p6-xtjj-sign.byteimg.com/tos-cn-i-73owjymdk6/0b76076eab124179816d68b846280cdc~tplv-73owjymdk6-jj-mark-v1:0:0:0:0:5o6Y6YeR5oqA5pyv56S-5Yy6IEAgTWVnYXRyb25LaW5n:q75.awebp?rk3s=f64ab15b&x-expires=1731736114&x-signature=3ggdE9od5WvMZaVJ7VFlQtt48rA%3D"
16-
}
17-
]
2+
{
3+
"authors": ["yy"],
4+
"path": "yyblog.md",
5+
"title": "yyblog",
6+
"tag": "技术/react",
7+
"coverImage": "https://p6-xtjj-sign.byteimg.com/tos-cn-i-73owjymdk6/0b76076eab124179816d68b846280cdc~tplv-73owjymdk6-jj-mark-v1:0:0:0:0:5o6Y6YeR5oqA5pyv56S-5Yy6IEAgTWVnYXRyb25LaW5n:q75.awebp?rk3s=f64ab15b&x-expires=1731736114&x-signature=3ggdE9od5WvMZaVJ7VFlQtt48rA%3D"
8+
},
9+
{
10+
"authors": ["yy"],
11+
"path": "react19.md",
12+
"title": "react19",
13+
"tag": "随笔/生活",
14+
"summary": "这篇文章记录了react19相关的一些内容",
15+
"coverImage": "https://p6-xtjj-sign.byteimg.com/tos-cn-i-73owjymdk6/0b76076eab124179816d68b846280cdc~tplv-73owjymdk6-jj-mark-v1:0:0:0:0:5o6Y6YeR5oqA5pyv56S-5Yy6IEAgTWVnYXRyb25LaW5n:q75.awebp?rk3s=f64ab15b&x-expires=1731736114&x-signature=3ggdE9od5WvMZaVJ7VFlQtt48rA%3D"
16+
}
17+
]

markdown/output.json

Lines changed: 5 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,7 @@
11
{
22
"postDataMap": {
33
"yyblog": {
4-
"authors": [
5-
"yy"
6-
],
4+
"authors": ["yy"],
75
"title": "yyblog",
86
"tag": "技术/react",
97
"path": "yyblog",
@@ -17,9 +15,7 @@
1715
"modified": true
1816
},
1917
"react19": {
20-
"authors": [
21-
"yy"
22-
],
18+
"authors": ["yy"],
2319
"title": "react19",
2420
"tag": "随笔/生活",
2521
"path": "react19",
@@ -36,9 +32,7 @@
3632
},
3733
"postDataList": [
3834
{
39-
"authors": [
40-
"yy"
41-
],
35+
"authors": ["yy"],
4236
"title": "yyblog",
4337
"tag": "技术/react",
4438
"path": "yyblog",
@@ -52,9 +46,7 @@
5246
"modified": true
5347
},
5448
{
55-
"authors": [
56-
"yy"
57-
],
49+
"authors": ["yy"],
5850
"title": "react19",
5951
"tag": "随笔/生活",
6052
"path": "react19",
@@ -69,4 +61,4 @@
6961
"modified": true
7062
}
7163
]
72-
}
64+
}

0 commit comments

Comments
 (0)