zyimm/HowToCook
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge branch 'master' of github.com:Anduin2017/HowToCook

Browse Source
This commit is contained in:
Anduin Xue 2022-03-01 01:04:13 +08:00
commit 69b1db597a
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
CONTRIBUTING.md
View File

@ -99,9 +99,9 @@
## 文档网站构建 ## 文档网站构建
除了直接部署Readme.md的HTML，还可以利用`mkdocs-material`来render markdown文件。这会得到更加漂亮的页面。 除了直接部署 Readme.md 的 HTML，还可以利用`mkdocs-material`来 render markdown 文件。这会得到更加漂亮的页面。
`./docs` 文件夹的存在是workaround mkdocs要求`.md`文件不能存在于根目录中。里面全部是relative symlink到实际的文件夹 `./docs` 文件夹的存在是 workaround mkdocs 要求`.md`文件不能存在于根目录中。里面全部是 relative symlink 到实际的文件夹
需求: Python > 3.6 需求: Python > 3.6
@ -120,4 +120,4 @@ $ mkdocs serve
$ mkdocs build $ mkdocs build
``` ```
生成静态HTML网页, 存在于在`site/`文件夹下。Hosting的时候指向到`site/index.html`即可。 生成静态 HTML 网页, 存在于在`site/`文件夹下。Hosting 的时候指向到`site/index.html`即可。