Kate（KDE Advanced Text Editor）是一款自由開源的文本編輯器，適用于 Linux、Windows 和 macOS。

對(duì)于文檔編寫者來說，Kate 集成的 Git 功能可以幫助簡(jiǎn)化編寫過程。你無需記住 Git 命令，也無需在每次更改文件或切換分支時(shí)在終端中輸入它們。

本文重點(diǎn)為從事各種 Fedora 文檔倉(cāng)庫(kù)的貢獻(xiàn)者介紹 Kate 的主要功能。這些功能可以擴(kuò)展到其他文檔倉(cāng)庫(kù)。

將 Kate 與你的倉(cāng)庫(kù)一起使用的準(zhǔn)備工作

1. 將 SSH 密鑰添加到 Pagure、GitLab 或 GitHub 上的帳戶設(shè)置中。

• 在 Pagure 上，轉(zhuǎn)到 我的設(shè)置My Settings – SSH 密鑰SSH Keys – 添加 SSH 密鑰Add SSH Key
• 在 GitLab 上，首選項(xiàng)Preferences – 用戶設(shè)置User Settings – 添加 SSH 密鑰Add an SSH Key
• 在 GitHub 上，設(shè)置Settings – SSH 和 GPG 密鑰SSH and GPG keys – 新的 SSH 密鑰New SSH key

2. 復(fù)刻項(xiàng)目：轉(zhuǎn)到上游倉(cāng)庫(kù)并選擇 “復(fù)刻Fork” 按鈕
3. 克隆倉(cāng)庫(kù)

• 在你的分叉?zhèn)}庫(kù)中，選擇 “使用 SSH 克隆Clone with SSH”。
• 接下來，將該鏈接復(fù)制到剪貼板并將其粘貼到終端中的 GIT URL 中。
• 克隆倉(cāng)庫(kù)時(shí)，你可以指定新目錄名稱作為附加參數(shù)。$ git clone <GIT URL> 新目錄

4. 安裝 Kate。如果你是 Linux 用戶，請(qǐng)轉(zhuǎn)到發(fā)行版的包管理器來安裝 Kate。如果你使用 Fedora Linux，我們推薦 Fedora Linux RPM 版本或 Flatpak。

會(huì)話

Kate 文本編輯器中的會(huì)話功能可以將單獨(dú)的項(xiàng)目分組在一起，并幫助你在單個(gè)視圖中處理多個(gè)文檔倉(cāng)庫(kù)。

要將倉(cāng)庫(kù)保存在會(huì)話中：

轉(zhuǎn)到 “文件File” 下拉菜單 – 選擇 “打開文件夾Open folder” – 選擇克隆的目錄。

從 “會(huì)話Sessions” 下拉菜單中 – 選擇 “保存會(huì)話Save session” – 輸入會(huì)話名稱 – 按 “確定OK”。

在左側(cè)窗格中，單擊 “項(xiàng)目列表project list” 保存到新會(huì)話“Magazine”。下次打開 Kate 時(shí)，保存到會(huì)話中的克隆倉(cāng)庫(kù)將重新出現(xiàn)。

Sessions Menu

使用狀態(tài)欄簽出分支

使用 Kate 編輯器，你可以在狀態(tài)欄和彈出屏幕上切換分支或創(chuàng)建新分支。

當(dāng)前分支顯示在狀態(tài)欄的右下角。

要?jiǎng)?chuàng)建新分支，請(qǐng)選擇 “Main” 分支。從彈出菜單中選擇 “創(chuàng)建新分支Create New Branch” 并輸入新分支名稱。

Popup menu showing Create New branch

對(duì) AsciiDoc 高亮顯示的內(nèi)置支持

具有 AsciiDoc 擴(kuò)展名的文件將使用 asciidoc.xml 中的規(guī)則自動(dòng)高亮顯示。你不需要安裝外部插件。

即時(shí)拼寫檢查

如果你希望在輸入時(shí)自動(dòng)進(jìn)行拼寫檢查，請(qǐng)按 Ctrl + Shift + O。此組合鍵將打開和關(guān)閉拼寫檢查。

Git 工具視圖

左側(cè)窗格中的工具視圖顯示每個(gè)打開文件的 Git 狀態(tài)。

Show diff

“已暫存Staged” 表示文件已添加（與 Git 添加相同），并且如果你選擇頂部的 “提交Commit” 按鈕，文件將被提交。

“已修改Modified” 顯示尚未暫存的更改。

單擊左側(cè)面板頂部的 “提交Commit” 按鈕以顯示該提交的差異。這將在提交工具視圖中打開選定的提交。如果你想查看提交中的所有更改，請(qǐng)右鍵單擊并選擇 “顯示完整提交Show Full Commit”，添加一個(gè)提交消息。

Git “推送Push” 按鈕在 “提交Commit” 按鈕的右邊。Git “拉取Pull” 按鈕在 “推送Push” 按鈕的右邊。

選擇 “刷新Refresh” 圖標(biāo)（圓圈箭頭）以查看暫存文件和提交的情況。

集成終端

按 F4 或選擇 “終端Terminal” 按鈕可打開和關(guān)閉集成終端。

你可以通過集成終端使用構(gòu)建腳本和 Vale linter，將你的寫作提升到一個(gè)新的水平，確保文檔質(zhì)量。

步驟 1. 運(yùn)行構(gòu)建腳本

要在本地檢查文檔質(zhì)量，你可以在集成終端中運(yùn)行構(gòu)建和預(yù)覽腳本。構(gòu)建和預(yù)覽腳本可讓你準(zhǔn)確查看更改如何通過 Antora 靜態(tài)站點(diǎn)生成器在文檔頁面中發(fā)布。

注意：檢查 Fedora 文檔倉(cāng)庫(kù)的 README 頁面，為構(gòu)建腳本和說明使用正確的文件名。下面是一個(gè)例子：

要構(gòu)建和預(yù)覽站點(diǎn)，請(qǐng)運(yùn)行：

$ ./docsbuilder.sh -p

結(jié)果可訪問 http://localhost:8080

要停止預(yù)覽：

$ ./docsbuilder.sh -k

步驟 2. 對(duì)你的文本運(yùn)行 Vale

Vale 是一個(gè)命令行工具，用于檢查文本是否符合定義的樣式指南。參考該 指南 在本地運(yùn)行 Vale。

鳴謝

非常感謝 KDE 開發(fā)人員 Nicco，他的視頻教程頻道 “Nicco loves Linux” 給了我很多靈感。

本文使用的 Kate 版本為 23.08.3

上游文檔

以下是本文使用的 Fedora 文檔 Git 倉(cāng)庫(kù)：

• 快速文檔
• Kinoite 用戶文檔
• IoT 用戶文檔
• 文檔貢獻(xiàn)者指南