🐭

zenn-cliで記事作成してみた

commits2 min read

概要

先日行われたDevelopers Summit 2021でZennの開発者である、catnose氏がZennの開発秘話を話されました。

https://event.shoeisha.jp/devsumi/20210218/session/3082/
Zennを個人で開発されており、個人開発の苦労話やZennの機能紹介などたいへんおもしろい内容でした。
その中で、GitHubリポジトリとZennの連携、zenn-cliを使い、ローカルエディタでZennの記事作成ができるという話がありました。
なのでさっそく一個お試しで作成してみました。

GitHubリポジトリとの連携

具体的な方法については開発者様の記事をご覧になればわかると思いますので詳しい手順については割愛します。

https://zenn.dev/zenn/articles/connect-to-github
こんな感じで私のGitHubリポジトリとZennを連携することで記事の管理ができます。

zenn-cliの導入

同じく具体的な手順については開発者様の記事を参照

https://zenn.dev/zenn/articles/zenn-cli-guide

npx zenn previewコマンドを実行するとhttp://localhost:8000でプレビュー画面が立ち上がり、プレビューしながらローカルエディタで執筆できます。

下書き画面の様子

---
title: "zenn-cliで記事作成してみた" #title
emoji: "🐁" #icon
type: "idea" # tech: 技術記事 / idea: アイデア
topics: [初心者,Zenn]
published: false
---

zenn-cliの使い方記事で紹介されているとおり、npx zenn new:articleで、ファイル内に上記のヘッダー設定が記述された記事作成用のMarkdownファイルが作成されます。
ここでタイトルや記事に含まれているトピックの設定、Zennの記事カテゴリである、Tech系かIdea系の分類を決めることができます。
publishedの部分ですが、ここをtrueにすることで、実際に記事を全体に公開できます。

デプロイ

デプロイできるブランチは1つだけですので、Zennの設定画面からデプロイ実行するブランチを決めて、該当のブランチでgit pushすれば自動デプロイされます。

使った感想

この記事がzenn-cliで書いた記事になります。
私はエディタでVisual Studio Codeを使用していますが、オンラインエディタと異なりプラグインを導入することで記事作成がしやすいエディタを使うことができて便利でした。
自分がタイピングした内容をリアルタイムでブラウザから確認でき、画像の挿入もZenn側でアップローダがあるおかげで、自分でimgurから画像URLを作成する必要がありません。
まさにかゆいところに手が届くよいサービスだと思いました。
2021年2月現在はすでに記事で公開しているものをGitHubリポジトリで管理できず、記事内容をコピー&ペーストしてローカルエディタに貼り付けるというやり方になるそうです。
その時に設置する記事のファイル名はURLから見れるこれです。

ちなみに記事のMarkdownの名前ですが、Zenn内で一意である必要があります。
(Slugというそうです。詳しくはこちら⇓)

https://zenn.dev/zenn/articles/what-is-slug
すでに公開している記事のSlugの変更はできないので、GitHubリポジトリで管理したい場合は、以下の通りにします。
  1. articles/booksディレクトリ内にファイル名が公開済み記事のSlugであるMarkdownファイルを作成する。
  2. 作成したMarkdownファイルに記事の内容をコピー&ペーストする。
  3. publishedtrueにしてgit pushでデプロイする。

これで完了です。
今後はこちらを中心に記事を書いていきます。

GitHubで編集を提案

Discussion

ログインするとコメントできます