写在前面
这个教程可能是群星中文社区中最完善的教程了,虽然有些许过时,但依然有很多内容值得参考,如果这个教程对打算制作 mod 的你有帮助,还望能够前往 源仓库 点个 star~。
欢迎各位模组制作者按下面的方式为教程贡献内容,使其更加完善。
贡献指南
文档部分
文档内容位于 ./src/content/docs/guides
目录下。
添加新页面后,修改 sidebar.json
并将文档置于合适的分类下。
注意: 修改侧边栏后需要重启应用程序,因为该配置直接被 astro.config.mjs
引用。
博客
博客内容位于 ./src/content/docs/blog
目录下。更多信息参见 starlight-blog by HiDeoo。
发表博客时,需将个人标识添加到 author.ts
中,头像放置于 ./public/authors
文件夹。
其他注意事项
- 修改
sidebar.json
或author.ts
后需要重启应用程序。 - 图片应放置于
.assets
子目录中,例如src/content/docs/blog/practical_editor.assets/
。 - 文章需配备摘要,文件名不使用中文或拼音。
构建命令
在项目根目录下运行以下命令:
命令 | 行为 |
---|---|
pnpm install |
下载依赖 |
pnpm run dev |
启动开发服务器 |
pnpm run build |
构建站点到 ./dist |
pnpm run preview |
本地预览站点 |
致谢
本站点基于 Astro 构建,UI 配置基于 Starlight。