mirror of
https://github.com/Anduin2017/HowToCook.git
synced 2025-12-17 02:34:23 +08:00
adding support for mkdocs-material hosting/docs generation
This commit is contained in:
@@ -95,3 +95,25 @@
|
||||
- 确保分类正确,不和已有的菜名重复
|
||||
- 确保签入的内容都符合 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`即可。
|
||||
|
||||
|
||||
Reference in New Issue
Block a user