贡献指南

2026-01-01

2026-01-01

ZigCC

Table of Contents

Zig 中文社区是一个开放的组织，我们致力于推广 Zig 在中文群体中的使用，有多种方式可以参与进来：

  1. 供稿，分享自己使用 Zig 的心得，方式见下文
  2. 改进 zigcc 组织下的开源项目，这是 open issues

供稿方式

  1. Fork 仓库 https://github.com/zigcc/zigcc.github.io
  2. 在 content/post 内添加自己的文章（smd 格式），文件命名为： ${YYYY}-${MM}-${DD}-${SLUG}.smd
  3. 文件开始需要包含一些描述信息，例如：
---
.title = "文章标题",
.date = @date("2025-06-05T16:00:00+0800"),
.author = "Your Name",
.layout = "post.shtml",
.draft = false,
.custom = {
  .math = true, // 引入 Katex 数学公式支持
  .mermaid = true, // 引入 mermaid 图表渲染支持
  .ai_generated = true, // 标注文章使用了 AI 辅助创作
},
---

图片

如果需要插入图片，请将图片放在 assets/images 目录下，然后在文章中通过下面方式引用，例如：

[Demo]($image.siteAsset('images/demo.webp'))

图片格式优先选择 webp，其次是 svg。这样可以在保证图片质量的同时，减小图片体积，提高网站加载速度。可以使用下面的在线工具将图片转换为 webp 格式：

Mermaid

如果需要插入 mermaid 流程图，首先需要在 frontmatter 进行如下配置：

---
.custom = {
  .mermaid = true,
},
---

之后通过下面流程图时用 html 方式，具体可参考这里：

AI 辅助创作说明

如果文章内容使用了 AI（如 ChatGPT、Claude、Copilot 等）辅助生成，请在 frontmatter 中添加 ai_generated = true：

.custom = {
  .ai_generated = true,
},

设置后，文章开头会自动显示提示：“本文部分内容由 AI 辅助生成，已经作者审阅校对，仅供参考。”

注意事项：

  • AI 生成的内容可能存在错误或不准确之处，请在发布前仔细审阅校对
  • 鼓励在文章中说明 AI 的具体使用方式（如”使用 AI 辅助润色”、“使用 AI 生成初稿后人工校对”等）

本地预览

  1. 安装 zine，推荐使用我们维护的 Fork 版本，该版本支持自动目录生成等增强功能。
  2. 执行 zine 命令，它会自动编译并启动本地服务器，默认地址是 http://localhost:1990。

文章发布平台

加入我们

欢迎加入我们的社区，一起学习和交流 Zig 语言！你可以通过以下方式参与：

  • 访问我们的 论坛 参与讨论

  • 加入我们的 微信群、Telegram 群、Discord 群 与其他成员交流

  • 关注我们的微信公众号获取最新资讯

  • 改进 ZigCC GitHub 组织下的开源项目，帮助更多人了解 Zig

  • 参加我们的线上线下活动，结识更多 Zig 爱好者

无论你是 Zig 的新手还是资深开发者，我们都欢迎你的加入！让我们一起推动 Zig 语言在中文社区的发展，共同创造更多精彩的项目和资源！

网站更新日志

  • 2025-06-30: 切换到 zine
  • 2024-08-18: 切换主题 docsy
  • 2024-07-14: 启用 Zig 社区微信 2 群
  • 2024-03-29: 使用自定义域名 ziglang.cc
  • 2022-12-10: 切换主题 cupper-hugo –> hugo-xmin
  • 2022-07-20: 首次上线