mirror of
https://github.com/Anduin2017/HowToCook.git
synced 2025-12-17 10:44:23 +08:00
Real markdown lint.
This commit is contained in:
4
.github/workflows/ci.yml
vendored
4
.github/workflows/ci.yml
vendored
@@ -14,4 +14,6 @@ jobs:
|
|||||||
- name: Install packages
|
- name: Install packages
|
||||||
run: sudo gem install mdl
|
run: sudo gem install mdl
|
||||||
- name: Lint markdown files
|
- name: Lint markdown files
|
||||||
run: mdl *.md -r ~MD009,~MD029,~MD036,~MD024
|
run: mdl . -r ~MD036,~MD024
|
||||||
|
# Suppress 036 Emphasis used instead of a header
|
||||||
|
# Suppress 024 Multiple headers with the same content
|
||||||
|
|||||||
@@ -10,17 +10,17 @@
|
|||||||
|
|
||||||
## 内容规范
|
## 内容规范
|
||||||
|
|
||||||
**菜谱提交者无需阅读此内容规范。以下内容已经以简明易懂的方式包含在示例模板中。项目的维护者会在你的PR中提出建议, 并协助修改。**
|
菜谱提交者**无需**阅读此内容规范。以下内容已经以简明易懂的方式包含在示例模板中。项目的维护者会在你的PR中提出建议, 并协助修改。
|
||||||
|
|
||||||
本项目的 Motivation 要求菜谱满足以下规范,不符合规范的菜谱将不会被合并到代码库中。项目的维护者维护此文档, 作为正式的标准与共识。
|
本项目的 Motivation 要求菜谱满足以下规范,不符合规范的菜谱将不会被合并到代码库中。项目的维护者维护此文档, 作为正式的标准与共识。
|
||||||
|
|
||||||
1. 每一道菜谱至少应包含`原材料与工具`, `计算`, `操作`三部分内容。
|
- 每一道菜谱至少应包含`原材料与工具`, `计算`, `操作`三部分内容。
|
||||||
|
|
||||||
`原材料与工具`应列出本菜品需要的除`假想已准备好的物品`外的所有原材料与厨具。
|
`原材料与工具`应列出本菜品需要的除`假想已准备好的物品`外的所有原材料与厨具。
|
||||||
`计算`应定量列出本菜品所需的原材料的量。(无论与人数是否相关)
|
`计算`应定量列出本菜品所需的原材料的量。(无论与人数是否相关)
|
||||||
`操作`应说明菜品的制作步骤。
|
`操作`应说明菜品的制作步骤。
|
||||||
|
|
||||||
2. 菜品的制作步骤应当明确(无歧义,non-ambiguous),并尽可能准确(accurate)。有歧义(ambiguous)的描述是不可接受的,而不准确(inaccurate)或不精确(imprecise)的描述是可以接受的。
|
- 菜品的制作步骤应当明确(无歧义,non-ambiguous),并尽可能准确(accurate)。有歧义(ambiguous)的描述是不可接受的,而不准确(inaccurate)或不精确(imprecise)的描述是可以接受的。
|
||||||
|
|
||||||
> 不准确的菜谱会导致菜品口味有少许偏差,不明确的菜谱会导致做菜人的心态有明显不安。
|
> 不准确的菜谱会导致菜品口味有少许偏差,不明确的菜谱会导致做菜人的心态有明显不安。
|
||||||
|
|
||||||
@@ -69,9 +69,9 @@
|
|||||||
变软 变硬
|
变软 变硬
|
||||||
```
|
```
|
||||||
|
|
||||||
3. 菜品的`制作步骤`应当完整(complete)。这意味着, 在执行完所有操作步骤后, 菜品已经被完成。
|
- 菜品的`制作步骤`应当完整(complete)。这意味着, 在执行完所有操作步骤后, 菜品已经被完成。
|
||||||
|
|
||||||
4. 菜品的`原材料与工具`应当完整(complete)。这意味着, 在执行操作步骤时, 没有用到`原材料与工具`中未提到的物品。
|
- 菜品的`原材料与工具`应当完整(complete)。这意味着, 在执行操作步骤时, 没有用到`原材料与工具`中未提到的物品。
|
||||||
|
|
||||||
## 审核员须知
|
## 审核员须知
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user