林林.台灣 | Linwebs - 課程

HackMD 同步 GitHub 儲存庫

HackMD 有一個功能是可以將筆記直接推送到 GitHub 儲存庫中，像是編輯 README 之類的 Markdown 檔案，使用 HackMD 來進行編輯，再將筆記推送到 GitHub 上的儲存庫，可以讓 Markdown 格式的文件撰寫更加的方便。

開始同步筆記之前，首先要準備的是一個 GitHub 帳號，並且擁有一個儲存庫，儲存庫可以是在 GitHub 平台上新建立的。

1. 首先在HackMD中建立一個新的筆記，接下來在筆記編輯器下方的換行，請改用 CommonMark 標準換行。
   
2. 點選畫面中右上角的分享按鈕，將筆記可閱讀的權限設為【所有人】。
   
3. 接下來點選畫面中右上角的選項，【版本與 GitHub 同步】。
   
4. 在此可看到此筆記的版本紀錄，點選上方的【推送至 GitHub】按鈕。
   
5. 點選【授權更多 Repo】至 GitHub 賦予 HackMD 能修改檔案的權限。
   
6. 點選上一個步驟的【授權更多 Repo】後會自動開啟 GitHub 的頁面，如果你的 GitHub 帳號有加入不同團隊的話，請選擇要設定的儲存庫所在的團隊，否則就選擇自己的使用者名稱。
   
7. 因為賦予權限是一個重大的事件，需再次輸入 GitHub 的密碼進行確認。
   
8. 在此可選擇要給 HackMD 哪些筆記讀取和寫入的權限，也可以直接選擇上面的【All repositories】，賦予 HackMD 修改這個帳號所有儲存庫內容的權限。
   
9. 若不想授予所有的權限，也可選擇個別的儲存庫。
   
10. 回到 HackMD，點選剛才【授權更多 Repo】左邊的【更新】，即可在下拉選單中選擇想要同步的儲存庫。
    
11. 接下來設定好分支、同步的檔案，並加上版本名稱(也就是下 git commit -m "" 指令時，引號裡面所加的文字)。
    
12. 最後按下推送(push 到 GitHub)，就會顯示推送的結果。
    
13. 回到 GitHub 這個儲存庫，可看到 README.md 已被更新了。
    
14. 可在 GitHub 的 commit 紀錄看到此次是由 HackMD 所 commit 的。
    
15. 可在 HackMD 看到與 GitHub 儲存庫同步的狀態。
    
16. 若更改 HackMD 內的檔案需再次推送，才會將 GitHub 儲存庫的內容更新。
    點選左方的【筆記目前狀態】，在點選右方藍色框框的【儲存為版本】的按鈕。
    
17. 一樣可在此輸入版本名稱，並點選【儲存為版本】，就完成類似 git commit 指令的動作。
    
18. 要 push 到 GitHub 時，點選右上角的【推送更新】。
    
19. 一樣確認好要推送到的分支以及要推送上去的版本後就可以按下【推送】按鈕。
    
20. 可在 GitHub 上看到儲存庫的 README.md 檔案已被更新了。