[tools]python的mkdocs模块分分钟将md搞成一个网站

Posted 2020-10-23 毛台

docusaurus: facebook出的一个文档生成器,用起来感觉没那么友善

hugo: 这个很棒

python的mkdocs模块: 用起来最简单

python的这个模块可以分分钟将一坨md假设成一个网站
参考: http://www.mkdocs.org/

安装配置

pip install mkdocs

mkdocs new my-project
cd my-project


只需要将一坨md丢到相应的目录启动服务即可.

mkdocs serve

访问效果

还可以diy他的主题
theme: readthedocs

\\

我喜欢这个主题mkdocs-material

参考
参考网站

Install the latest version of Material with pip:

pip install mkdocs-material

Append the following line to your project\'s mkdocs.yml:

theme:
  name: \'material\'