docs: update README

Justin3go · Feb 6, 2024 · d03cbdd · d03cbdd
1 parent bbc435b
commit d03cbdd
Showing 1 changed file with 48 additions and 63 deletions.
diff --git a/README.md b/README.md
@@ -1,66 +1,47 @@
-<p align="center">
+<div align="center">
+<p>
   <a href="https://justin3go.com" target="blank">
     <img src="./images/ava.png" height="200px" alt="logo" />
-    <h1 align="center">&lt; Welcome to justin3go.com /&gt;</h1>
+    <h1 align="center">&lt; Justin3go's Blog /&gt;</h1>
   </a>
 </p>
 
-<p align="center">
-  <a href="https://vitepress.dev/" style="text-decoration: none;">
-    <img src="https://img.shields.io/badge/vitepress-1.0-646CFF?style=for-the-badge&logo=vite&logoColor=white" alt="">
-  </a>
-  <a href="https://www.typescriptlang.org/" style="text-decoration: none;">
-    <img src="https://img.shields.io/badge/TypeScript-3178C6?style=for-the-badge&logo=typescript&logoColor=white" alt="">
-  </a>
-  <a href="https://giscus.app/zh-CN" style="text-decoration: none;">
-    <img src="https://img.shields.io/badge/giscus-4688F1?style=for-the-badge&logo=github&logoColor=white" alt="">
-  </a>
-</p>
-
-<p align="center">
-一款功能齐全的、现代化的、简洁优雅的<a href="https://justin3go.com">静态博客</a>，基于vitepress，集成giscus评论，简单设计了一下首页；主要记录✍️我的博客、笔记。
-</p>
+[![](https://img.shields.io/badge/TypeScript-3178C6?style=for-the-badge&logo=typescript&logoColor=white)](https://www.typescriptlang.org/)
+[![](https://img.shields.io/badge/giscus-4688F1?style=for-the-badge&logo=github&logoColor=white)](https://giscus.app/zh-CN)
+[![](https://img.shields.io/badge/vitepress-1.0-646CFF?style=for-the-badge&logo=vite&logoColor=white)](https://vitepress.dev/)
 
-<p align="center">
-每周末如有更新release一次，文章发布以及网站修改会记录在release中，欢迎star⭐/watch关注最新动态~
-</p>
+一款功能齐全的、现代化的、简洁优雅的[静态博客](https://justin3go.com)，基于vitepress，集成giscus评论，简单设计了一下首页；主要记录✍️我的博客、笔记。
 
-<p align="center">
-  简体中文 | <a href="./README-EN.md">English Docs</a>
-</p>
+每周末如有更新release一次，文章发布以及网站修改会记录在release中，欢迎star/watch(custom->release)关注最新动态~
 
+[![changelog](https://img.shields.io/badge/changelog-→-0052CC?style=for-the-badge&logo=ReSharper&logoColor=white)](./CHANGELOG.md)
 
-## 功能特点
+![image](/images/HomePreview.png)
 
-- 白/夜切换使用不同主题色(蓝/黄)
-- 集成giscus评论
-- 自动生成[RSS订阅文件](https://justin3go.com/feed.xml)
-- 短链接生成，为语义化中文URL生成易于社交分享的链接，如[justin3go.com/s?u=590f2bc50aa](justin3go.com/s?u=590f2bc50aa)
-- 首页自动生成最近文章目录
-- 首页视频播放以及移动端降级显示为图片
-- [github action](https://github.com/Justin3go/justin3go.github.io/blob/master/.github/workflows/deploy.yml) 监听push操作，自动部署至github page
-- [github action](https://github.com/Justin3go/justin3go.github.io/blob/master/.github/workflows/release.yml) 自动生成[Changelog](https://github.com/Justin3go/justin3go.github.io/blob/master/CHANGELOG.md)
-- 集成google analytic 与 google adsense
-- 社交分享优化：生成twitter卡片
-- 全局图片大图预览
+简体中文 | [English Docs](./README-EN.md)
 
-## 分支介绍
+</div>
 
-- master分支为正式分支，用于发布版本，自动监听Push发版
-- online分支为线上分支，用于部署，自动监听Push部署
-- 其他分支为功能分支，用于开发
-
-## 演示截图
-
-![image](/images/HomePreview.png)
+## 功能特点
 
-![image](/images/BlogArchivePreview.png)
 
-![image](/images/StudyNotesPreview.png)
+| 功能特点                                         | 说明                                                                                                                                                                 |
+| -------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| 白/夜切换使用不同主题色                          | 蓝/黄                                                                                                                                                                |
+| 集成giscus评论                                   | 适配深色模式                                                                                                                                                         |
+| 自动生成RSS订阅文件                              | [链接](https://justin3go.com/feed.xml)                                                                                                                               |
+| 短链接生成                                       | 为语义化中文URL生成易于社交分享的链接，如[justin3go.com/s?u=590f2bc50aa](https://justin3go.com/s?u=590f2bc50aa)                                                      |
+| 首页自动生成最近文章目录                         | --                                                                                                                                                                   |
+| 首页视频背景播放                                 | 移动端会降级显示为图片                                                                                                                                               |
+| github action监听push操作，自动部署至github page | [点击链接查看详情](https://github.com/Justin3go/justin3go.github.io/blob/master/.github/workflows/deploy.yml)                                                        |
+| github action自动生成Changelog                   | [Changelog](https://github.com/Justin3go/justin3go.github.io/blob/master/CHANGELOG.md)                                                                               |
+| 集成google analytic 与 google adsense            | 为提高体验，google adsense已删除，可以在[该commit](https://github.com/Justin3go/justin3go.github.io/commit/13a08c192be464f2052efd8f1da9547d4184eede)中查看如何新增它 |
+| 社交分享优化                                     | 链接自动生成twitter卡片                                                                                                                                              |
+| 全局图片大图预览                                 | 基于TDesign                                                                                                                                                          |
 
 ## 相关阅读推荐
 
-> 以下链接为笔者建站过程中的一些博客记录，也许对您有所帮助
+以下链接为笔者建站过程中的一些博客记录，也许对您有所帮助：
 
 - [vitepress中引入Tdesign并全局增加大图预览](https://justin3go.com/%E5%8D%9A%E5%AE%A2/2023/09/29vitepress%E4%B8%AD%E5%BC%95%E5%85%A5Tdesign%E5%B9%B6%E5%85%A8%E5%B1%80%E5%A2%9E%E5%8A%A0%E5%A4%A7%E5%9B%BE%E9%A2%84%E8%A7%88.html)
 - [vitepress中增加twitter/x卡片](https://justin3go.com/%E5%8D%9A%E5%AE%A2/2023/09/28vitepress%E4%B8%AD%E5%A2%9E%E5%8A%A0twitter%E5%8D%A1%E7%89%87.html)
@@ -70,6 +51,25 @@
 - [极简地给个人博客添加订阅功能](https://justin3go.com/%E5%8D%9A%E5%AE%A2/2023/03/31%E6%9E%81%E7%AE%80%E5%9C%B0%E7%BB%99%E4%B8%AA%E4%BA%BA%E5%8D%9A%E5%AE%A2%E6%B7%BB%E5%8A%A0%E8%AE%A2%E9%98%85%E5%8A%9F%E8%83%BD.html)
 - [玩转vitepress](https://justin3go.com/%E5%8D%9A%E5%AE%A2/2022/06%E7%8E%A9%E8%BD%ACvitepress.html)
 
+## 本地开发
+
+```shell
+npm i -g pnpm
+# 安装依赖
+pnpm install
+pnpm docs:dev
+```
+
+**值得注意的是，gitcus评论组件中的参数需要你自己生成，否则评论会出现在该仓库而非你的仓库，[点击链接查看详情](https://github.com/Justin3go/justin3go.github.io/blob/master/docs/.vitepress/theme/components/comment.vue)**
+
+分支介绍：
+
+- master分支为正式分支，用于发布版本，自动监听Push发版
+- online分支为线上分支，用于部署，自动监听Push部署
+- 其他分支为功能分支，用于开发
+
+*由于本项目并没有做过多的功能开发，更多使用的是vitepress本身自带的功能，仅仅只设计了一小部分，所以没有封装为主题，开源主要是提供一些思路参考，如果你想直接clone使用的话，并不能直接开箱即用，本仓库可能更适合一些比较喜欢折腾的朋友进行使用。*
+
 ## 首页设计理念
 
 **奔跑的狼**
@@ -92,29 +92,14 @@
 
 为什么主页还有增加留言板，不是每篇文章都可以评论吗？留言板更多是对整个网站或者笔者进行留言，而非针对具体内容。
 
-## 本地开发
-
-```shell
-npm i -g pnpm
-# 安装依赖
-pnpm install
-pnpm docs:dev
-```
-
-> 值得注意的是，gitcus评论组件中的参数需要你自己生成，否则评论会出现在该仓库而非你的仓库，[点击链接查看详情](https://github.com/Justin3go/justin3go.github.io/blob/master/docs/.vitepress/theme/components/comment.vue)
-
-## ChangeLog
-
-详细信息查看[这里](https://github.com/Justin3go/justin3go.github.io/blob/master/CHANGELOG.md)
-
 ## 协议
 
 本仓库中所有后缀为`.md`的文件均采用以下协议进行许可：
 
 > Creative Commons Attribution 4.0 International License,本作品采用知识共享署名 4.0 国际许可协议进行许可。
-> 
+>
 > 您可以自由地共享和演绎本作品，但需遵循以下条件：署名：您必须给出适当的署名，提供指向本许可协议的链接，同时标明是否作出了修改。您可以用任何合理的方式来署名，但不得以任何方式暗示许可人为您或您的使用背书。
-> 
+>
 > [详细的许可证条款和条件可参见此链接](https://creativecommons.org/licenses/by/4.0/legalcode.zh-Hans)
 
 其余文件均为 MIT 协议，[详细的许可证条款和条件可参见此链接](https://zh.wikipedia.org/zh-cn/MIT%E8%A8%B1%E5%8F%AF%E8%AD%89)