💻

Zenn CLIを使用してコンテンツを編集する

2024/12/14に公開

Zenn CLIとは

Zenn CLI（Command Line Interface）は、ZennとGitHubリポジトリを連携させて、ローカル環境で好きなエディターを使ってZennの投稿コンテンツを作成・編集するためのツールです。

あらかじめ、下記リンクの手順で、Zennのコンテンツを編集する用のディレクトリにGitのローカルリポジトリを作成し、GitHubにPushしておきます。

下記のリンクからNode.jsをインストールしておきます。

以下のコマンドでNode.jsのバージョンが表示されれば、正しくインストールされています。

node --version

以下のコマンドでZenn CLIをインストールします。

npm init --yes
npm install zenn-cli

Zenn CLIのアップデートは以下のコマンドで行います。

npm install zenn-cli@latest

ローカル環境でZennのコンテンツを編集するためのディレクトリを作成して、そこに移動しておきます。

cd  <Zennコンテンツ編集ディレクトリ>

以下のコマンドでZenn CLIのセットアップを行います。

npm zen init

以下のコマンドを実行します。

npx zenn preview

表示されたURL（通常はhttp://localhost:8000）から、Zennの編集中のコンテンツの内容をプレビューできます。

以下のコマンドで新しいコンテンツ（記事・本）を作成します。

新しい記事を作成する

npx zenn new:article --slug <追加する記事ID>

新しい本を作成する

npx zenn new:book --slug <追加する本ID>