贡献指南

为 Meteor 指南贡献的提示。

请提交指南的澄清和改进!如果只是一个小小的修正,请直接打开一个 PR。如果问题比较重大,请先提交一个 Issue 进行讨论。

使用变更日志

如果您添加了重要的新内容,请花点时间在您的 PR 中包含对变更日志的更新。

写作提示

需要注意的事项

始终在标题上使用特定的 ID,以便我们以后可以更改它们

// bad
## Using schemas with collections

// good
<h2 id="schemas-with-collections">Using schemas with collections</h2>

标题和头部

文章标题为标题大小写,标题为句子大小写

每个标题后始终留空一行

否则,下一段将无法正确解析。

// bad
<h2 id="schemas-with-collections">Using schemas with collections</h2>
This is some text

// good
<h2 id="schemas-with-collections">Using schemas with collections</h2>

This is some text

转义内联代码片段中的 Handlebars 语法

注意:您不需要转义围栏/多行代码片段中的内容,只需要转义内联代码片段中的内容。

// will break
Render multiple items in your template with `{{#each}}`

// good
Render multiple items in your template with `{% raw %}{{#each}}{% endraw %}`

在本地运行静态网站生成器

该站点使用 hexo(一个静态网站生成器)构建。要在本地运行它,请执行以下步骤

git submodule update --init --recursive
cd site
npm install
npm start
在 GitHub 上编辑
// 搜索框