GitHubリポジトリでZennのコンテンツを管理する

公開:2020/09/06
更新:2020/09/22
3 min読了の目安(約2000字TECH技術記事

この機能はベータ版で、仕様が変更される可能性があります

Zennにはオンラインエディターが用意されていますが、GitHubリポジトリと連携すればローカルのテキストエディターで執筆することもできます。

GitHub連携時のイメージ

GitHubリポジトリと連携した場合、投稿コンテンツの作成や更新はすべてリポジトリ内で行います。登録したブランチに変更があると、zenn.devへ自動で同期(デプロイ)が行われます

同期するブランチの指定

GitHub連携が完了している場合、下記のページからブランチを変更できます。
デプロイ設定 →

コンテンツの作成

ローカルのテキストエディターなどでマークダウンファイルを作成し、編集します。ファイルの作成やプレビューにはZenn CLIを使用できます。

編集が完了したらリモートリポジトリ(GitHub)へプッシュします。登録したブランチへのプッシュやプルリクエストのマージによりデプロイが開始されます。

zenn.devにまだ存在しない名前のファイルが見つかると新しいコンテンツとして作成されます。

デプロイ履歴はダッシュボードから確認できます。デプロイ時に発生したエラーもここでチェックします。

内容の更新

内容を変更するときは.mdファイルを編集し、再度プッシュします。変更が加えられた.mdファイルのみがzenn.devに同期されます。

コンテンツの削除

安全のため、コンテンツの削除はダッシュボードからのみ行うことができます。

GitHubとの連携手順

1. リポジトリを作成する

まずGitHubで好きな名前のリポジトリを作成します。公開設定はPublicでもPrivateでもOKです。この時点ではリポジトリの中身は空にしておきます。README.mdを作成する必要もありません。

2. ダッシュボードから連携する

Zennにログインしたうえで、ダッシュボードのデプロイ管理を開きます。

[リポジトリを連携]を選ぶと、リポジトリの選択する画面が表示されます。

このとき必ず「Only select repositories」にチェックを入れて、さきほど作成したリポジトリだけを選ぶようにしてください。

複数のリポジトリが選択されていると連携は失敗します。これは安全のための意図的な仕様です。

これで連携は完了です。

3. 同期するブランチ名を確認

デプロイページで同期したいブランチ名を確認・変更します。

ここで登録されている名前のブランチに変更があったときに自動でデプロイが行われます。

ファイルの作成やプレビューはCLIで

ローカルでのファイルの作成や、マークダウンのプレビューにはZenn CLIを使います。具体的な使い方は下記のページをご覧ください。

📘 Zenn CLIの導入手順 →