跳转至

Mkdocs搭建博客 - 1

Info

Material for MkDocs官方网站: Material for MkDocs
MkDocs中文文档: MkDocs中文文档

一、准备工作

1.配置、安装Git，Python，应该不用交了吧

2.有一个GitHub账号​​​​​​​(有手就行)

二、Creating your site

我首先建议你先在Github创建一个名为你的用户名+github.io的仓库

打开你为mkdocs准备的目录并进入终端依次运行: 

1
2
3
pip install mkdocs-material
mkdocs new mkdocs-site
git init

目录树状图: 

1
2
3
4
5
6
$ tree -a
mkdocs-site
├── .git
├── docs
│   └── index.md
└── mkdocs.yml

docs文件夹里是以后网站的内容，mkdocs.yml是配置文件（配置主题，目录，插件等）

你在这个目录下写的任何东西都可以通过命令行输入mkdocs gh-deploy上传到github上

三、配置完善

打开mkdocs.yml

把以下的内容输入进去（最简单最基础的配置） 

1
2
3
4
5
6
7
site_name: 网站名字
site_url: 网站链接
site_author: 你的名字
repo_name: user-name/repository
repo_url: https://github.com/user-name/repository
theme:
  name: material #主题

并在docs中创建CNAME文件，将域名输入进去

详细mkdocs.yml配置见Changing the colors - Material for MkDocs

在终端运行以下代码可以在浏览器看到实时网站 

1
mkdocs serve

这个网站就算是初步建好了

最后分别运行mkdocs build和mkdocs gh-deploy上传到github

等待一会网址就出来了

你的网站网址就是：​

1
2
https://你github的名字.github.io/
因为我绑定了域名所以网址是：https://cpwiki.v6.army/

想要进一步白嫖的请看我的免费搭建博客技巧

四、参考资料

  1. MkDocs官网
  2. MkDocs中文文档
  3. Material for MkDocs