将文档构建工具迁移至 Starlight

[neveler]

将文档构建工具迁移至 Starlight

本 PR 计划将构建工具从 Jekyll 迁移到 starlight 。目前总体上完成迁移，但仍有一些细节需要修改。

starlight 支持多语言、支持构建时生成 webp 图片，因此也可同时解决 #189 #318 。

clone 本仓库并切换到该分支后需要先使用 npm install 安装依赖。之后你可以使用 npm run dev 运行开发服务器，使用 npm run format 格式化代码，使用 npm run build 构建产物。

变动

• 支持搜索
• 支持多语言：目前支持简体中文、繁体中文与英文。
• 移除设置页：目前可供设置的条目太少，因此未添加设置页。
  • 不再支持切换主题
• 移除集合列表页：新文档通过侧边栏实现了集合列表的功能，故不再提供。
• 合并文章元数据作者到贡献者：现在不再区分用户是否为文章的创建者。
• 更新日志主版本号作为章节标题：由于客户端依赖该页面的 html 结构解析并渲染更新日志，因此新的更新日志页由 /changelog/xxx 迁移到 /changelogs/xxx 旧地址仍提供旧的 html 结构供客户端解析日志，网页访客访问旧地址会被重定向到新地址。
• 部分页面使用新的地址，并为旧地址添加重定向
  https://github.com/neveler/HMCL-docs/blob/cfc0f91ab9d0237424861affe5fd3fdc011e3337/astro.config.ts#L19-L32
• 使用组件替换部分文档元素
  • 使用文件树替换部分页面的代码块和图片
    https://starlight.astro.build/zh-cn/components/file-tree/
  • 使用步骤组件替换部分页面的步骤标题
    https://starlight.astro.build/zh-cn/components/steps/
  • https://starlight.astro.build/zh-cn/components/tabs/
  • https://starlight.astro.build/zh-cn/components/link-cards/
• PR 预览工作流：测试预览构建 hmcl-docs/test#1 https://hmcl-docs.github.io/test/PR1/
• QQ 群二维码由固定文件改为通过链接生成

参考

• https://docs.astro.build/zh-cn/getting-started/
• https://starlight.astro.build/zh-cn/getting-started/

预览

https://fork-starlight-docs.hmcl.workers.dev/

---

resolve #397

[neveler]

Request review @Glavo @burningtnt @zkitefly

[zkitefly]

再加个 qq 群的跳转按钮吧

[zkitefly]

还考虑添加 hits 标签吗

[neveler]

再加个 qq 群的跳转按钮吧

1. 框架默认不提供 QQ 的图标，因此可能需要引入额外的资源 https://starlight.astro.build/zh-cn/reference/icons/
2. QQ 群有多个，跳转到哪一个合适呢

---

还考虑添加 hits 标签吗

如果有必要的话可以加，但相比于返回一个图片我更希望可以额外提供一个 api 接口返回 json 这样前端可以更灵活的渲染该组件。

例如 https://hits.zkitefly.eu.org/json?tag=https%3A%2F%2Fdocs.hmcl.net%2F

{
  "today-hits": 114,
  "total-hits": 1144
}