用mkdocs在gitee码云上建立一个简单的文档博客
<h1 id="利用mkdocs建立简单的文档博客">利用mkdocs建立简单的文档博客</h1><h2 id="一概述">一、概述</h2>
<p>MkDocs 是一个用于创建项目文档的 快速, 简单 , 完美华丽 的静态站点生成器. 文档源码使用 Markdown 来撰写, 用一个 YAML 文件作为配置文档.</p>
<h2 id="二mkdocs安装">二、mkdocs安装</h2>
<h3 id="1安装python">1、安装python</h3>
<p>可以去python官网下载安装,安装方法网上很多就不多做赘述。</p>
<h3 id="2安装mkdocs">2、安装mkdocs</h3>
<p>python3安装后已经自带pip,可以立即安装mkdocs。</p>
<pre><code class="language-python">pip install mkdocs
</code></pre>
<p>如果下载慢,可更换安装源为豆瓣</p>
<pre><code class="language-python">pip install --trusted-host pypi.douban.com -i http://pypi.douban.com/simple/ mkdocs mkdocs-material
</code></pre>
<p>pip后因为生成的exe是在python下的,就可以使用cmd,如果不能使用,增加环境变量即可。</p>
<h2 id="三建立项目">三、建立项目</h2>
<h3 id="1初始化项目">1、初始化项目</h3>
<pre><code>mkdocs new my-project
</code></pre>
<h3 id="2修改主题">2、修改主题</h3>
<p>mkdocs.yml里添加:</p>
<pre><code class="language-python">theme:
name: material
</code></pre>
<h3 id="3生成html">3、生成html</h3>
<pre><code class="language-python">mkdocs gh-deploy
# 生成在site目录下,可以用浏览器查看效果
</code></pre>
<h3 id="4执行服务预览效果">4、执行服务预览效果</h3>
<pre><code class="language-python">mkdocs serve
#通过浏览器打开 http://127.0.0.1:8000/ 查看效果
</code></pre>
<h2 id="四部署到gitee">四、部署到gitee</h2>
<p>因为没做过自服务器部署就没写这部分,这里是部署在国内的gitee上。</p>
<h3 id="1新建仓库">1、新建仓库</h3>
<p>注册、登陆码云,新建仓库</p>
<p><img src="http://m.qpic.cn/psb?/V12eSr6j2B4t4E/tWy1T9LI0nTZkq5OEj.ud*fdRIYRPw6bWJUMcguXMmA!/b/dLYAAAAAAAAA&bo=nwELAQAAAAADF6Y!&rf=viewer_4"></p>
<p><img src="http://m.qpic.cn/psb?/V12eSr6j2B4t4E/8ZSTooZ*1bEuQybmkYy5QRyNIn23jkca*0yJTlYyyv4!/b/dMMAAAAAAAAA&bo=FANyAgAAAAADB0U!&rf=viewer_4"></p>
<h3 id="2windows下git-bash安装">2、windows下Git BASH安装</h3>
<p>git下载<br>
http://www.git-scm.com/download/</p>
<p>教程<br>
https://blog.csdn.net/weixin_41714277/article/details/79399270</p>
<h3 id="3git-bash上传">3、Git BASH上传</h3>
<p>①右键打开Git BASH</p>
<p><img src="http://m.qpic.cn/psb?/V12eSr6j2B4t4E/lSTXFiHeLTW88c4et3x34Y1k3FRBzcguYTL12NQowDM!/b/dLYAAAAAAAAA&bo=AgFyAQAAAAADB1I!&rf=viewer_4"></p>
<p>②复制连接</p>
<p><img src="http://m.qpic.cn/psb?/V12eSr6j2B4t4E/WpFkPQ4OtNs137g3oQzKT9HmnC4aUrd4e0q6OqSt4yQ!/b/dL8AAAAAAAAA&bo=WANJAQAAAAADBzE!&rf=viewer_4"></p>
<p>③下拉仓库</p>
<pre><code class="language-python">git clone 复制的连接
</code></pre>
<p>④将mkdocs生成的项目my-project移到仓库文件夹内<br>
⑤上传</p>
<pre><code>git add .
# 加入到暂存区
git commit -m up
# 提交到版本库
git push
# 上传
</code></pre>
<h3 id="4开启gitee-pages-服务">4、开启Gitee Pages 服务</h3>
<p><img src="http://m.qpic.cn/psb?/V12eSr6j2B4t4E/pSCR8qXhYVytlTD5nU4u3GMFQIoaK*Bmmqd2oaVZ6w4!/b/dL8AAAAAAAAA&bo=NAOzAQAAAAADB6c!&rf=viewer_4"></p>
<h2 id="五最终效果">五、最终效果</h2>
<p><img src="http://m.qpic.cn/psb?/V12eSr6j2B4t4E/Qx.Vxc1jVPEHMqvuW0YWiRo7gtiWpSWVGM.GAwN5Yto!/b/dLgAAAAAAAAA&bo=mgWPAwAAAAADBzE!&rf=viewer_4"></p><br><br>
来源:https://www.cnblogs.com/yywBlogW/p/11362889.html
頁:
[1]