皇上，还记得我吗?我就是1999年那个Linux伊甸园啊-----24小时滚动更新开源资讯，全年无休！

使用 Kate 编写文档

2024-01-22 分类：开源资讯 评论(0)

Kate（KDE Advanced Text Editor）是一款自由开源的文本编辑器，适用于 Linux、Windows 和 macOS。

对于文档编写者来说，Kate 集成的 Git 功能可以帮助简化编写过程。你无需记住 Git 命令，也无需在每次更改文件或切换分支时在终端中输入它们。

本文重点为从事各种 Fedora 文档仓库的贡献者介绍 Kate 的主要功能。这些功能可以扩展到其他文档仓库。

将 Kate 与你的仓库一起使用的准备工作

  1. 将 SSH 密钥添加到 Pagure、GitLab 或 GitHub 上的帐户设置中。
    • 在 Pagure 上，转到 我的设置My Settings – SSH 密钥SSH Keys – 添加 SSH 密钥Add SSH Key
    • 在 GitLab 上，首选项Preferences – 用户设置User Settings – 添加 SSH 密钥Add an SSH Key
    • 在 GitHub 上，设置Settings – SSH 和 GPG 密钥SSH and GPG keys – 新的 SSH 密钥New SSH key
  2. 复刻项目：转到上游仓库并选择 “复刻Fork” 按钮
  3. 克隆仓库
    • 在你的分叉仓库中，选择 “使用 SSH 克隆Clone with SSH”。
    • 接下来，将该链接复制到剪贴板并将其粘贴到终端中的 GIT URL 中。
    • 克隆仓库时，你可以指定新目录名称作为附加参数。$ git clone <GIT URL> 新目录
  4. 安装 Kate。如果你是 Linux 用户，请转到发行版的包管理器来安装 Kate。如果你使用 Fedora Linux，我们推荐 Fedora Linux RPM 版本或 Flatpak。

会话

Kate 文本编辑器中的会话功能可以将单独的项目分组在一起，并帮助你在单个视图中处理多个文档仓库。

要将仓库保存在会话中：

转到 “文件File” 下拉菜单 – 选择 “打开文件夹Open folder” – 选择克隆的目录。

从 “会话Sessions” 下拉菜单中 – 选择 “保存会话Save session” – 输入会话名称 – 按 “确定OK”。

在左侧窗格中，单击 “项目列表project list” 保存到新会话“Magazine”。下次打开 Kate 时，保存到会话中的克隆仓库将重新出现。

使用 Kate 编写文档

Sessions Menu

使用状态栏签出分支

使用 Kate 编辑器，你可以在状态栏和弹出屏幕上切换分支或创建新分支。

当前分支显示在状态栏的右下角。

要创建新分支，请选择 “Main” 分支。从弹出菜单中选择 “创建新分支Create New Branch” 并输入新分支名称。

使用 Kate 编写文档

Popup menu showing Create New branch

对 AsciiDoc 高亮显示的内置支持

具有 AsciiDoc 扩展名的文件将使用 asciidoc.xml 中的规则自动高亮显示。你不需要安装外部插件。

即时拼写检查

如果你希望在输入时自动进行拼写检查，请按 Ctrl + Shift + O。此组合键将打开和关闭拼写检查。

Git 工具视图

左侧窗格中的工具视图显示每个打开文件的 Git 状态。

使用 Kate 编写文档

Show diff

“已暂存Staged” 表示文件已添加（与 Git 添加相同），并且如果你选择顶部的 “提交Commit” 按钮，文件将被提交。

“已修改Modified” 显示尚未暂存的更改。

单击左侧面板顶部的 “提交Commit” 按钮以显示该提交的差异。这将在提交工具视图中打开选定的提交。如果你想查看提交中的所有更改，请右键单击并选择 “显示完整提交Show Full Commit”，添加一个提交消息。

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

选择 “刷新Refresh” 图标（圆圈箭头）以查看暂存文件和提交的情况。

集成终端

按 F4 或选择 “终端Terminal” 按钮可打开和关闭集成终端。

你可以通过集成终端使用构建脚本和 Vale linter，将你的写作提升到一个新的水平，确保文档质量。

步骤 1. 运行构建脚本

要在本地检查文档质量，你可以在集成终端中运行构建和预览脚本。构建和预览脚本可让你准确查看更改如何通过 Antora 静态站点生成器在文档页面中发布。

注意：检查 Fedora 文档仓库的 README 页面，为构建脚本和说明使用正确的文件名。下面是一个例子：

要构建和预览站点，请运行：

  1. $ ./docsbuilder.sh -p

结果可访问 http://localhost:8080

要停止预览：

  1. $ ./docsbuilder.sh -k

步骤 2. 对你的文本运行 Vale

Vale 是一个命令行工具，用于检查文本是否符合定义的样式指南。参考该 指南 在本地运行 Vale。

鸣谢

非常感谢 KDE 开发人员 Nicco，他的视频教程频道 “Nicco loves Linux” 给了我很多灵感。

本文使用的 Kate 版本为 23.08.3

上游文档

以下是本文使用的 Fedora 文档 Git 仓库：

（题图：DA/519568d2-a224-4075-a751-a1a8bc702079）

via: https://fedoramagazine.org/writing-docs-with-kate-and-git/

作者：Hank Lee 选题：lujun9972 译者：geekpi 校对：wxy

本文由 LCTT 原创编译，Linux中国 荣誉推出

转自 https://linux.cn/article-16574-1.html

相关推荐