windows安装创建mkdocs项目

windows安装创建mkdocs项目

环境配置:
windows 10
python 3.7.3

在这里插入图片描述

1. 下载pip和解压入口

下载PIP压缩包(不好找的话可以点击上边的“入口”进行下载),解压得到pip-9.0.1文件夹
windows安装创建mkdocs项目_第1张图片
打开该文件夹,如下目录,有一个setup.py文件
windows安装创建mkdocs项目_第2张图片

2. 执行安装pip操作

打开cmd命令窗口,切到当前刚刚解压缩的文件夹目录下,执行如下命令,完成pip安装

python setup.py install

windows安装创建mkdocs项目_第3张图片
执行如下命令,测试是否安装成功:

pip -V

显示版本号等信息,表示安装成功
windows安装创建mkdocs项目_第4张图片

3. 安装mkdocs

执行如下命令,安装mkdocs

pip install mkdocs

系统自动去下载文件包并进行安装
注:此处很有可能下载失败,要换个网好的地方多试几次,小编试了五六次,换了手机的热点才安装成功
在这里插入图片描述
安装失败:
windows安装创建mkdocs项目_第5张图片

切手机热点,多试几次,成功~
windows安装创建mkdocs项目_第6张图片
输入如下命令,出现版本信息,则安装正常

mkdocs --version

在这里插入图片描述

4. 创建项目

在这里插入图片描述
windows安装创建mkdocs项目_第7张图片

windows安装创建mkdocs项目_第8张图片

5. 本地启动和访问

切到项目的根目录,执行启动服务命令:

cd my-project-0509
mkdocs serve

windows安装创建mkdocs项目_第9张图片

启动信息中有服务的地址:
在这里插入图片描述
复制地址,粘贴到浏览器地址进行访问,出现如下页面,项目创建完成

http://127.0.0.1:8000

windows安装创建mkdocs项目_第10张图片

6. 实时修改内容,所见即所得

打开mkdocs.yml文件,修改内容,刷新页面,发现标题已经变化
windows安装创建mkdocs项目_第11张图片
windows安装创建mkdocs项目_第12张图片

  • 添加一个页面:

在index.md同级目录新建一个second.md文件,进行编辑,并修改mkdocs.yml进行页面配置
windows安装创建mkdocs项目_第13张图片
windows安装创建mkdocs项目_第14张图片
windows安装创建mkdocs项目_第15张图片
刷新浏览器发现出现了我们新增的页面,点击显示我们编辑的内容
windows安装创建mkdocs项目_第16张图片

7. 编译

执行编译命令

mkdocs build

在这里插入图片描述
编译报错,我们打开mkdocs.yml换一种页面配置的写法
windows安装创建mkdocs项目_第17张图片
再执行编译,编译成功
在这里插入图片描述
打开我们的项目目录,可以看到生成了site文件夹,打开之后发现生成了静态工程的结构
windows安装创建mkdocs项目_第18张图片
windows安装创建mkdocs项目_第19张图片

8. 部署发布

先决条件:注册码云,安装gitbash

将本地代码提交到码云新建的项目
windows安装创建mkdocs项目_第20张图片
点击服务->Gitee Pages
windows安装创建mkdocs项目_第21张图片
填写部署目录,点击启动会生成一个网址
windows安装创建mkdocs项目_第22张图片
windows安装创建mkdocs项目_第23张图片
访问该网址
windows安装创建mkdocs项目_第24张图片
至此,完成mkdocs项目在windows下的安装编辑和部署!!~

整理不易,谢谢支持打赏

windows安装创建mkdocs项目_第25张图片

你可能感兴趣的:(mkdocs,python,git,github)