431-A1C-GEN-mkdocs博客搭建

28 阅读2分钟

mkdocs博客搭建

环境准备

注:Python2 >=2.7.9或者Python3.4以后默认都安装有pip 由于pip默认的下载比较慢,所以需要配置镜像 操作如下:(全局配置)
1 - Linux/Mac os 环境中,mkdir ~/.pip配置文件位置在 ~/.pip/pip.conf
2- Windows下打开C:\Users\用户名 ,新建文件夹pip,在文件夹下新建文件pip.ini
pip.conf或pip.ini如下

[global]
index-url = https://pypi.tuna.tsinghua.edu.cn/simple
extra-index-url = 
 http://mirrors.aliyun.com/pypi/simple
 http://pypi.douban.com/simple
 http://pypi.mirrors.ustc.edu.cn/simple

[install]
trusted-host = 
 pypi.tuna.tsinghua.edu.cn
 mirrors.aliyun.com
 pypi.douban.com
 pypi.mirrors.ustc.edu.cn

disable-pip-version-check = false
timeout = 120  


  • C++编译器

注:可以先不安装C++ 编译环境,如果遇到了问题再回来安装 由于没有安装C++编译环境可能会遇到以下问题 error: Microsoft Visual C++ 14.0 is required. 下载Build Tools 先安装其中的VisualCppBuildTools_Full.exe,依旧无法解决的话全部下载进行安装

开始安装

1> mkdocs安装 pip install mkdocs

出现类似如下即为安装成功 2> 创建一个mkdocs项目(my-project是你需要创建项目的名称) mkdocs new my-project

项目创建完成后会有两个文件

  • mkdocs.yml:核心配置文件
  • docs : 改文件夹是你存放.md格式笔记的地方
    • docs/index.md : 网站的首页显示内容

3> 启动本地服务 mkdocs serve

访问http://127.0.0.1:8000/就可以看到生成文档的效果了

部署到Gitee上

[默认已经有了git相关知识及开启了Gitee page服务]

  • 使用mkdocs build命令在本地"编译"生成一个site文件夹
  • 创建一个空的仓库
  • 使用git命令上传到gitee仓库
  • 上传后点击"服务"

  • 开启page 耐性等待几分钟即可

插件

reveal
1- 编写slide.html 时中的路径
		<link rel="stylesheet" href="/blog/assets/reveal/dist/reset.css">
		在本地运行时不加/blog
		部署在gitee上时需要加
		
		路径的写法为直接写名字
		<section data-markdown="slides.xml"  ....>

2 - 编写ppt内容的文件不能用.txt做为后缀,具体原因不详,但既有可能是gitee不支持
		在静态page中使用txt ,实测xml反正是可以的

Citation:

References: