🛠️

ZennのコンテンツをGitHubで管理する

2024/12/14に公開

GitHub連携のための設定

Zennのコンテンツを編集するディレクトリを作成する

Zennのコンテンツを編集するディレクトリを用意します。今回使用するディレクトリ名は、zenn-docsとしておきます。

GitHubにリポジトリを作成する

GitHubに新しくリポジトリを作成します。今回はリポジトリ名は上記と同じくzenn-docsとしておきます。

Zennのダッシュボードから連携する

以下の記事を参考に、ZennのコンテンツをGitHubリポジトリに連携する設定を行っていきます。

https://zenn.dev/zenn/articles/connect-to-github

  • Zennにログインして、ダッシュボードのGitHubからのデプロイを開きます。
  • 「リポジトリを連携」を選んで、リポジトリを選択する画面を表示します。
  • 「Only select repositories」にチェックを入れて、連携するリポジトリ(今回はzenn-docs)を選びます。

最初のPushを行う

空コミットを行う

Zennのコンテンツを編集するほうのzenn-docsディレクトリをローカルリポジトリに設定して、空コミットしておきます。コミットメッセージは「first commit」としておきます。

git init
git commit --allow-empty -m "first commit"

mainブランチを生成してGitHubにPushする

以下のコマンドで、mainブランチを生成して、ローカルリポジトリをGitHubのzenn-docsリポジトリにPushします。

git branch -M main
git remote add origin https://github.com/<GitHubユーザー名>/zenn-docs.git
git push -u origin main

これで、GitHubのzenn-docsリポジトリに空コミットがPushされました。

ローカルリポジトリでZennのコンテンツを編集する

ローカルリポジトリで、以下の記事のようにZenn CLIを有効にして、Zennのコンテンツを編集できるようにしておきます。

https://zenn.dev/ats030/articles/how-to-use-zenn-cli

編集後のローカルリポジトリをGitHubにPushする

ローカルリポジトリでZennのコンテンツを編集した後、GitHubにPushしたい場合は以下のコマンドを実行します。<コミットメッセージ>には、編集内容の概要を入力するようにしてください。

git add .
git commit -m "<コミットメッセージ>"
git push -u origin main

これで、GitHubのzenn-docsリポジトリにローカルリポジトリの編集内容が反映されました。

GitHubで編集を提案

Discussion