search

airene / vitepress-blog-pure

a vitepress theme for blog, demo ↓
https://ti.bi
MIT License
183 stars 26 forks source link

feat: change style and refactor code #19

Closed Albert26193 closed 6 months ago

Albert26193 commented 6 months ago
  1. 调整了式样，将 tag/timeline/layout 的式样进行规整和重构。
  2. 解决了 ts 编程当中的部分类型错误，并将所有 js 代码调整为 ts 代码。
  3. 引入了 unocss 原子化样式库，便于处理简单的样式修改。
  4. 增加了 markdown-it-mathjax3 进行数学公式的解析。
  5. 将 config.js 重写为 config.ts，并拆分到 config 目录当中，将 head、nav 等部分分开配置。
  6. 指定 vitepress 的 srcDir 为 /src 目录，避免了文件的散乱放置。
  7. 调整了 page 分页的逻辑，将其产物，即 page_1.md ... page_x.md 等，统一放到 page 目录下。
  8. 增加了主页，即 index.md，形式上更加完备。
  9. 调整了 斜体、加粗、代码块的渲染逻辑，看上去内容更加明显。
  10. 引入了微软 clarity 埋点工具，便于统计项目概况。

  11. 引入了图片的尺寸控制，在 img 的语法当中，添加 s 或 xs/m/l/xl 等待，即可控制图片的大小。

    我的个人博客基于此进行了部署，请您看一下最终的效果：https://blog.albert.cool/ 此次 PR 修改的内容很多，如果您对此存在疑问，可以邮件联系我 albert990624@gmail.com 很希望您能够同意我的 pr

airene commented 6 months ago

赞，回头我看一下哈

Albert26193 @.***> 于2024年3月17日周日 16:07写道：

  1. 调整了式样，将 tag/timeline/layout 的式样进行规整和重构。
  2. 解决了 ts 编程当中的部分类型错误，并将所有 js 代码调整为 ts 代码。
  3. 引入了 unocss 原子化样式库，便于处理简单的样式修改。
  4. 增加了 markdown-it-mathjax3 进行数学公式的解析。
  5. 将 config.js 重写为 config.ts，并拆分到 config 目录当中，将 head、nav 等部分分开配置。
  6. 指定 vitepress 的 srcDir 为 /src 目录，避免了文件的散乱放置。
  7. 调整了 page 分页的逻辑，将其产物，即 page_1.md ... page_x.md 等，统一放到 page 目录下。
  8. 增加了主页，即 index.md，形式上更加完备。
  9. 调整了 斜体、加粗、代码块的渲染逻辑，看上去内容更加明显。
  10. 引入了微软 clarity 埋点工具，便于统计项目概况。
  11. 引入了图片的尺寸控制，在 img http://xxxxx 的语法当中，添加 s 或 xs/m/l/xl 等待，即可控制图片的大小。

我的个人博客基于此进行了部署，请您看一下最终的效果：https://blog.albert.cool/ 此次 PR 修改的内容很多，如果您对此存在疑问，可以邮件联系我 @.*** 很希望您能够同意我的 pr

You can view, comment on, or merge this pull request online at:

https://github.com/airene/vitepress-blog-pure/pull/19 Commit Summary

File Changes

