跳到主要内容

使用 Writage 实现 Microsoft Word 到 GitHub Wiki 的工作流

简介​

本指南介绍如何使用 Writage 插件直接在 Microsoft Word 中撰写和编辑 GitHub Wiki 页面。

对于偏好 Word 熟悉界面与功能，同时希望利用 GitHub 进行版本控制与协作的创作者，该工作流十分适用。

Writage 是一款适用于 Microsoft Word 的 Markdown 编辑器插件。它支持用户直接在 Word 中编写和编辑 Markdown 文档，从而更轻松地为 GitHub Wiki 创建并格式化内容。

推送到 Wiki 仓库的 Markdown 文档将作为新页面显示在 Wiki 上。

先决条件​

操作步骤​

安装并配置 Writage​

  1. 按照安装提示完成 Writage 插件的配置。

展示 Writage 安装过程的图示

在 Microsoft Word 中使用 Writage​

安装 Writage 插件后，您可以像处理普通 Word 文档一样撰写和编辑 Markdown 文档。借助 Writage，您可以直接在 Word 中打开现有的 Markdown 文件，并将 Word 文档另存为 Markdown 文件。

展示 Microsoft Word 中 Writage 界面的图示

将 GitHub Wiki 克隆到 GitHub Desktop​

GitHub Desktop 不会自动克隆仓库的 Wiki。您必须手动克隆 Wiki 仓库。

  1. 在 GitHub 上打开 Wiki，并复制页面右下角的克隆 URL。

    该 Wiki 主页的屏幕截图

  2. 在 GitHub Desktop 中，按下 Ctrl+Shift+O 打开 Clone a repository 对话框。

  3. 点击 URL 选项卡。

  4. 粘贴 Wiki URL，然后点击 Clone。

    GitHub Desktop 克隆对话框的屏幕截图

将 Markdown 文档推送到 GitHub Wiki​

在 Word 中撰写 Markdown 文档后，您可以直接将其推送到 GitHub Wiki 仓库。这避免了在 GitHub 网页编辑器中反复复制、粘贴和格式化内容的繁琐过程。

  1. 将 Markdown 文档保存到您克隆 Wiki 仓库的本地目录中。

  2. 打开 GitHub Desktop 应用程序。

  3. 选择该 Wiki 仓库。

  4. 输入简明的提交摘要，然后点击 Commit to main 或 Commit to master。

    备注

    在提交更改之前请输入简要概述。该概述清晰描述了文档的更新内容，有助于其他协作者在无需通读完整文件的情况下快速了解修订背景。

    GitHub Desktop 提交对话框的屏幕截图

  5. 按下 Ctrl+P 或点击 Push origin 将更改推送到 Wiki。

  6. 在网页浏览器中打开 Wiki 以验证已发布的页面。

每当创建新文档或编辑现有 Wiki 页面时，请重复上述步骤。

将 Markdown 文档转换为 PDF 文件​

  1. 在 Word 中打开 Markdown 文档。
  2. 点击 文件 > 另存为。
  3. 在文件格式下拉菜单中选择 PDF。
  4. 选择目标文件夹，然后点击 保存。