ZennとGitHubが連携できるのでその説明をこの記事にメモしておこうかと思います。
ZennとGitHubのメリット
GitHubのarticlesディレクトリを作成して、そこに記事を書くとZennにデプロイ(反映)されます。
GitHubのReadme.mdってGoogle検索されにくいですよね?
Zennの記事内容をGoogle検索して技術記事を見かけた人は多いかと思います。
もう、おわかりですね。
Google検索でGitHubの内容を検索して結び付けやすいということです。それが連携のメリットです。
連携するデメリット
- GitHubリポジトリ名を変更するとZennにデプロイできなくなる
- 再連携作業が手間
連携仕様
- GitHub→Zenn記事はOK(デプロイすれば内容がZennに反映される)
- Zenn記事→GitHubの反映はNG(手動デプロイするとZenn記事がGitHubのarticlesで上書きされる)
記事構成
- GitHub 上でサクッと空のディレクトリを作成する方法 - Qiita
- GitHubリポジトリでZennのコンテンツを管理する
- Zennのコンテンツをgithub.devで編集する
- Zenn CLIで記事・本を管理する方法
- Zenn CLIをインストールする
.
└─ articles
├── example-article1.md
└── example-article2.md
ファイル-file.mdの中身
タイトルを付けないとデプロイできないので空にしておかないこと。
---
title: "" # 記事のタイトル
emoji: "😸" # アイキャッチとして使われる絵文字(1文字だけ)
type: "tech" # tech: 技術記事 / idea: アイデア記事
topics: [] # タグ。["markdown", "rust", "aws"]のように指定する
published: true # 公開設定(falseにすると下書き)
---
ここから本文を書く
記事内容
Front-matterを冒頭につける。
4ステップでGithubからZennに記事を公開してみる(トラブルシューティング付き)
参考HP