mkdocs制作自己的Keras文档
步骤1
下载包 或者 如下命令使用git克隆。
git clone https://github.com/keras-team/keras-docs-zh
步骤2
安装mkdocs(pip install mkdocs
)后,进入keras-docs-zh文件夹,依次使用如下cmd命令:
mkdocs build
该操作生成静态文件,在目录下产生site文件夹,此时可以直接运行site/index.html
。
步骤3
执行下面cmd命令。
mkdocs serve
在浏览器输入进行本地访问:
结果如图
在最终的页面可能会出现如下情况:
这种情况是由于导航栏默认是在上方进行设置的,解决此问题需要修改mkdocs.yml文件中的样式。添加下图红框中内容即可。
注:
常用的命令:
mkdocs new dirname :创建项目
mkdocs serve:开启服务
mkdocs build:构建文件的站点
mkdocs help:查看帮助
如果需要为文档手动添加导航条,只要在配置文件中添加需要的标题和排序:
site_name: My Docs
pages:
- [index.md, Home]
- [about.md, About]
- [more.md,More]
theme: readthedocs
刷新浏览器即可看到 Home
和 About
还有More导航栏目