diff --git a/docs/blog/index.md b/docs/blog/index.md index 4b1e403..4c3c12c 100644 --- a/docs/blog/index.md +++ b/docs/blog/index.md @@ -13,7 +13,7 @@ editor: bingling-sama ## 关于文章 -本博客文章均由 GlobeMC 团队及其成员撰写或约稿，所有内容由其实际具体撰写人负责，仅代表作者观点，如有谬误及不当处望海涵，可以在文章下评论区提出或发送电邮至编辑部部长邮箱。 +本博客文章均由 GlobeMC 团队及其成员撰写或约稿，所有内容由其实际具体撰写人负责，仅代表作者观点，如有谬误及不当处望海涵，可以在文章下评论区提出或发送电邮至编辑部部长邮箱 。 有意为 CrashMC Blog 供稿的话也可以电邮联系编辑部部长。 diff --git a/docs/contribute/contributing.md b/docs/contribute/contributing.md index d5b114b..1059d76 100644 --- a/docs/contribute/contributing.md +++ b/docs/contribute/contributing.md @@ -1,5 +1,5 @@ --- -contributors: [HRxiaohu, bingling-sama] +editor: bingling-sama --- # 贡献指南 @@ -13,7 +13,7 @@ contributors: [HRxiaohu, bingling-sama] ```bash # 推荐使用 SSH git clone git@github.com:{yourname}/crashmc.com.git -# 也可以使用 HTTPS （不推荐） +# 也可以使用 HTTPS git clone https://github.com/{yourname}/crashmc.com.git ``` @@ -29,7 +29,7 @@ git clone https://github.com/{yourname}/crashmc.com.git ### 文档内容 -本文档按 [W3C Requirement for Chinese Text Layout](https://www.w3.org/International/clreq/) 进行排版，在贡献内容时请注意排版格式。 +本文档按 [W3C Requirement for Chinese Text Layout][textlayoutdoc] 进行排版，在贡献内容时请注意排版格式。 在涉及任何站外链接时，请优先添加官方链接，尽量避免不必要的第三方链接。 @@ -53,9 +53,20 @@ git clone https://github.com/{yourname}/crashmc.com.git 文档会自动记录每个页面的 Git 提交历史记录以及为此文件做过贡献的人员，并将这些信息显示在页面上。 +如果您发起或主导了某篇文章的编写，可以在 frontmatter 中署名，文末将会显示您的 GitHub 头像和地址，便于读者提出意见与后期可能存在的文章修改及版权相关事宜。 + +``` +--- +editor: username +--- +``` + +如您不愿意署名，忽略此条提示即可，文末将署名为 CrashMC 编辑部部长 @bingling-sama + :::warning 警告 - 如果在多次提交时使用的名称不一致会导致贡献者记录中出现多个记录，建议统一自己提交时使用的名称。 +- 如果已经出现了重复的贡献者记录，可以联系 CrashMC 工作人员进行处理。 - 上述代码中所使用的均为**英文半角逗号**！ ::: @@ -64,9 +75,11 @@ git clone https://github.com/{yourname}/crashmc.com.git 如果您参与了代码内容的修改，~~相信您应该多少懂一些贡献流程，~~ 这里不再过多赘述贡献流程。 +要注意的是，在准备 commit 之前，请运行 `docs:check` 任务来检查并格式化代码。 + ## Step.3 提交更改 -在完成内容编写以后，请将您的所有更改 commit 到您的 fork 下，再向 [这里](https://github.com/GlobeMC/crashmc.com/tree/dev) 提交 PR。 +在完成内容编写以后，请将您的所有更改 commit 到您的 fork 下，再向 [这里][prbranch] 提交 PR。 :::warning 重要提醒 请务必将您的更改 PR 到 `dev` barnch，以便我们审查排版及合并冲突。 @@ -89,3 +102,6 @@ git clone https://github.com/{yourname}/crashmc.com.git ## 鸣谢 感谢所有为 CrashMC 贡献内容的玩家和开发者，你们的支持是对 CrashMC 最大的鼓励。 + +[textlayoutdoc]: https://www.w3.org/International/clreq/ +[prbranch]: https://github.com/GlobeMC/crashmc.com/tree/dev diff --git a/docs/index.md b/docs/index.md index 8c29a8f..e171bc5 100644 --- a/docs/index.md +++ b/docs/index.md @@ -14,11 +14,11 @@ hero: text: 崩溃分析工具 link: /analyzer - theme: alt - text: 客户端崩溃 - link: /client/ + text: 基础知识 + link: /basis - theme: alt - text: 服务器崩溃 - link: /server/ + text: 博客文章 + link: /blog/ features: - title: 方便 @@ -39,7 +39,7 @@ features: icon: 🔌 details: 得益于 PWA（渐进式网页应用）技术，即使没有网络也可以查阅 - title: 周到 - icon: 🫡 + icon: 🤗 details: 我们知道只有冗长的文档还不够，因此我们准备了一个分析工具给大家 link: /analyzer.html linkText: 开始使用 diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index ceebd0b..3b42705 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -117,9 +117,6 @@ importers: vite-plugin-pwa: specifier: ^0.20.1 version: 0.20.1(@vite-pwa/assets-generator@0.2.4)(vite@5.3.5(@types/node@20.14.12)(less@4.2.0)(sass@1.77.8)(terser@5.31.3))(workbox-build@7.1.1)(workbox-window@7.1.0) - vite-tsconfig-paths: - specifier: ^4.3.2 - version: 4.3.2(typescript@5.5.4)(vite@5.3.5(@types/node@20.14.12)(less@4.2.0)(sass@1.77.8)(terser@5.31.3)) vitepress: specifier: 1.3.1 version: 1.3.1(@algolia/client-search@4.24.0)(@types/node@20.14.12)(axios@1.7.2)(less@4.2.0)(nprogress@0.2.0)(postcss@8.4.40)(sass@1.77.8)(search-insights@2.15.0)(terser@5.31.3)(typescript@5.5.4) @@ -2220,9 +2217,6 @@ packages: resolution: {integrity: sha512-s3Fq41ZVh7vbbe2PN3nrW7yC7U7MFVc5c98/iTl9c2GawNMKx/J648KQRW6WKkuU8GIbbh2IXfIRQjOZnXcTnw==} engines: {node: '>=18'} - globrex@0.1.2: - resolution: {integrity: sha512-uHJgbwAMwNFf5mLst7IWLNg14x1CkeqglJb/K3doi4dw6q2IvAAmM/Y81kevy83wP+Sst+nutFTYOGg3d1lsxg==} - gopd@1.0.1: resolution: {integrity: sha512-d65bNlIadxvpb/A2abVdlqKqV563juRnZ1Wtk6s1sIR8uNsXR70xqIzVqxVf1eTqDunwT2MkczEeaezCKTZhwA==} @@ -3418,16 +3412,6 @@ packages: peerDependencies: typescript: '>=4.2.0' - tsconfck@3.1.1: - resolution: {integrity: sha512-00eoI6WY57SvZEVjm13stEVE90VkEdJAFGgpFLTsZbJyW/LwFQ7uQxJHWpZ2hzSWgCPKc9AnBnNP+0X7o3hAmQ==} - engines: {node: ^18 || >=20} - hasBin: true - peerDependencies: - typescript: ^5.0.0 - peerDependenciesMeta: - typescript: - optional: true - tslib@2.6.3: resolution: {integrity: sha512-xNvxJEOUiWPGhUuUdQgAJPKOOJfGnIyKySOc09XkKsgdUV/3E2zvwZYdejjmRgPCgcym1juLH3226yA7sEFJKQ==} @@ -3575,14 +3559,6 @@ packages: '@vite-pwa/assets-generator': optional: true - vite-tsconfig-paths@4.3.2: - resolution: {integrity: sha512-0Vd/a6po6Q+86rPlntHye7F31zA2URZMbH8M3saAZ/xR9QoGN/L21bxEGfXdWmFdNkqPpRdxFT7nmNe12e9/uA==} - peerDependencies: - vite: '*' - peerDependenciesMeta: - vite: - optional: true - vite@5.3.5: resolution: {integrity: sha512-MdjglKR6AQXQb9JGiS7Rc2wC6uMjcm7Go/NHNO63EwiJXfuk9PgqiP/n5IDJCziMkfw9n4Ubp7lttNwz+8ZVKA==} engines: {node: ^18.0.0 || >=20.0.0} @@ -6327,8 +6303,6 @@ snapshots: slash: 5.1.0 unicorn-magic: 0.1.0 - globrex@0.1.2: {} - gopd@1.0.1: dependencies: get-intrinsic: 1.2.4 @@ -7678,10 +7652,6 @@ snapshots: dependencies: typescript: 5.5.4 - tsconfck@3.1.1(typescript@5.5.4): - optionalDependencies: - typescript: 5.5.4 - tslib@2.6.3: {} tunnel-agent@0.6.0: @@ -7850,17 +7820,6 @@ snapshots: transitivePeerDependencies: - supports-color - vite-tsconfig-paths@4.3.2(typescript@5.5.4)(vite@5.3.5(@types/node@20.14.12)(less@4.2.0)(sass@1.77.8)(terser@5.31.3)): - dependencies: - debug: 4.3.5 - globrex: 0.1.2 - tsconfck: 3.1.1(typescript@5.5.4) - optionalDependencies: - vite: 5.3.5(@types/node@20.14.12)(less@4.2.0)(sass@1.77.8)(terser@5.31.3) - transitivePeerDependencies: - - supports-color - - typescript - vite@5.3.5(@types/node@20.14.12)(less@4.2.0)(sass@1.77.8)(terser@5.31.3): dependencies: esbuild: 0.21.5