zenn-cliのリポジトリでqiitaも管理する
どうも初めまして、A-kunです。
A-kun Advent Calendar 2024の一日目です。
はじめに
qiitaもzennもcliツールがある。
ならどちらも、同じgithubリポジトリの中で管理できたら嬉しいなーと思って、やってみた。
zenn-cliをセットアップする。
githubでリポジトリを作成し、下記記事に従ってzennと連携させる。
連携したらcloneし、下記記事を参考にzenn-cliのセットアップを終わらせる。
qiitaのCLIを導入してみる
公式リポジトリの中に、CLIツールのインストール方法があるのでこれに従ってみる。
zennの記事が入っているリポジトリにインストールしてみる。
インストールが完了すると、package.jsonにちゃんとzennとqiitaが両方入っていることがわかる。
{
"dependencies": {
"zenn-cli": "^0.1.158"
},
"devDependencies": {
"@qiita/qiita-cli": "^1.6.1"
}
}
zenn-cliの場合は、articles・booksフォルダー内に記事を作成する。
一方、qiita-cliでは publicフォルダー内に記事を作成する。
両方同じリポジトリで管理することができることが確認できた。やったぜ。
zenn-cliの場合はGitHub Actionsを使って、自動デプロイされる。一方でqiitaの場合はコマンドでデプロイする必要がある。混同しないようにしたい。
zenn-cliとqiita-cliのコマンド
混同しないように、いかにzenn-cliとqiita-cliの主要なコマンドを載せる。これさえ覚えておけば記事はかけるし投稿できる。とても簡単。
zenn-cli
記事を作るときは下記。
npx zenn new:article --slug hogehoge
npx zenn new:book --slug hogehoge
小文字の半角英数字(a-z0-9)、ハイフン(-)、アンダースコア(_)の12〜50字の組み合わせでファイル名を指定。投稿時の名前とは関係ないので、適当でよい。
記事をプレビューするときは下記。
npx zenn preview
記事をデプロイするときは普通にgit pushすればよい。デプロイが成功したかどうかは、GitHub Actionsの画面もしくはZennの記事一覧から確認できる。
qiita-cli
記事を作るときは下記。
npx qiita new hogehoge
記事を公開するときは下記。
npx qiita publish --all // 全ての記事を公開
npx qiita publish hogehoge // 特定の記事を公開
わからなくなったときは
参考文献からリポジトリのREADMEを読むのが早いが、helpコマンドもあるので、それを使うとよい。
npx zenn help
npx qiita help
おわりに
同じリポジトリで管理するの、そんなに難しくないかもしれない。
ついでに私はNotionから移行してきた記事用のフォルダーと、記事内の画像を管理するフォルダーも同じリポジトリに入れている。ついでに登壇時のスライドもMarpで作成しているので、それも同じリポジトリに入れている。これで、一つのリポジトリで記事、画像、スライドを管理できるようになった。良き良き。
参考文献
Discussion