使用MKdocs搭建個人主頁並關聯到GithubPages上


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 

方法一: 
1. Github自帶的Pages地址過長,如果需要使用個人域名打開個人Mkdocs文檔,可以在以上部署Github部署完成后執行如下操作
2. 首先需要知道個人Github Pages的IP地址,在本地終端中,執行:
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. 直接拖到下面這個界面。 

 

 



 


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM