安装mkdocs

一、安装python

安装python2 (python-2.7.13.amd64.msi ) 注意装的时候走自定义安装,勾上”pip”,这样就可以跳过第二步了。”安装到PATH”也勾上。 成功安装后,在cmd中输入python可以看到当前python版本

二、安装pip

如果安装Python的时候没有一起装pip,那么(假设装到了C:\python27,)在C:\Python27\Scripts运行cmd,然后执行easy_install.exe pip

执行完后,输入pip -V 可以看到当前pip版本

三、安装mkdocs

最新的mkdocs会去外网下js,而我们访问那地址很慢或干脆下不到,会导致之后的mkdocs网页打开会卡很久。所以我们用0.16.3版本的mkdocs

打开cmd,输入pip install mkdocs==0.16.3 如果之前已经装了新版本的mkdocs,先pip uninstall mkdocs卸载 如果装不了,可能需要开个vpn。可以试试在C:\Users\xx\pip xx是电脑用户名,建立一个pip.ini,内容填

安装成功输入,mkdocs -V,可以看当前mkdocs版本

如果要在笼子机下安装mkdocs 把笼子外装好的python文件夹整个拷进去,或者去笼子机ftp下载:http://192.168.130.33/软件/Python2.7.13_with_mkdocs.rar

四、新建mkdocs文档

在你想要建立文档的地方运行cmd,输入mkdocs new [文档名]

这时会在当前目录出现同“[文档名]”一样的目录,里面仅有docs文件夹以及mkdocs.yml

五、mkdocs.yml常用配置

 

site_name是博客名 pages表示配置的页面 theme表示主题 use_directory_urls要设置为false,不然不会跳转到对应的html

六、生成页面

在mkdocs.yml同级名录新建 build.bat,运行完之后即可生成页面

生成后会产生site文件夹,里面的search.html就是入口

七、编写mkdocs

  • mkdocs页面是由.md文件生成的,一般存放在docs文件夹中,我们可以用软件markdownpad2进行编写
  • 由于Win10可能有bug,导致html渲染失败,需要安装awesomium
  • 上述两个软件下载地址
  • 用vscode的话,推荐一个叫Markdown All in One的插件,Ctrl + Shift + V预览

 

LEAVE A COMMENT