Contribution Guide [contribution]
Contribution Guide [contribution]
Community-Blog 基于 Kodama 框架编写,同时支持 markdown 与 typst 编写,并且有类 forest 结构。 关于该框架的具体使用方法可以参见原框架的文档,但在 Community-Blog 中,我们认为大部分情况下您只需要拥有基本的 markdown 编写知识和排版经验即可。 我们的 Github 存储库在 https://github.com/moonbit-community/community-blog,您可以前往这里对 Blog 进行贡献。 您可以这样实现 Community-Blog 的本地部署与实时预览: 1. Basic [contribution/basic]
cargo install --git https://github.com/kokic/kodama.git
git clone git@github.com:moonbit-community/community-blog.git
cd community-blog
git submodule update --init --recursive
npm i
npm run dev
下面是关于贡献的排版要求和每个部分的贡献指南:
下面是一些关于排版的简单要求,适用于 Community-Blog 中的全部文章: 正确使用 markdown 或者 typst 格式。 中文要用全角标点,末尾需要用句号,单词/公式和全角标点之间无空格。 中文内容与西文内容(包括单词与公式)之间需要有空格以保证美观。 代码内容(尤其是 MoonBit 代码)请确保格式化良好。 另外,对于发出的 PR,我们希望 PR 标题可以符合 约定式提交 的要求,并且可以标注贡献的部分,比如: 2. Requirements [contribution/requirement]
feat: add a new community information for weekly
fix: fix typo for knowledge base
refactor: refactor the doc structure
周报暂定每两周更新一次,由当期负责人撰写和编辑。 未正式发布的周报的任何内容都不可信,Community-Blog 不对此负责。 未正式发布的周报的标题有(未正式发布)的标签。 社区成员可以对未正式发布的周报 PR, 添加条目与修改当前的条目均可。 当期负责人每天会按时 Code Review. 3. Weekly [contribution/weekly]
贡献标准待定。 4. Knowledge Base [contribution/knowledge]