From 123d10b1671edc2e296ea7a25fc937da271ed1e0 Mon Sep 17 00:00:00 2001 From: Anduin Xue Date: Fri, 4 Mar 2022 00:36:07 +0800 Subject: [PATCH] Real markdown lint. --- .github/workflows/ci.yml | 4 +++- CONTRIBUTING.md | 12 ++++++------ 2 files changed, 9 insertions(+), 7 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 87a29f5..8b879b6 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -14,4 +14,6 @@ jobs: - name: Install packages run: sudo gem install mdl - 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 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 676604f..67a0197 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -10,17 +10,17 @@ ## 内容规范 -**菜谱提交者无需阅读此内容规范。以下内容已经以简明易懂的方式包含在示例模板中。项目的维护者会在你的PR中提出建议, 并协助修改。** +菜谱提交者**无需**阅读此内容规范。以下内容已经以简明易懂的方式包含在示例模板中。项目的维护者会在你的PR中提出建议, 并协助修改。 本项目的 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)。这意味着, 在执行操作步骤时, 没有用到`原材料与工具`中未提到的物品。 ## 审核员须知 @@ -119,7 +119,7 @@ mkdocs build 生成静态 HTML 网页, 存在于在`site/`文件夹下。Hosting 的时候指向到`site/index.html`即可。 -> **_Note:_** +> **_Note:_** > 由于`mkdocs`不原生支持`*.md`存在于根目录下，只能添加了`mkdocs-same-dir`这个插件来做workaround。 > 通常来说mkdoc会自动检查文件夹里的各种文件 (eg *.jpg)然后生成相对应的链接。由于这个 > workaround，根目录下现在只能检测到`.md`文件。这个限制并不影响剩下的文件夹（比方说`tips`和`dishes`)。