Zenn Cli をインストール

Zenn CLIとは

Zenn CLIはローカル環境でZenn用の記事やブックを執筆するためのツールです。好きなエディタで執筆し、GitHubリポジトリと連携することでコンテンツを管理できます。

インストール手順

Zenn CLIを使うにはNode.jsが必要です。まだインストールしていない場合は先にインストールしておきましょう。

# npmでインストール
npm init --yes # package.jsonがない場合は初期化
npm install zenn-cli

初期化と記事の作成

# コンテンツ管理用のディレクトリを初期化
npx zenn init

# 新しい記事を作成
npx zenn new:article

初期化するとarticlesやbooksなどのディレクトリが作成されます。記事を作成すると、articlesディレクトリにMarkdownファイルが生成されます。

プレビュー

記事を書きながらプレビューで確認できます。以下のコマンドでローカルサーバーが起動します。

npx zenn preview

ブラウザでhttp://localhost:8000にアクセスすると、リアルタイムでプレビューが表示されます。

デプロイ

GitHubリポジトリと連携している場合は、変更をpushするだけで自動的に反映されます。公開設定は記事の先頭部分にpublished: trueと設定することで行います。

重要

このとき必ず「Only select repositories」にチェックを入れて、連携するリポジトリだけを選ぶようにしてください。
と書かれていたのですが、そのまま勢いで全部追加してしまわないよう注意してください。。