Merge branch 'master' into master

Author: Anduin2017

.github/manual_lint.js

@@ -0,0 +1,73 @@
+const util = require("util");
+const glob = util.promisify(require('glob'));
+const fs = require("fs").promises;
+const path = require('path');
+
+
+async function main() {
+    var errors = [];
+    var directories = await glob(__dirname + '../../dishes/**/*.md');
+
+    for (var filePath of directories) {
+        var data = await fs.readFile(filePath, 'utf8');
+        var filename = path.parse(filePath).base.replace(".md","");
+
+        dataLines = data.split('\n').map(t => t.trim());
+        titles = dataLines.filter(t => t.startsWith('#'));
+        secondTitles = titles.filter(t => t.startsWith('## '));
+
+        if (dataLines.filter(line => line.includes('勺')).length > 
+            dataLines.filter(line => line.includes('勺子')).length +
+            dataLines.filter(line => line.includes('炒勺')).length +
+            dataLines.filter(line => line.includes('漏勺')).length +
+            dataLines.filter(line => line.includes('吧勺')).length) {
+            errors.push(`文件 ${filePath} 不符合仓库的规范！勺 不是一个精准的单位！`);
+        }
+        if (dataLines.filter(line => line.includes('适量')).length > 0) {
+            errors.push(`文件 ${filePath} 不符合仓库的规范！适量 不是一个精准的描述！请给出克 g 或毫升 ml。`);
+        }
+        if (dataLines.filter(line => line.includes('左右')).length > 0) {
+            errors.push(`文件 ${filePath} 不符合仓库的规范！左右 不是一个能够明确定量的标准! 如果是在描述一个模糊物体的特征，请使用 '大约'。例如：鸡（大约1kg）`);
+        }
+        if (dataLines.filter(line => line.includes('你')).length > 0) {
+            errors.push(`文件 ${filePath} 不符合仓库的规范！请不要出现人称代词。`);
+        }
+        if (titles[0].trim() != "# " + filename + "的做法") {
+            errors.push(`文件 ${filePath} 不符合仓库的规范！ 它的大标题应该是: ${"# " + filename + "的做法"}! 而它现在是 ${titles[0].trim()}!`);
+            continue;
+        }
+        if (secondTitles.length != 4) {
+            errors.push(`文件 ${filePath} 不符合仓库的规范！ 它并不是四个标题的格式。请参考示例菜模板！`);
+            continue;
+        }
+        if (secondTitles[0].trim() != "## 必备原料和工具") {
+            errors.push(`文件 ${filePath} 不符合仓库的规范！ 第一个标题不是 必备原料和工具!`);
+        }
+        if (secondTitles[1].trim() != "## 计算") {
+            errors.push(`文件 ${filePath} 不符合仓库的规范！ 第二个标题不是 计算!`);
+        }
+        if (secondTitles[2].trim() != "## 操作") {
+            errors.push(`文件 ${filePath} 不符合仓库的规范！ 第三个标题不是 操作`);
+        }
+        if (secondTitles[3].trim() != "## 附加内容") {
+            errors.push(`文件 ${filePath} 不符合仓库的规范！ 第四个标题不是 附加内容`);
+        }
+
+        var mustHave = '如果您遵循本指南的制作流程而发现有问题或可以改进的流程，请提出 Issue 或 Pull request 。';
+        var mustHaveIndex = dataLines.indexOf(mustHave);
+        if (mustHaveIndex < 0) {
+            errors.push(`文件 ${filePath} 不符合仓库的规范！ 它没有包含必需的附加内容！`);
+        }
+    }
+    
+    if (errors.length > 0) {
+        for (var error of errors) {
+            console.error(error + "\n");
+        }
+
+        var message = `Found ${errors.length} errors! Please fix!`;
+        throw new Error(message);
+    }
+}
+
+main();

.github/pull_request_template.md

