MkDocs使用

MkDocs官网

这个是官网,一个简单的mk格式的博客框架,十分简单。真是简单到不能再简单了,关键风格还不错,于是今天就拿来用了。

正好还有个服务器,用nginx做了个代理就跑起来了。

使用很简单,用pip安装。我用的是conda,python3.6的环境。安装命令是

conda install -c conda-forge mkdocs

然后找个目录,创建工程

mkdocs new my-project
cd my-project

就可以启动了

mkdocs serve

默认是http://127.0.0.1:8000/

也可以

mkdocs serve -a 0.0.0.0:8000

指定ip和端口

因为是静态网页,所以只要编辑页面就好了,都在docs目录下

docs/
├── about.md
├── favorites.md
├── index.md
└── python_game.md

md格式的页面,就按照md语法写就好了。基本上就是这样了。

网站的结构配置文件编辑mkdocs.yml就好了,比如我的是

site_name: Sigma blog
nav:
    - Home: index.md
    - Python:
        - Game: python_game.md
    - 收藏夹:
        - 代码: favorites.md
    - About: about.md

这样就有次级目录了。

修改文件保存后,网站就会实时加载修改,很方便。

做好了后要发布,执行命令

mkdocs build

把site文件夹的东西拷到服务器就好了,至此大功告成。

我服务器用的是nginx,原来已经有网站了,所以就做了nginx端口转发,之前用的uwsgi,有点转不过弯来,google了下其实转到静态文件所在的目录就好了。

    location /blog/ {
        alias /home/xiaoming/xiaomingblog/site/;
    }

当然,不用nginx也是可以的,随便用什么吧。

要是无所谓的话,直接

mkdocs serve -a 0.0.0.0:8000

就ok,简单粗暴。反正性能安全神马的,那都是后话了。