メインコンテンツまでスキップ

Writageを使用したMicrosoft WordからGitHub Wikiへのワークフロー

はじめに​

これは、Microsoft Word用のWritageアドインを使用して、Wordから直接GitHub Wikiページを作成・編集する方法に関するガイドです。

これは、Wordの使い慣れたインターフェースや機能を好む執筆者が、GitHubのバージョン管理や共同編集機能を活用できる点で有益です。

Writageは、Microsoft Word用のMarkdownエディタアドインです。 これにより、ユーザーは Word 内で直接 Markdown 文書を作成・編集できるため、GitHub Wiki 向けのコンテンツ作成や書式設定が容易になります。

Wiki リポジトリにプッシュされた Markdown 文書は、Wiki 上の新しいページとして表示されます。

前提条件​

Writageには14日間の無料試用期間があります。その後、ライセンスを購入する必要があります。 :::

手順​

Writageの設定​

  1. インストール画面の指示に従って、Writageアドインを設定します。

Writageのインストール手順を示す図

Microsoft WordでのWritage​

Writageアドインをインストールすると、通常のWord文書と同じようにMarkdown文書を作成・編集できるようになります。 Writage を使用すると、既存の Markdown ファイルを Word で直接開いたり、Word 文書を Markdown ファイルとして保存したりできます。Microsoft Word での Writage インターフェースを示す画像

Markdown 文書を PDF ファイルに変換する​

  1. WordでMarkdown文書を開きます。
  2. [ファイル] > [名前を付けて保存] をクリックします。
  3. ファイル形式のドロップダウンメニューから [PDF] を選択します。
  4. 任意の場所にファイルを保存します。

GitHub WikiをGitHub Desktopにクローンする​

GitHub DesktopはGitHub Wikiを自動的にクローンしません。手動でクローンする必要があります。

  1. Wikiを開き、ページの右下隅にあるURLをコピーします。

このWikiのホームページのスクリーンショット

  1. GitHub Desktopで、CTRL+SHIFT+Oを押して「リポジトリをクローン」ダイアログを開きます。
  2. URL タブをクリックします。
  3. WikiのURLを貼り付け、Clone をクリックします。

GitHub Desktopのクローンダイアログのスクリーンショット

Markdown ドキュメントを GitHub Wiki にプッシュする​

Word で Markdown ドキュメントを作成したら、GitHub の Markdown エディタにコピー＆ペーストしてそこで書式設定を行う必要なく、GitHub リポジトリの Wiki にプッシュできます。

  1. Markdown ドキュメントを、GitHub Desktop のインストール時に設定された Wiki フォルダに保存します。
  2. GitHub Desktop アプリを開きます。
  3. Wikiリポジトリを選択します。
  4. 変更をコミットします（要約を追加します）。
  5. CTRL+P を押して、変更をWikiにプッシュします。

注： ファイルをWikiにプッシュするには、事前に要約を追加する必要があります。要約にはドキュメントへの変更点が簡潔に記述され、他の貢献者がドキュメント全体を読まなくても更新内容を理解するのに役立ちます。

GitHub Desktopのコミットダイアログのスクリーンショット

  1. ブラウザでWikiを開き、更新された内容を確認します。

新しいドキュメントを作成する場合や既存のドキュメントを編集する場合も、同様の手順を繰り返してドキュメントをGitHubにプッシュしてください。