docs: update README

This commit is contained in:
HPCesia 2025-04-05 18:17:43 +08:00
parent 27a83826f5
commit e53aef90b9
Signed by: HPCesia
GPG Key ID: 2C107E1FD23C98DF
2 changed files with 12 additions and 4 deletions

View File

@ -15,7 +15,11 @@ Astral Halo is a static blog template developed with [Astro](https://astro.build
- [x] Search functionality (currently only supports [Pagefind](https://pagefind.app/))
- [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] Comments system, supports:
- [Twikoo](https://twikoo.js.org/en/)
- [Giscus](https://giscus.app/en/)
- [Waline](https://waline.js.org/en/)
- [Artalk](https://artalk.js.org/?lng=en)
- [x] Various components that can be used in articles
- [ ] Smooth animations and page transitions
- [ ] Useful JS script tools
@ -29,7 +33,7 @@ Astral Halo is a static blog template developed with [Astro](https://astro.build
- If [pnpm](https://pnpm.io/) is not installed, first run `npm install -g pnpm` to install it.
3. Customize your blog through the configuration file `src/config.ts`. Configuration documentation can be found in the comments of `src/types/config.ts`.
4. Run `pnpm new [draft|post] [title]` to create a new article. If creating a draft, run `pnpm pub [title]` to publish it to the `src/content/posts` directory when finished.
4. Run `pnpm new [draft|post] [title]` to create a new article. If creating a draft, run `pnpm pub` to publish it to the `src/content/posts` directory when finished.
5. Refer to the [official guide](https://docs.astro.build/en/guides/deploy/) to deploy your blog to Vercel, Netlify, GitHub Pages, etc. Before deployment, edit the site settings in astro.config.mjs.
## Article Front Matter

View File

@ -15,7 +15,11 @@ Astral Halo 是一个基于 [Astro](https://astro.build) 开发的静态博客
- [x] 搜索(目前仅支持 [Pagefind](https://pagefind.app/)
- [x] 响应式的文章目录显示
- [x] 文章双向引用
- [x] 评论(支持 [Twikoo](https://twikoo.js.org/)、[Giscus](https://giscus.app/zh-CN/) 和 [Waline](https://waline.js.org/)
- [x] 评论系统,支持:
- [Twikoo](https://twikoo.js.org/)
- [Giscus](https://giscus.app/zh-CN/)
- [Waline](https://waline.js.org/)
- [Artalk](https://artalk.js.org/)
- [x] 各种各样可在文章中使用的组件
- [ ] 流畅的动画和页面过渡
- [ ] 实用 JS 脚本工具
@ -29,7 +33,7 @@ Astral Halo 是一个基于 [Astro](https://astro.build) 开发的静态博客
- 若未安装 [pnpm](https://pnpm.io/),请先执行 `npm install -g pnpm` 安装 pnpm。
3. 通过配置文件 `src/config.ts` 自定义博客,配置说明位于 `src/types/config.ts` 的文档注释中。
4. 执行 `pnpm new [draft|post] [title]` 创建新文章。若创建的是草稿,编写完成后执行 `pnpm pub [title]` 发布文章到 `src/content/posts` 目录。
4. 执行 `pnpm new [draft|post] [title]` 创建新文章。若创建的是草稿,编写完成后执行 `pnpm pub` 发布文章到 `src/content/posts` 目录。
5. 参考[官方指南](https://docs.astro.build/zh-cn/guides/deploy/)将博客部署至 Vercel, Netlify, GitHub Pages 等;部署前需编辑 astro.config.mjs 中的站点设置。
## 文章 Front Matter