Centos安装python3.6和MkDocs
1. Centos安装python的简单方法
1.1 从EPEL仓库安装
最新的EPEL 7仓库提供了Python3(python 3.6)的安装源,如果你使用CentOS7或更新的版本的系统你也可以按照下面的步骤很轻松的从EPEL仓库安装。
安装最新版本的EPEL
[root@yami ~]# yum install epel-release
用yum安装python 3.6:
[root@yami ~]# yum install python36
注意:上面的安装方法并未安装pip和setuptools,如果你要安装这两个库可以使用下面的命令:
[root@yami ~]# curl -O https://bootstrap.pypa.io/pip/get-pip.py
[root@yami ~]# sudo /usr/bin/python3.6 get-pip.py
1.2. 确认安装版本,centos7自带python2.5
[root@yami ~]# python3.6 --version
Python 3.6.8
[root@yami ~]# python --version
Python 2.7.5
[root@yami ~]# pip3.6 --version
pip 21.3.1 from /usr/local/lib/python3.6/site-packages/pip (python 3.6)
附注:python官方下载地址
2. 部署MkDocs
2.1 安装MkDocs
MkDocs 是一个用于创建项目文档的 快速, 简单 , 完美华丽 的静态站点生成器. 文档源码使用 Markdown 来撰写, 用一个 YAML 文件作为配置文档.
[root@yami ~]# pip3.6 install mkdocs
mkdocs
已经安装到你的系统. 运行 mkdocs -h
以检查是否正确安装.
[root@yami ~]# mkdocs -h
Usage: mkdocs [OPTIONS] COMMAND [ARGS]...
MkDocs - Project documentation with Markdown.
Options:
-V, --version Show the version and exit.
-q, --quiet Silence warnings
-v, --verbose Enable verbose output
-h, --help Show this message and exit.
Commands:
build Build the MkDocs documentation
gh-deploy Deploy your documentation to GitHub Pages
new Create a new MkDocs project
serve Run the builtin development server
2.2 MkDocs开始
输入以下命令以开始一个新项目.
[root@yami home]# mkdocs new kokwind
INFO - Creating project directory: kokwind
INFO - Writing config file: kokwind/mkdocs.yml
INFO - Writing initial docs: kokwind/docs/index.md
[root@yami home]# cd kokwind
[root@yami kokwind]# ls
docs mkdocs.yml
有一个配置文件 mkdocs.yml
, 和一个包含文档源码的 docs
文件夹. 在 docs
文件夹里包含了一个名为 index.md
的文档.
MkDocs 包含了一个内建的服务器以预览当前文档. 控制台切换当前目录到 mkdocs.yml
配置文件相同文件夹, 输入 mkdocs serve
命令以启动内建服务器:
[root@yami kokwind]# mkdocs serve
INFO - Building documentation...
INFO - Cleaning site directory
INFO - Documentation built in 0.08 seconds
INFO - [16:09:43] Serving on http://127.0.0.1:8000/
2.3 MkDocs添加页面
编辑 doc/index.md
文档, 将默认标题改为 KokWind Wiki
, 刷新浏览器即可看到标题变化.
现在为文档添加第二个页面:
复制index.md
更名为about.md
要为文档添加导航条, 只需在配置文件中添加导航条需要的标题和排序即可:
site_name: KokWind Wiki
site_url: https://www.kokwind.net/
nav:
- Home: index.md
- About: about.md
刷新浏览器即可看到 Home
和 About
导航栏目.
2.4 MkDocs更换主题
可以在配置文件中修改文档主题. 在 mkdocs.yml
中添加如下内容:
site_name: KokWind Wiki
site_url: https://www.kokwind.net/
nav:
- Home: index.md
- About: about.md
theme: readthedocs
刷新浏览器即可看到 ReadTheDocs 主题已被应用.
2.5 MkDocs发布
我们现在已经可以发布 MkLorum
文档了. 通过以下命令生成文档.
[root@yami kokwind]# mkdocs build
INFO - Cleaning site directory
INFO - Building documentation to directory: /home/kokwind/site
INFO - Documentation built in 0.17 seconds
该命令创建了一个 site
新目录. 可以通过以下命令浏览该目录内容:
[root@yami kokwind]# ls
docs mkdocs.yml site
[root@yami kokwind]# cd site
[root@yami site]# ls
404.html about css fonts img index.html js search search.html sitemap.xml sitemap.xml.gz
注意源码被分别输出为 index.html
和 about/index.html
. 主题中的其他文件也被复制到了 site
目录中.
刷新浏览器即可看到新主题已被应用.
🤞附注: MkDocs 生成的文档只包含静态文件,因此你可以将文档部署到任意地方。只需上传 `site` 目录到你需要发布的位置即可! |