跳到主要内容

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

简介​

本指南介绍如何使用 Writage 插件在 Microsoft Word 中撰写和编辑 GitHub Wiki 页面。如果您偏好 Word 的编辑工具,并希望 GitHub 记录每次页面修改,请使用此工作流。

Writage 为 Microsoft Word 添加 Markdown 支持。您可以在 Word 中打开、编辑并保存 Markdown 文件。推送到 Wiki 仓库的每个 Markdown 文件都会成为 Wiki 上的一个页面,文件名决定页面名称。

先决条件​

操作步骤​

备注

以下步骤使用 Windows 快捷键。在 macOS 上,请将步骤中的 Ctrl 替换为 Cmd。

安装并配置 Writage​

  1. 运行 Writage 安装程序,并按提示操作。

    显示默认安装选项的 Writage 安装程序

  2. 打开 Microsoft Word,确认功能区上显示 Writage 选项卡。

在 Microsoft Word 中使用 Writage​

安装插件后,Word 会将 Markdown 文件视为普通文档。您可以打开现有的 Markdown 文件,也可以新建文件。

  1. 选择 文件 > 另存为。
  2. 在文件格式列表中选择 Markdown。
  3. 按要创建的 Wiki 页面命名文件。

Word 功能区上带有 Markdown 样式的 Writage 选项卡

将 GitHub Wiki 克隆到 GitHub Desktop​

GitHub Desktop 不会随仓库一起克隆 Wiki。请单独克隆 Wiki。

  1. 在浏览器中打开 Wiki,然后从 Clone this wiki locally 区域复制地址。

    显示 Wiki 克隆地址的 GitHub Wiki 页面

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

  3. 粘贴 Wiki 地址,然后选择 Clone。

    带有地址字段的 GitHub Desktop 克隆对话框

将 Markdown 文档推送到 GitHub Wiki​

将文件推送到 Wiki 仓库。这样可以绕开 GitHub 网页编辑器,无需重新复制和格式化页面。

  1. 将 Markdown 文件保存到克隆 Wiki 仓库的本地文件夹中。

  2. 打开 GitHub Desktop,选择该 Wiki 仓库。

  3. 输入简明的提交摘要,然后选择 Commit to main。如果 Wiki 使用其他默认分支,按钮会显示该分支的名称。

    备注

    撰写能说明修改内容的摘要,其他人无需打开文件即可了解改动。

    GitHub Desktop 中的提交摘要字段和提交按钮

  4. 按 Ctrl+P,或选择 Push origin,推送更改。

  5. 在浏览器中打开 Wiki,验证新页面。

每当创建新文档或编辑现有页面时,重复这些步骤。

将 Markdown 文档转换为 PDF 文件​

  1. 在 Word 中打开 Markdown 文档。
  2. 选择 文件 > 另存为。
  3. 在文件格式列表中选择 PDF。
  4. 选择目标文件夹,然后选择 保存。