MkDocs使用

安装Python

首先需要提前安装好python,因为要使用pip工具下载mkdocs。

安装mkdocs包

pip install mkdocs


使用

创建项目

mkdocs new projectName

项目创建成功以后,会得到一个名为你指定名字的一个文件夹,其中包含有两个文件,一个是名为docs的文件夹,另一个是名为mkdocs.yml的配置文件。docs文件夹中包含有一个名为index.md的文件,网站的内容就在这个文件里边进行编辑。

其中,如果需要网站的名字,在mkdocs.yml里边将site_name:改为需要的名字即可。

剩下的内容就变成markdown语法写文件就可以了。

运行项目

mkdocs serve

发布

mkdocs build

©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容