---
title: "如何將你的筆記同步至 GitHub"
tags: zh, product, education
description: "在這篇 HackMD GitHub 整合功能指南中，你將學習如何設定整合、同步筆記並維護你的文件。"
image: "[https://hackmd.io/\_uploads/ryfle9yP6.jpg](https://hackmd.io/_uploads/ryfle9yP6.jpg)"
author: Rachellynn
summary: 透過 HackMD 的 GitHub 整合功能釋放你的工作流程潛力。在這篇 HackMD GitHub 整合功能指南中，你將學習如何設定整合、同步筆記並維護你的文件。今天就提升你的文件撰寫體驗。
date: "2023-12-20"
---

面對當今工作環境的需求，管理工作流程、組織專案以及進行有效協作，往往就像在沒有地圖的情況下走迷宮一樣。

往好處想是極具挑戰，往壞處想則是幾乎不可能。

這很快就會讓人感到不知所措。但在 HackMD，我們的使命就是讓使用 Markdown 進行協作和工作變得盡可能簡單。

這時就需要：**GitHub**

透過 HackMD 的 GitHub 整合功能，你可以讓所有的文件和專案工作保持同步。

### 設定 HackMD 的 GitHub 整合功能

那麼，這項整合功能是如何運作的？它對你又意味著什麼？

首先，你需要[在你的 GitHub 帳號上安裝 HackMD GitHub App](https://github.com/apps/hackmd-hub)。完成後，連結（並授權）相應的帳號與儲存庫（Repositories）。

完成這些步驟後，你就可以開始同步了。

### 將你的筆記同步至 GitHub

首次將筆記推送到 GitHub 或從 GitHub 拉取檔案時，需要選擇你想要同步筆記的儲存庫、分支（Branch）和檔案。

如果你需要建立新的分支或檔案，直接在 HackMD 中輸入新名稱即可建立，非常直觀。


>[!Note] **注意：**
> 你可以在 HackMD 中同步與編輯 `.md` / `.mdx` / `.rmd` / `.markdown` 檔案。但 HackMD 目前不支援 MDX 和 R 語法的渲染。

### 維護已同步的筆記

連結完成後，目標儲存庫和檔案會出現在筆記設定的「版本紀錄 (Versions)」面板中。你可以直接在版本紀錄面板中，毫不費力地推送後續變更、從 GitHub 拉取內容或取消筆記與 GitHub 的連結。

正在與 GitHub 上的其他協作者合作嗎？你可以在已同步筆記的頂端加上一個徽章（Badge），向你的社群標示他們可以在哪裡加入討論並為文件撰寫流程做出貢獻。

推送和拉取筆記到 GitHub 的功能也同樣內建在你的「版本紀錄」面板中。

在這裡，你可以選擇要推送哪一個命名的版本。推送後，每個具名版本在 Git 中都會顯示為一次「Commit（提交）」，而該版本的名稱和描述則會顯示為 Commit 訊息。

從 GitHub 拉取內容時，只需選擇你想拉取的分支，或選擇你想合併到筆記中的修訂版本區塊即可。

### 換行符號渲染

在結束前，我們必須談談「換行符號渲染 (Line break rendering)」。理解 HackMD 和 GitHub 之間這些規則的細微差異，能確保跨平台格式的一致性。

HackMD 遵循 [CommonMark 規範](https://spec.commonmark.org/0.29/)，以確保你的筆記與其他平台相容。不過換行符號有其自身的一些規則，這往往會影響筆記在 GitHub 上的呈現方式。

由於 HackMD 和 GitHub 渲染換行符號的方式不同，你的筆記在兩個平台上看起來可能會有所差異。話雖如此，你隨時可以直接在筆記設定中，或點擊筆記底部的 `Breaks` 按鈕來更改預設的換行符號渲染方式。這將套用至所有未來的筆記。

### 提升你的文件撰寫體驗

我們深知同時管理多個工具會有多令人沮喪。

HackMD 的 GitHub 整合功能提供了一個強大的解決方案，可在這兩個強大的工具之間無縫同步筆記並增強協作。

藉由彌合平台之間的鴻溝，使用者能享有一個免除煩惱的環境，進行高效的文件撰寫與團隊合作。

你可以[在這裡了解更多關於 GitHub 整合功能的資訊](https://hackmd.io/c/tutorials/%2Fs%2Flink-with-github)。

我們迫不及待想看到你的創作成果。

請持續**追蹤**更多更新。