使用MKdocs搭建个人主页并关联到GithubPages上
内容导读
互联网集市收集整理的这篇技术教程文章主要介绍了使用MKdocs搭建个人主页并关联到GithubPages上,小编现在分享给大家,供广大互联网技能从业者学习和参考。文章包含1586字,纯文字阅读大概需要3分钟。
内容图文
MKdocs安装
1.首先需要在本地计算机安装python环境和pip工具
2. 使用pip下载Mkdocs库,执行:
pip install mkdocs
3. 在本地任意路径位置创建文档项目,执行:
mkdocs new <project name>
执行完成后会在本地会生成一个以project命名的文件夹,此文件夹中包含站点所有文件信息
4. 尝试开启可用浏览器打开的本地站点,在该文件夹上执行:
mkdocs serve
站点开启成功后会的提示站点默认地址为:https://127.0.0.1:8000。
在浏览器上打开此地址会进入站点
将站点部署到Github上
1. 首先需要说明的是网上有关在本地Github仓库使用命名mkdocs gh-deploy
将站点文件夹同步到Github的方法并不能直接访问。原因是GitHub Pages只能从master branch构建,而在本地仓库使用命令mkdocs gh-deploy
只会在线上仓库另外生成一个名为gh-deploy的分支,因此无法实现使用https://<用户名>.github.io
访问,因此还需要每次更新本地仓库后手动使用git命令将本地仓库同步到线上
2. 首先github官网上以<用户名>.github.io建立线上仓库
3. 在本地合适的位置使用命令clone线上仓库到线下,执行:
git clone https://github.com/<用户名>/<用户名>.github.io.git
4. 在之间使用Mkdocs安装的本地文档项目文件路径文件夹上生成站点文件,执行:
mkdocs build
执行成功后会在本地文档项目文件夹中生成一个名为site的文件夹,site文件夹就是通过mkdocs编译生成的包含index.html的可被浏览器直接打开的静态前端站点
5.进入site文件夹,将文件夹里的文件拷贝到git本地仓库中
6. 在本地git仓库先后执行
git add .
git commit -m "update"
git push -u origin master
将本地仓库中的文件同步到github的master branch上
7. 此时通过https://<用户名>.github.io
域名就可以访问到mkdocs静态网页站点
8. 使用这种方法每次更新本地站点文件需要手动同步一次到github上。
使用个人域名访问github pages
ping <用户名>.github.io
能 ping 通,则代表是可以反问的。
3.配置域名解析。在域名运营商网站工作台中配置域名解析(具体可以去腾讯云,阿里云等申请),添加记录如下
4. 配置Github pages中Settings中的Custom domain填入域名,如aaa.com,并保存。
5. 完成配置,此时可使用域名example.com访问Mkdocs文档。
方法二: 使用免费的域名(www.bitballoon.com)
1.打开 www.bitballoon.com, 注册账户或者第三方进行登录。
2. 将 上面生成 site 文件夹打包成 .zip 文件。
3. 直接拖到下面这个界面。
原文:https://www.cnblogs.com/E-Dreamer-Blogs/p/13323385.html
内容总结
以上是互联网集市为您收集整理的使用MKdocs搭建个人主页并关联到GithubPages上全部内容,希望文章能够帮你解决使用MKdocs搭建个人主页并关联到GithubPages上所遇到的程序开发问题。 如果觉得互联网集市技术教程内容还不错,欢迎将互联网集市网站推荐给程序员好友。
内容备注
版权声明:本文内容由互联网用户自发贡献,该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 gblab@vip.qq.com 举报,一经查实,本站将立刻删除。
内容手机端
扫描二维码推送至手机访问。