👋欢迎

欢迎来到JiepengLab！我会时不时更新一些目前正在学习的笔记！

点击前往笔记本

如何在本地构建？

本文档使用 mkdocs 构建，并使用了 material 第三方主题，你需要在本地依次序安装 Python、mkdocs、material 主题。

Python 安装

官网安装指导已经给出各系统安装方式，根据官网内容安装即可。

mkdocs、material 主题

均可以通过 pip（Python 的包管理器） 进行安装。

$ pip install mkdocs
$ pip install mkdocs-material

具体地，你可以分别查看 mkdocs 的安装指导 与 material 的安装指导。

本地构建

你只需要将本仓库拉至本地，后使用 mkdocs serve 部署即可。

# 拉取仓库
$ git clone git@github.com:JiepengLab/notebook.git
# 构建
$ cd ./notebook
$ mkdocs serve

如果你使用本地部署查看文档，请在每次使用前查看并拉取远程仓库的 master 分支更新 git pull。

如何提建议

本人水平有限，文档难免有错误以及排布不合理之处。

如果你：

• 发现文档有知识性或实践性的错误
• 发现文本中的错别字/格式错误/图片缺失
• 对文档有建议

欢迎提交 Issue 与我沟通！

非常期待得到你的反馈！