@@ -0,0 +1,30 @@
+<!-- 请在此填写该 pr 的内容，例如 增加 or 修改一道菜谱。 -->
+
+## 修改类型
+
+这个 Pull Request 是在：
+
+- [ ] 增加菜谱
+- [ ] 修复错误
+- [ ] 其它
+
+## 检查单
+
+- [ ] 我已阅读贡献模板，并按照模板规范进行了内容创作。
+  - [ ] 菜谱包含`必备原料和工具`, `计算`, `操作`三部分内容。
+  - [ ] 菜品的`原材料用量`是无歧义且准确的。对于可以自行发挥的量给出了建议的范围。
+  - [ ] 菜品的`制作步骤`是无歧义，准确且完整的。对于每一个步骤的开始和结束都有明确的标准。
+- [ ] 我没有破坏模板的一二级标题格式。
+- [ ] 我没有删除模板中必需的内容。
+- [ ] 我已删除干净所有的复制出来的模板的注释。
+- [ ] 我确保我没有签入任何和版权方相关的内容、图片。
+
+请审核人员按照 [审核检查单](https://github.com/Anduin2017/HowToCook/blob/master/CONTRIBUTING.md#%E5%AE%A1%E6%A0%B8%E5%91%98%E9%A1%BB%E7%9F%A5) 对照审核检查。
+
+## 警告
+
+**HowToCook 仓库采用了 [The Unlicense](https://unlicense.org/) 协议！**
+
+**菜谱在签入前，必须确保其可以直接声明进入 "公共领域"（public domain)。这意味着一旦合并后，任何人都可以自由复制，修改，发布，使用，编译，出售或以菜谱的形式或菜的形式分发，无论是出于商业目的还是非商目的，以及任何手段。**
+
+<!-- 如果该 pr 有关联 issue 请在此填写 -->

.github/readme-generate.js

@@ -0,0 +1,163 @@
+const { readdir, writeFile, stat } = require('fs/promises');
+const fs = require('fs').promises;
+
+const README_PATH = './README.md';
+
+const MKDOCS_PATH = 'mkdocs.yml';
+
+const ignorePaths = ['.git', 'README.md', 'node_modules', 'CONTRIBUTING.md', '.github'];
+
+const categories = {
+  vegetable_dish: {
+    title: '素菜',
+    readme: '',
+    mkdocs: '',
+  },
+  meat_dish: {
+    title: '荤菜',
+    readme: '',
+    mkdocs: '',
+  },
+  aquatic: {
+    title: '水产',
+    readme: '',
+    mkdocs: '',
+  },
+  breakfast: {
+    title: '早餐',
+    readme: '',
+    mkdocs: '',
+  },
+  staple: {
+    title: '主食',
+    readme: '',
+    mkdocs: '',
+  },
+  'semi-finished': {
+    title: '半成品加工',
+    readme: '',
+    mkdocs: '',
+  },
+  soup: {
+    title: '汤与粥',
+    readme: '',
+    mkdocs: '',
+  },
+  drink: {
+    title: '饮料',
+    readme: '',
+    mkdocs: '',
+  },
+  condiment: {
+    title: '酱料和其它材料',
+    readme: '',
+    mkdocs: '',
+  },
+  dessert: {
+    title: '甜品',
+    readme: '',
+    mkdocs: '',
+  },
+};
+
+async function main() {
+  try {
+    let README_BEFORE = (README_MAIN = README_AFTER = '');
+    let MKDOCS_BEFORE = (MKDOCS_MAIN = MKDOCS_AFTER = '');
+    const markdownObj = await getAllMarkdown('.');
+    for (const markdown of markdownObj) {
+      if (markdown.path.includes('tips/advanced')) {
+        README_AFTER += inlineReadmeTemplate(markdown.file, markdown.path);
+        MKDOCS_AFTER += inlineMkdocsTemplate(markdown.file, markdown.path);
+        continue;
+      }
+
+      if (markdown.path.includes('tips')) {
+        README_BEFORE += inlineReadmeTemplate(markdown.file, markdown.path);
+        MKDOCS_BEFORE += inlineMkdocsTemplate(markdown.file, markdown.path);
+        continue;
+      }
+
+      for (const category of Object.keys(categories)) {
+        if (!markdown.path.includes(category)) continue;
+        categories[category].readme += inlineReadmeTemplate(markdown.file, markdown.path);
+        categories[category].mkdocs += inlineMkdocsTemplate(
+          markdown.file,
+          markdown.path,
+          true,
+        );
+      }
+    }
+
+    for (const category of Object.values(categories)) {
+      README_MAIN += categoryReadmeTemplate(category.title, category.readme);
+      MKDOCS_MAIN += categoryMkdocsTemplate(category.title, category.mkdocs);
+    }
+
+    const MKDOCS_TEMPLATE = await fs.readFile("./.github/templates/mkdocs_template.yml", "utf-8");
+    const README_TEMPLATE = await fs.readFile("./.github/templates/readme_template.md", "utf-8");
+
+    await writeFile(
+      README_PATH,
+      README_TEMPLATE
+        .replace('{{before}}', README_BEFORE.trim())
+        .replace('{{main}}', README_MAIN.trim())
+        .replace('{{after}}', README_AFTER.trim()),
+    );
+
+
+    await writeFile(
+      MKDOCS_PATH,
+      MKDOCS_TEMPLATE
+        .replace('{{before}}', MKDOCS_BEFORE)
+        .replace('{{main}}', MKDOCS_MAIN)
+        .replace('{{after}}', MKDOCS_AFTER),
+    );
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+async function getAllMarkdown(path) {
+  const paths = [];
+  const files = await readdir(path);
+  // chinese alphabetic order
+  files.sort((a, b) => a.localeCompare(b, 'zh-CN'));
+
+  // mtime order
+  // files.sort(async (a, b) => {
+  //   const aStat = await stat(`${path}/${a}`);
+  //   const bStat = await stat(`${path}/${b}`);
+  //   return aStat.mtime - bStat.mtime;
+  // });
+  for (const file of files) {
+    const filePath = `${path}/${file}`;
+    if (ignorePaths.includes(file)) continue;
+    const fileStat = await stat(filePath);
+    if (fileStat.isFile() && file.endsWith('.md')) {
+      paths.push({ path, file });
+    } else if (fileStat.isDirectory()) {
+      const subFiles = await getAllMarkdown(filePath);
+      paths.push(...subFiles);
+    }
+  }
+  return paths;
+}
+
+function inlineReadmeTemplate(file, path) {
+  return `- [${file.replace('.md', '')}](${path}/${file})\n`;
+}
+
+function categoryReadmeTemplate(title, inlineStr) {
+  return `\n### ${title}\n\n${inlineStr}`;
+}
+
+function inlineMkdocsTemplate(file, path, isDish = false) {
+  return `${' '.repeat(isDish ? 10 : 6)}- ${file.replace('.md', '')}: ${path}/${file}\n`;
+}
+
+function categoryMkdocsTemplate(title, inlineStr) {
+  return `\n${' '.repeat(6)}- ${title}:\n${inlineStr}`;
+}
+
+main();

.github/stale.yml

@@ -0,0 +1,28 @@
+# Configuration for probot-stale - https://github.com/probot/stale
+# Number of days of inactivity before an issue becomes stale
+daysUntilStale: 30
+# Number of days of inactivity before a stale issue is closed
+daysUntilClose: 7
+# Issues with these labels will never be considered stale
+exemptLabels:
+  - "Type: Bug"
+# Label to use when marking an issue as stale
+staleLabel: "Resolution: Stale"
+issues:
+  # Comment to post when marking an issue as stale.
+  markComment: >
+    This issue has been automatically marked as stale.
+    **If this issue is still affecting you, please leave any comment** (for example, "bump"), and we'll keep it open.
+    We are sorry that we haven't been able to prioritize it yet. If you have any new additional information, please include it with your comment!
+  # Comment to post when closing a stale issue.
+  closeComment: >
+    Closing this issue after a prolonged period of inactivity. If this issue is still present in the latest release, please create a new issue with up-to-date information. Thank you!
+pulls:
+  # Comment to post when marking a pull request as stale.
+  markComment: >
+    This pull request has been automatically marked as stale.
+    **If this pull request is still relevant, please leave any comment** (for example, "bump"), and we'll keep it open.
+    We are sorry that we haven't been able to prioritize reviewing it yet. Your contribution is very much appreciated.
+  # Comment to post when closing a stale pull request.
+  closeComment: >
+    Closing this pull request after a prolonged period of inactivity. If this issue is still present in the latest release, please ask for this pull request to be reopened. Thank you!

.github/templates/mkdocs_template.yml

@@ -0,0 +1,85 @@
+site_name: How To Cook
+
+# Repository
+repo_name: Anduin2017/HowToCook
+repo_url: https://github.com/Anduin2017/HowToCook
+edit_uri: ""
+
+use_directory_urls: true
+docs_dir: .
+theme:
+  name: material
+  language: zh
+  features:
+    - content.code.annotate
+    # - content.tabs.link
+    # - header.autohide
+    #- navigation.expand
+    #- navigation.indexes
+    - navigation.instant
+    - navigation.sections
+    - navigation.tabs
+    - navigation.tabs.sticky
+    - navigation.top
+    - navigation.tracking
+    - search.highlight
+    - search.share
+    - search.suggest
+    - toc.follow
+    # # - toc.integrate
+  search_index_only: true
+  palette:
+    - media: "(prefers-color-scheme: light)"
+      scheme: default
+      toggle:
+        icon: material//weather-sunny
+        name: Switch to dark mode
+    - media: "(prefers-color-scheme: dark)"
+      scheme: slate
+      toggle:
+        icon: material/weather-night
+        name: Switch to light mode
+
+  icon:
+    admonition:
+      note: octicons/tag-16
+      abstract: octicons/checklist-16
+      info: octicons/info-16
+      tip: octicons/squirrel-16
+      success: octicons/check-16
+      question: octicons/question-16
+      warning: octicons/alert-16
+      failure: octicons/x-circle-16
+      danger: octicons/zap-16
+      bug: octicons/bug-16
+      example: octicons/beaker-16
+      quote: octicons/quote-16
+
+markdown_extensions:
+  - admonition
+  - pymdownx.details
+  - pymdownx.superfences
+  - abbr
+  - pymdownx.snippets
+  - def_list
+  - pymdownx.tasklist:
+      custom_checkbox: true
+  - attr_list
+
+plugins:
+  - same-dir
+  - search
+  - minify:
+      minify_html: true
+
+nav:
+  - README.md
+  - 做菜之前:
+{{before}}
+  - 菜谱:
+    - 按种类: # 只有两层section以上才能出现navigation expansion https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/#navigation-sections
+{{main}}
+  - 进阶知识学习:
+{{after}}
+  - CONTRIBUTING.md
+  - CODE_OF_CONDUCT.md