diff --git a/README.md b/README.md index a679e9373..68983293f 100644 --- a/README.md +++ b/README.md @@ -3,10 +3,10 @@ # 查尔斯的知识库 - + - + @@ -15,4 +15,76 @@ 📝 **查尔斯的个人知识库,记录 & 分享个人碎片化、结构化、体系化的知识内容。** -🐢 [GitHub Pages](https://blog.charles7c.top) | 🐇 [Gitee Pages](https://charles7c.gitee.io) \ No newline at end of file +🐢 [GitHub Pages](https://blog.charles7c.top) | 🐇 [Gitee Pages](https://charles7c.gitee.io) + +## 开始 + +```bash +# 1.克隆本仓库 +git clone https://github.com/Charles7c/charles7c.github.io.git +# 2.安装依赖 +yarn install +# 3.dev 运行,访问:http://localhost:3000 +yarn dev +# 4.打包,文件存放位置:repos/.vitepress/dist +yarn build +# 5.部署 +# 5.1 在 GitHub 启用 GitHub Pages +# 5.2 在其他平台部署, 例如:Gitee Pages、Vercel、Netlify、个人虚拟主机、个人服务器等 +``` + +## 已扩展功能(持续优化细节) + +- [x] 拆分配置文件:解决“大”配置文件问题,提取公有配置选项进行复用,方便维护 +- [x] GitHub Action:push 到 GitHub,自动进行项目打包及 GitHub Pages 部署,并同步到 Gitee Pages(可根据需要自行删除同步 Gitee Pages 部分工作流配置) +- [x] 自动生成导航:将文章按规律性目录存放后,导航和侧边栏将自动生成 +- [x] 主页美化:参照 vite 文档主页进行美化 +- [x] 自定义页脚:支持ICP备案号、公安备案号、版权信息配置(符合大陆网站审核要求) +- [x] 文章元数据信息显示:文章标题下显示作者、发布时间、所属分类、标签列表等信息 +- [x] 《我的标签》:模仿语雀标签页风格,https://www.yuque.com/r/语雀用户名/tags?tag= +- [x] 《我的归档》:自定义时间轴,展示历史文章数据。年份前可展示生肖,可按分类、标签筛选 +- [x] 更多细节优化:敬请发现 +- [ ] 文章评论:Gitalk + +## 部分页面截图 + +### 主页美化 + +![主页](./repos/public/screenshot/主页.png) + +### 文章元数据信息 + +![文章元数据信息](./repos/public/screenshot/文章元数据信息.png) + +### 我的标签 + +![我的标签](./repos/public/screenshot/我的标签1.png) +![我的标签](./repos/public/screenshot/我的标签2.png) + +### 我的归档 + +![我的归档](./repos/public/screenshot/我的归档1.png) +![我的归档](./repos/public/screenshot/我的归档2.png) + +### 文章评论(未完待续) + +![文章评论](./repos/public/screenshot/文章评论1.png) +![文章评论](./repos/public/screenshot/文章评论2.png) + +## 致谢 + +- [vuejs/vitepress](https://github.com/vuejs/vitepress) (本知识库基于 vitepress 构建) +- [vitejs/vite](https://github.com/vitejs/vite) (参考主页美化) +- [brc-dd/vitepress-with-arco](https://github.com/brc-dd/vitepress-with-arco) (感谢 vitepress 维护者 brc-dd 的帮助) +- [brc-dd/vitepress-blog-demo](https://github.com/brc-dd/vitepress-blog-demo) +- [windicss/docs](https://github.com/windicss/docs) (参考配置文件拆分) +- [dingqianwen/my-blog](https://github.com/dingqianwen/my-blog) (参考 Gitalk 配置暗黑主题) +- [clark-cui/vitepress-blog-zaun](https://github.com/clark-cui/vitepress-blog-zaun) (参考文章标签的数据处理方案) +- [arco-design/arco-design-vue](https://github.com/arco-design/arco-design-vue) (使用部分组件及图标) +- ...... + +## License + +- 文章遵循[ CC 4.0 BY-SA ](http://creativecommons.org/licenses/by-sa/4.0/)版权协议,转载请附上原文出处链接和声明 +- 源码遵循 [MIT](https://github.com/Charles7c/charles7c.github.io/blob/main/LICENSE) 协议 +- Copyright © 2019-2022 Charles7c \ No newline at end of file diff --git a/repos/public/screenshot/主页.png b/repos/public/screenshot/主页.png new file mode 100644 index 000000000..4a5b82d80 Binary files /dev/null and b/repos/public/screenshot/主页.png differ diff --git a/repos/public/screenshot/我的归档1.png b/repos/public/screenshot/我的归档1.png new file mode 100644 index 000000000..6751b7225 Binary files /dev/null and b/repos/public/screenshot/我的归档1.png differ diff --git a/repos/public/screenshot/我的归档2.png b/repos/public/screenshot/我的归档2.png new file mode 100644 index 000000000..6de11ed20 Binary files /dev/null and b/repos/public/screenshot/我的归档2.png differ diff --git a/repos/public/screenshot/我的标签1.png b/repos/public/screenshot/我的标签1.png new file mode 100644 index 000000000..7583ea7e6 Binary files /dev/null and b/repos/public/screenshot/我的标签1.png differ diff --git a/repos/public/screenshot/我的标签2.png b/repos/public/screenshot/我的标签2.png new file mode 100644 index 000000000..11629aa75 Binary files /dev/null and b/repos/public/screenshot/我的标签2.png differ diff --git a/repos/public/screenshot/文章元数据信息.png b/repos/public/screenshot/文章元数据信息.png new file mode 100644 index 000000000..24952ad42 Binary files /dev/null and b/repos/public/screenshot/文章元数据信息.png differ diff --git a/repos/public/screenshot/文章评论1.png b/repos/public/screenshot/文章评论1.png new file mode 100644 index 000000000..c50ddd10e Binary files /dev/null and b/repos/public/screenshot/文章评论1.png differ diff --git a/repos/public/screenshot/文章评论2.png b/repos/public/screenshot/文章评论2.png new file mode 100644 index 000000000..3fd4707e9 Binary files /dev/null and b/repos/public/screenshot/文章评论2.png differ