centos上安装mkdocs小结

概述

好记性不如烂笔头,养成写备忘录的习惯

MkDocs 是一个用于创建项目文档的 快速简单 , 完美华丽 的静态站点生成器. 文档源码使用 Markdown 来撰写, 用一个 YAML 文件作为配置文档.,下面以我的经历记录下来

  1. 如何安装python3,可以参考我的博文
    https://blog.csdn.net/dong19891210/article/details/104934759
    

     

  2.  安装mkdocs 及主题
    1 pip3  install mkdocs mdx_gh_links mkdocs-material

     

  3. 创建测试案例
    mkdocs new test &&  cd test/
    vi mkdocs.yaml  #追加 theme:name: material
    #启动
    mkdocs serve -a 10.30.32.2:8000
  4. 效果如图:
  5. 具体使用参考 https://mkdocs.readthedocs.io/en/stable/https://www.sitepoint.com/building-product-documentation-mkdocs/

posted @ 2020-03-26 17:24  董广明  阅读(547)  评论(0编辑  收藏  举报