📚

GitHubとZennを連携する

2023/02/25に公開

はじめに

Zennのコンテンツ執筆方法は「Webエディター」と「ローカルのテキストエディター + CLI」の2種類あります。このうち「ローカルのテキストエディター + CLI」では、GitHubと連携してコンテンツのバージョン管理が可能です。

ここでは、GitHubと「ローカルのテキストエディター + CLI」の連携手順を記載します。

まず、GitHubでリポジトリを作成します。
GitHubへログインし「Repositiries」タブを選択後、「New」ボタンをクリックします。

次に「Repository name（任意の名前でOK）」「公開設定（Public/Private どちらでもOK）」を設定し、画面下部の「Create repository」ボタンをクリックします。

これで、GitHubリポジトリの作成は完了です。

Zennにログイン後、ダッシュボード「GitHubからのデプロイ」へアクセスします。アクセス後「リポジトリを連携する」をクリックします。

以下の画面で「Only select repositories」を選択後、「Select repositories」をクリックし、先ほど作成したリポジトリを選択します。
選択後、「Install & Authorize」ボタンをクリックします。

これで、GitHubとの連携は完了です。

「リポジトリ設定」タブで同期したいブランチ名を確認します。
ここで登録されている名前のブランチに変更があったときに自動でデプロイが実施されます。

ローカルでんおファイルの作成やmarkdownのプレビューにはZenn CLIを使用します。具体的な追加型は以下のページをご覧ください。