zenn-template-cli

毎回同じ構成を手作業で書くのはもうやめよう!!

Zennの記事にテンプレートを差し込んで、執筆をスピードアップできるCLIツールです。

目的

• 新規作成した Zenn 記事に、テンプレートを簡単に差し込める
• 構成の統一や執筆準備の手間を削減
• 記事の中身に集中できる環境を提供

「毎回構成を考えるのが大変」「フォーマットを統一したい」といった悩みを、コマンド一発で解決します。

インストール方法

npm install zenn-template-cli

使い方

Zenn 記事へのテンプレート適用は、次の3ステップで完了します。

1. テンプレートの準備
2. コマンドの実行
3. オプションで柔軟に制御（任意）

テンプレートの準備

テンプレートは templates ディレクトリ内に .md ファイルとして保存してください。 テンプレートファイル名は --template オプションで指定する名前と一致させるか、コマンド実行時に選択できます。

例：

your-project/
├── articles/
│   └── sample-article.md
├── templates/
│   └── basic.md

コマンド実行

zenn-template

このコマンドを実行すると、以下の流れでテンプレートを適用できます：

• templates/ フォルダ内のテンプレート一覧が表示されます。

• 使用するテンプレートを選択します。

• articles/ フォルダ内の .md ファイルが 更新日時の新しい順 に表示されます。

• 適用対象の記事を選択します。

• テンプレートが差し込まれ、完了メッセージが表示されます ✅

✅ テンプレート basic を sample-article.md に適用しました！

オプションを使った実行例

特定のテンプレートを直接指定したい場合：

zenn-template --template=basic

記事内容をテンプレートで完全に上書きしたい場合：

zenn-template --template=basic --overwrite

💡 --template を指定した場合はテンプレート選択がスキップされます。

💥 --overwrite を付けると既存の内容が上書きされるため、注意して使ってください。

オプション一覧

| オプション | 説明 | | ------------- | ---------------------------- | | --template | 使用するテンプレート名を指定 | | --overwrite | 既存内容を上書きするモード |

動作環境

• Node.js 18以上

作者情報

Created by Yuji Nakamura

GitHub: @Yuji5117

ライセンス

このプロジェクトは MITライセンス のもとで公開されています。
自由にご利用・改変・再配布していただけますが、著作権表示とライセンス文の同梱が必要です。