用 Python 开发的快速、简单的静态文档网站生成器

大家好,今天推荐一款用 Python 开发的快速、简单的静态网站生成器,主要是为了构建项目的文档。文档源是 markdown 文件,可通过一个 YAML 文件进行配置。该项目会根据你提供的文档,自动在左侧生成目录树导航,效果如下。

image-20200329221215283

同时项目还默认集成了搜索功能,整体搜索效果还不错。

image-20200329222904413

为什么要推荐这个项目呢?主要还是简单快捷,这个项目除了用来生成文档的网站,其实也可以用来做个人知识整理的网站,我几乎没花什么功夫,就生成了一个。接下来介绍一下我是怎么生成的。

  • 首先安装工具

    有 Python 环境的使用 pip 就可以直接安装 pip install mkdocs,使用其他包管理工具也可以直接安装,比如 yum、apt-get、Homebrew 等。

  • 配置网站

    配置文件名 mkdocs.yml,配置部分常用的是配置网站名,以及导航栏,数据源是 markdown。另外一个要注意的地方就是,项目默认的文档地址是 docs,所以如果你的文档有专门的文件夹名存放地方的话,需要注意配置中的 docs_dir。

    site_name: MkLorum  // 网站名称
    docs_dir: posts  // 设置文档存放的文件夹
    nav:  // 导航栏
       - Home: index.md
       - About: about.md
       - 'Issue Tracker': 'https://example.com/'   // 可以设置其他网站的导航
    
  • 启动服务

    在文件 mkdocs.yml 同目录下执行命令 mkdocs serve,访问 127.0.0.1:8000 就可以访问你生成的网站了。

更多详情请参考如下链接。

开源项目地址:https://github.com/mkdocs/mkdocs

开源作者:https://github.com/mkdocs

其实有很多类似的生成网站的开源项目,欢迎留言交流你都使用过哪些好用的网站生成工具。


更多精彩请扫码关注如下公众号。

Written on March 29, 2020