Community-Blog 基于 Kodama 框架编写， 同时支持 markdown 与 typst 语言，并且有类 forest 结构。 关于该框架的具体使用方法可以参见原框架的教程， 在 Community-Blog 中，我们认为大部分情况下您只需要拥有基本的 markdown 编写知识和排版经验即可。 若有复杂的图表制作需求，优先推荐使用 Typst 进行绘制。 向 Community-Blog 贡献的方式非常简单， 只需直接在我们的 Github 仓库发起 Pull Request 即可，写作规范将在后文中介绍。

若是文件粒度的微小更改，可以在 Github 直接编辑文件。 如果涉及多文件等复杂情况，您可能需要在本地部署工具进行预览。 下面是将 Community-Blog 克隆到本地的命令 (我们这里使用了一些 git 子模块，比通常的 git clone 多一个步骤)：

git clone git@github.com:moonbit-community/community-blog.git
cd community-blog
git submodule update --init --recursive

确保你安装了 Rust 和 Node.js 环境，在项目根目录下运行如下指令安装 Kodama 与 Node.js 依赖：

cargo install --git https://github.com/kokic/kodama.git
npm i

实时预览只需运行 npm run dev ，在浏览器访问 localhost:5173 即可。

在提交之前我们推荐您运行 typos、zhlint 和 autocorrect --fix 命令来检查和修复拼写错误。 其安装可以参考下面的链接：

• zhlint
• how to install typos
• how to install autocorrect

下面是一些关于排版的简单要求，适用于 Community-Blog 中的全部文章：

• 正确使用 markdown 或者 typst 格式。
• 中文要用全角标点，末尾需要用句号，单词/公式和全角标点之间无空格。
• 中文内容与西文内容（包括单词与公式）之间需要有空格以保证美观。
• 代码内容（尤其是 MoonBit 代码）请确保格式化良好。
• 不使用 markdown / typst 自带的标题来分级，文章分节应当划分到不同的文件，并使用 kodama 的嵌入功能包含到主文件中。
• 嵌入文件均采用绝对路径，以 trees 文件夹为根目录。例如本文件的路径是 /contribution/requirement.md。
• kodama 内部的引用统一使用绝对路径，用 VsCode 打开 community-blog/trees 目录，可以使用跳转和补全功能。

另外，对于发出的 PR，我们希望 PR 标题可以符合 约定式提交 的要求，并且可以标注贡献的部分，比如：

feat: add a new community information for weekly
fix: fix typo for knowledge base
refactor: refactor the doc structure

社区成员可以自由贡献一些博客文章，可以是 MoonBit 的教学、杂谈、开发日记等等。 直接发起 PR 在 trees/blog 文件夹中添加文章即可，因为文章分节会需要包含多个文件， 建议写作者单独开一个文件夹来存放文章，并用一个主文件来包含其他的文件。 文章的头部需要包含一些元信息：

• author：作者的名字
• date：文章的日期，格式为 YYYY-MM-DD
• title：文章的标题
• taxon：文章的分类，通常都是 Blog

举个例子：

---
author: CAIMEOX
date: 2025-04-01
title: MoonBit 开发日记
taxon: Blog
---

周报暂定每两周更新一次，由当期负责人撰写和编辑。

• 未正式发布的周报的任何内容都不可信，Community-Blog 不对此负责。
• 未正式发布的周报的标题有（未正式发布）的标签。

社区成员可以对未正式发布的周报 PR，添加条目与修改当前的条目均可。 当期负责人每天会按时 Code Review。