Stellaris Mod Document 群星 Mod 制作文档

本仓库部署于 pdxdoc-next @ netlify。

贡献指南

本仓库使用 pnpm 作为统一包管理工具。

文档部分

主文档内容位于 ./src/content/docs/guides 目录下。

如果你想要添加新的页面，在创建并编写完成后，修改侧边栏定义（位于 src/sidebar/guides.ts 中）并将你的文档置于合适的分类下。

注意

在修改侧边栏后，需要重启整个应用程序，因为这一配置直接被 astro.config.mjs 引用而无法热重载。

代码块

本仓库提供了内置的 Paradox 脚本语言语法高亮，使用 pdx，pdx-lang 或 pdx_lang 即可。

本仓库使用 Prism 的 diff 高亮插件，使用 diff-<language code> 即可使用带有 diff 功能的代码高亮。

如果想要增加新的语言支持，请在 public/scripts 目录下添加名为 prism-<lang>.js 的代码（例如 prism-rust.js），务必以最新的 ES6 规范写作。

完成代码高亮配置后，使用 swc 和 uglify-js 进行代码压缩：

swc prism-<lang>.js -o prism-<lang>.min.js
uglifyjs --no-module --webkit prism-<lang>.min.js -o prism-<lang>.min.js -m

仓库根目录下有一个 NuShell 脚本文件 uglify.nu，可以使用该文件快速更新所有代码高亮：

source ./uglify.nu
uglify all ./public/scripts -d

压缩后，将压缩后的文件加入到 astro.config.mjs 中：

{
    tag: "script",
    attrs: {
        src: "/scripts/prism-<your language>.min.js",
    },
},

注意

提交到仓库中时请保留压缩前和压缩后的文件以便生成文档。

博客

博客内容位于 ./src/content/docs/blog 目录下。

关于博客可选内容的更多信息，参考 Github: starlight-blog by HiDeoo。

如果你想要发表博客，请将你的个人标识添加到 author.ts 中。你的个人头像应该放在 ./public/authors 文件夹下。

其他注意事项

1. 在修改侧边栏 sidebar.json 或作者组 author.ts 后，需要重启整个应用程序，因为这些配置直接被 astro.config.mjs 引用而无法热重载。
2. 文章的图片应该放置于 .assets 结尾的子域中，例如：
   文章 src/content/docs/blog/practical_editor.mdx 的图片应放置在 src/content/docs/blog/practical_editor.assets/ 文件夹下。
3. 文章应配备合适的摘要，文件名不使用中文或中文拼音。

Emoji

当前，Starlight/Astro 并不支持 :emoji_code: 形式调用 emoji，需要复制原文。

以下是常见 emoji 列表：Github Gist: Emoji List。

构建命令

所有命令应该在终端中在项目根目录下运行：

命令	行为
pnpm install	下载依赖
pnpm run dev	在 localhost:4321 处启动开发服务器
pnpm run build	将站点构建于 ./dist/ 目录下
pnpm run preview	在部署前本地预览站点
pnpm run astro ...	运行 Astro 命令行程序，例如 astro add、astro check
pnpm run astro -- --help	获取 Astro 命令行程序的帮助

致谢

本站点基于 Astro 构建，UI 配置基于 Starlight。