diff --git a/.gitignore b/.gitignore index 9379563..e52d469 100644 --- a/.gitignore +++ b/.gitignore @@ -2,3 +2,4 @@ node_modules/ .history .DS_Store +site/ diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index fdf27f1..4f98bd4 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -96,3 +96,24 @@ - 确保签入的内容都符合 CC0 协议。尤其注意图片是否有水印! - 确保他没有签入任何个人身份信息、EUII、Email 地址、GitHub 用户名 + +## Documentation Hosting + +利用`mkdocs-material`来render markdown文件。 + +`./docs` 文件夹的存在是workaround mkdocs要求`.md`文件不能存在于根目录中。里面全部是relative symlink到 +实际的文件/文件夹 + +需求: Python > 3.6 + +如何使用: +``` +pip install -r requirements.txt +mkdocs serve +``` + +Documentation可以再本地http://localhost:8000/打开。 + +管理员: +用`mkdocs build` 生成静态HTML网页, 存在于在`site/`文件夹下。Hosting的时候指向到`site/index.html`即可。 + diff --git a/dishes/drink/金菲士/金菲士.md b/dishes/drink/金菲士/金菲士.md index f2e78c7..e5be5e0 100644 --- a/dishes/drink/金菲士/金菲士.md +++ b/dishes/drink/金菲士/金菲士.md @@ -9,7 +9,7 @@ - 金酒 - 苏打气泡水 - 柠檬 -- [蔗糖糖浆](../condiment/蔗糖糖浆/蔗糖糖浆.md) +- [蔗糖糖浆](../../condiment/蔗糖糖浆/蔗糖糖浆.md) - 冰块 - 新鲜绿叶(可选,装饰用) diff --git a/dishes/home-cooking/孜然牛肉.md b/dishes/home-cooking/孜然牛肉.md index 57b9fca..164da10 100644 --- a/dishes/home-cooking/孜然牛肉.md +++ b/dishes/home-cooking/孜然牛肉.md @@ -30,7 +30,7 @@ * 首先将小米椒切碎,和孜然粒一起放入捣药罐捣碎成颗粒,这样更入味。如果时间紧张可跳过捣碎步骤 * 青椒切头去籽(喜欢辣的可不去),切成丝。葱切段。 * 牛肉提前解冻,过一边水洗干净,晾干或用厨用纸吸干,将牛肉顺着纹理切成片 -* 然后进行腌肉,加入生抽,淀粉,油,均匀搅拌,静止 30 分钟。腌肉方法也可参考[学习腌](./tips/learn/学习腌.md) +* 然后进行腌肉,加入生抽,淀粉,油,均匀搅拌,静止 30 分钟。腌肉方法也可参考[学习腌](../../tips/learn/学习腌.md) * 热锅下油,放入葱,爆出香味后放入腌好的牛肉煸炒 * 牛肉变色后均匀放入孜然辣椒颗粒并炒熟 * 然后下入青椒丝,断生后放盐 diff --git a/dishes/home-cooking/红烧鱼头.md b/dishes/home-cooking/红烧鱼头.md index f860922..86c22c9 100644 --- a/dishes/home-cooking/红烧鱼头.md +++ b/dishes/home-cooking/红烧鱼头.md @@ -51,7 +51,7 @@ ### 最终步骤 * 加入 30ml 油,等待锅热... -* 油热,将锅关至小火,如果你不明白为何要这样做,请查看[烧菜须知](./烧菜须知.md)中的翻炒辅料。 +* 油热,将锅关至小火,如果你不明白为何要这样做,请查看[学习炒与煎](../../tips/learn/学习炒与煎.md)中的翻炒辅料。 * 放入姜片,慢慢翻炒,以姜片中的大部分汁水被炒出,以金黄色为准。 * 放入葱段,翻炒至葱段略显发白。 * 放入蒜碎、八角、干辣椒,翻炒 5 秒。 diff --git a/dishes/home-cooking/鱼香肉丝.md b/dishes/home-cooking/鱼香肉丝.md index b3e4911..ac91463 100644 --- a/dishes/home-cooking/鱼香肉丝.md +++ b/dishes/home-cooking/鱼香肉丝.md @@ -45,7 +45,7 @@ * 用`腌料`腌制里脊肉 15-30min。注意将肉抓匀。 * 干木耳泡一个晚上,洗净,切成小块。 * 青椒洗净,去蒂,切成丝。 -* 胡萝卜洗净,切成丝,将胡萝卜丝[焯水](../../tips/learn/焯水.md)。 +* 胡萝卜洗净,切成丝,将胡萝卜丝[焯水](../../tips/learn/学习焯水.md)。 * 姜、蒜切沫。 * 葱切成 5mm 的小段。 diff --git a/dishes/staple/日式咖喱饭/日式咖喱饭.md b/dishes/staple/日式咖喱饭/日式咖喱饭.md index 188da7b..c10658d 100644 --- a/dishes/staple/日式咖喱饭/日式咖喱饭.md +++ b/dishes/staple/日式咖喱饭/日式咖喱饭.md @@ -53,7 +53,7 @@ ### 3.冷藏后加热 -冷藏的咖喱每次取出需要吃的份量,加热后盖在[米饭](../米饭.md)上。 +冷藏的咖喱每次取出需要吃的份量,加热后盖在[米饭](../米饭/米饭.md)上。 - 微波炉:单人份高火 2-3 分钟 - 锅:需额外加 50ml 水,加热时保持搅拌 diff --git a/dishes/staple/炸酱面.md b/dishes/staple/炸酱面.md index 370832f..7c05826 100644 --- a/dishes/staple/炸酱面.md +++ b/dishes/staple/炸酱面.md @@ -12,7 +12,7 @@ ## 操作 -1. 白菜(或其他菜)切丝,[焯水](../../tips/learn/焯水.md)至软化熟透,盛出备用。 +1. 白菜(或其他菜)切丝,[焯水](../../tips/learn/学习焯水.md)至软化熟透,盛出备用。 2. 煮面条至断生(无白芯),连同汤水一同盛出备用。 3. 蒜切末。油锅烧热,下蒜末和肉,炒至肉完全熟透(无红色)。 4. 下豆瓣酱和甜面酱,加 30g 水盖盖焖煮至收汁粘稠,得到炸酱。 diff --git a/dishes/staple/烙饼/烙饼.md b/dishes/staple/烙饼/烙饼.md index d85cc7c..e458192 100644 --- a/dishes/staple/烙饼/烙饼.md +++ b/dishes/staple/烙饼/烙饼.md @@ -26,7 +26,7 @@ * 大火烙一分钟,打开盖子,将饼翻个面再烙一分钟 * 重复以上动作,完成饼的烙制 -![](./Images/烙饼/成品.jpg) +![](./成品.jpg) 这是我第一次做面食类,缺点很多,但自己吃还是相当不错的 ## 附加内容 diff --git a/dishes/staple/蛋炒饭.md b/dishes/staple/蛋炒饭.md index 3c36dd9..7e4762d 100644 --- a/dishes/staple/蛋炒饭.md +++ b/dishes/staple/蛋炒饭.md @@ -14,7 +14,7 @@ * 香葱 * 灯影牛肉丝(备选) -准备时,米饭可以参考[米饭的做法](./米饭.md)。 +准备时,米饭可以参考[米饭的做法](./米饭/米饭.md)。 ## 计算 diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md new file mode 120000 index 000000000..44fcc63 --- /dev/null +++ b/docs/CONTRIBUTING.md @@ -0,0 +1 @@ +../CONTRIBUTING.md \ No newline at end of file diff --git a/docs/dishes b/docs/dishes new file mode 120000 index 000000000..54ff3c5 --- /dev/null +++ b/docs/dishes @@ -0,0 +1 @@ +../dishes \ No newline at end of file diff --git a/docs/index.md b/docs/index.md new file mode 120000 index 000000000..32d46ee --- /dev/null +++ b/docs/index.md @@ -0,0 +1 @@ +../README.md \ No newline at end of file diff --git a/docs/tips b/docs/tips new file mode 120000 index 000000000..977bb21 --- /dev/null +++ b/docs/tips @@ -0,0 +1 @@ +../tips \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 000000000..2a5987a --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,18 @@ +site_name: How To Cook +use_directory_urls: true +theme: + name: material + features: + - navigation.instant + palette: + - media: "(prefers-color-scheme: light)" + scheme: default + primary: grey + 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 \ No newline at end of file diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 000000000..898468c --- /dev/null +++ b/requirements.txt @@ -0,0 +1 @@ +mkdocs-material \ No newline at end of file