(46 files https://github.com/airene/vitepress-blog-pure/pull/19/files)

Patch Links:

— Reply to this email directly, view it on GitHub https://github.com/airene/vitepress-blog-pure/pull/19, or unsubscribe https://github.com/notifications/unsubscribe-auth/ABCJJDHY7NJK4DGAJZMM62DYYVFKJAVCNFSM6AAAAABE2AEORGVHI2DSMVQWIX3LMV43ASLTON2WKOZSGE4TANJTG4ZTMMY . You are receiving this because you are subscribed to this thread.Message ID: @.***>

airene commented 6 months ago

可能有点问题，比如page_{index}传上来了， 是不是有图片没用到， about页面是你的信息 还一个比较重要的点是 有点不理解page和timeline为什么要合起来，和archives 应该是blog系统的标准叫法，为啥叫timeline啊， 有一些文件格式化有问题， 另外就是从抽象来说，nav head分离更好， 但是从只是用这个theme的人来说，可能是在一个文件返回体验更好一点，“要改的文件”比较少？ 以上都是我个人观点哈，希望不要介意。 😊

Albert26193 commented 6 months ago

可能有点问题，比如page_{index}传上来了， 是不是有图片没用到， about页面是你的信息 还一个比较重要的点是 有点不理解page和timeline为什么要合起来，和archives 应该是blog系统的标准叫法，为啥叫timeline啊， 有一些文件格式化有问题， 另外就是从抽象来说，nav head分离更好， 但是从只是用这个theme的人来说，可能是在一个文件返回体验更好一点，“要改的文件”比较少？ 以上都是我个人观点哈，希望不要介意。 😊

答复：

  1. page_{index} 确实不应该上传上来，后续调整的版本当中，应该在 gitignore 当中进行过滤。
  2. 首页的图片确实是设置成 hidden 了，这是为了满足首页式样的需求，后续可以去掉。
  3. about 页面的设计我是这么考虑的，可以分类别展示一系列的 icon，然后供下游的使用者自行注释选择，后续的版本中，我会添加相关文字说明。
  4. page 和 timeline 合并起来是因为这是对于博客内容的两种呈现方式。当然，timeline 的名称确实是有点不合适，改为 archives 更加合理。
  5. 文件的格式化有问题，我想，应该是代码的缩进风格有问题吧，我习惯 2 空格缩进，您可能习惯 4 空格缩进，为了项目的统一，后续在代码 lint 上进行设置。
  6. config 分离问题：我还是认为分离设置更加合理一些，因为如果后续还有更多需要添加的配置，那么单一文件还是过于臃肿了。此外，用户需要修改的文件其实并不多，可以在将来的文档当中显式说明要改那些。

感谢您的 review，大约在本周五之前，我会按照上面的想法，再提出一次 PR，希望能把这个项目做得更完善一些~ 😄️

airene commented 6 months ago

好滴，感谢贡献，哈哈，我也是开源新手，本来这个是自己用的，可能带有很浓的个人风格，比如很“素”，比如颜色只用default theme里的色值。 unocss好用不？ 我咋对tailwind,unocss这种不感冒呢， 快可能是快，但是让"pt1" ，在有ide自动完成的情况下真还不如写padding-top,多了一个心智学习，😊

Albert26193 commented 6 months ago

你好，我在本周五重新整理了代码，基本按照我们约定的逻辑进行。

1. 修改总结

  1. page问题：/src/pages/page_{index}.md 文件已经全部去除了，并且，在 .gitignore 中进行了过滤。
  2. 图片问题：去掉了不必要的图片，首页式样和之前保持不变。
  3. about页面：添加了更多的 icon 供使用者选取，他们可以注释掉不想展示的内容。在将来的文档当中，可以另加说明。
  4. archives名称修改：已经修改了 archives 的名称，但是页面的整合逻辑没有改变，因为添加了 index.md 作为首页了，所以我认为，archives 和 pages 分别是对 blog 内容的不同呈现，因此统一放置到 blog 路径下了。
  5. 代码风格问题：已经按照原有仓库的代码风格进行了 lint，包括缩进宽度等，保持了风格上的一致。
  6. config分离：依然保持了 config 分离，我觉得拆分成多个文件反而更加直观，因为用户实际需要修改的还是只有一两个文件。我们只需在文档中说清楚用户需要修改什么即可。

2. bug 修复

3. 关于 unocss 等原子化 css 的讨论

airene commented 6 months ago

赞，晚点看一下， 合进来哈

Albert26193 commented 6 months ago

您好，请问还有什么问题吗？如果有相关疑问，我可以和您沟通，以求进一步的解决~

airene commented 6 months ago

最近比较忙，明天看一下，然后合进去哈 🤝

Albert26193 commented 6 months ago

好的，感谢您，当前的升级属于一次 break change，对于用户而言，使用方式上面会有一些变化(比如指定文档目录为 /src/posts 等等），文档也是需要更新的，我会尽力和您一起维护文档。🤝

Airene Fang @.***> 于2024年4月1日周一 19:23写道：

最近比较忙，明天看一下，然后合进去哈 🤝

— Reply to this email directly, view it on GitHub https://github.com/airene/vitepress-blog-pure/pull/19#issuecomment-2029610662, or unsubscribe https://github.com/notifications/unsubscribe-auth/ANPTVKNOTIEVRXXEC4A4FRTY3E7TNAVCNFSM6AAAAABE2AEORGVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDAMRZGYYTANRWGI . You are receiving this because you authored the thread.Message ID: @.***>

airene commented 6 months ago

合进来了，伴随1.0正式版，可能这个项目也会有一个比较大的重构