From 3c7d02cac36ac333f3655044b01a6829cdb51e89 Mon Sep 17 00:00:00 2001 From: HPCesia Date: Tue, 1 Apr 2025 19:30:41 +0800 Subject: [PATCH] docs: update README --- README-zh_CN.md | 9 ++++----- README.md | 7 +++---- 2 files changed, 7 insertions(+), 9 deletions(-) diff --git a/README-zh_CN.md b/README-zh_CN.md index 74478bb..4ae496a 100644 --- a/README-zh_CN.md +++ b/README-zh_CN.md @@ -16,11 +16,10 @@ Astral Halo 是一个基于 [Astro](https://astro.build) 开发的静态博客 - [x] 响应式的文章目录显示 - [x] 文章双向引用 - [x] 评论(支持 [Twikoo](https://twikoo.js.org/)、[Giscus](https://giscus.app/zh-CN/) 和 [Waline](https://waline.js.org/)) +- [x] 各种各样可在文章中使用的组件 - [ ] 流畅的动画和页面过渡 - [ ] 实用 JS 脚本工具 -- [ ] 各种各样可在文章中使用的组件 -- [ ] 音乐播放胶囊 -- [ ] Typst 格式文章支持(实验性) +- [ ] PWA 支持 ## 使用方法 @@ -60,7 +59,7 @@ comment: true # 是否启用评论,需要在 `config.ts` 中启用并配置评 | `pnpm build` | 构建静态站点到 `./dist/` 目录 | | `pnpm preview` | 本地预览构建的静态站点 | | `pnpm new [draft\|post] [title]` | 创建新文章 | -| `pnpm pub [title]` | 发布草稿 | +| `pnpm pub` | 发布草稿 | | `pnpm lint` | 检查代码 | | `pnpm format` | 格式化代码 | | `pnpm astro ...` | 运行 Astro CLI | @@ -69,4 +68,4 @@ comment: true # 是否启用评论,需要在 `config.ts` 中启用并配置评 - 项目受 [Fuwari](https://github.com/saicaca/fuwari) 启发,参考了其中的部分代码和设计元素。 - 项目受 [Pure](https://github.com/cworld1/astro-theme-pure) 启发,参考了其中的部分代码和设计元素。 -- 项目受 [Solitude](https://github.com/everfu/hexo-theme-solitude) 启发,参考了其中的部分设计元素。 \ No newline at end of file +- 项目受 [Solitude](https://github.com/everfu/hexo-theme-solitude) 启发,参考了其中的部分设计元素。 diff --git a/README.md b/README.md index e6b790c..894f1eb 100644 --- a/README.md +++ b/README.md @@ -16,11 +16,10 @@ Astral Halo is a static blog template developed with [Astro](https://astro.build - [x] Responsive article table of contents - [x] Bidirectional references in articles - [x] Comments system (supports [Twikoo](https://twikoo.js.org/en/), [Giscus](https://giscus.app/) and [Waline](https://waline.js.org/en/)) +- [x] Various components that can be used in articles - [ ] Smooth animations and page transitions - [ ] Useful JS script tools -- [ ] Various components that can be used in articles -- [ ] Music player capsule -- [ ] Typst format article support (experimental) +- [ ] PWA supports ## Getting Started @@ -60,7 +59,7 @@ All commands need to be run from the project root directory: | `pnpm build` | Build static site to `./dist/` | | `pnpm preview` | Preview built site locally | | `pnpm new [draft\|post] [title]` | Create new article | -| `pnpm pub [title]` | Publish draft | +| `pnpm pub` | Publish draft | | `pnpm lint` | Check code | | `pnpm format` | Format code | | `pnpm astro ...` | Run Astro CLI |