From f8adf5b1ef04657a807d3c8e36f66975adc666b0 Mon Sep 17 00:00:00 2001 From: cm-dyoshikawa Date: Mon, 27 Oct 2025 15:24:25 +0900 Subject: [PATCH 1/3] docs: update zenn-editor and zenn-cli guides with new commands and file management instructions --- docs/guides/zenn-editor/index.md | 7 ++++++- docs/guides/zenn-editor/zenn-cli.md | 20 +++++++++++++------- 2 files changed, 19 insertions(+), 8 deletions(-) diff --git a/docs/guides/zenn-editor/index.md b/docs/guides/zenn-editor/index.md index 3b12993..2bc3e02 100644 --- a/docs/guides/zenn-editor/index.md +++ b/docs/guides/zenn-editor/index.md @@ -24,9 +24,14 @@ pnpm のインストールには corepack を使用することを推奨しま corepack を使用しない場合は、corepack の[インストール方法](https://pnpm.io/ja/installation)を参照してインストールしてください。 ::: - 同様に、テストやビルドもプロジェクトのルートで `pnpm test`、`pnpm build` を実行することで、`./packages` にある全てのプロジェクトに対して行うことができます。これは依存するモジュールに対するテストや動作確認をしたい時に便利です。 +AIコーディングエージェント向けのファイル管理には[rulesync](https://github.com/dyoshikawa/rulesync)を使用しています。次のコマンドを実行することで、主要なAIコーディングエージェントに対応した設定ファイルが生成されます。 + +```bash +npx rulesync generate +``` + ## ブランチ - `canary`: 開発用のブランチです。新しいブランチを作る場合は、`canary`ブランチから作成します。`canary`の最新は `X.Y.Z-alpha.0` のようなバージョン指定または `@canary` でインストールすることができます。 diff --git a/docs/guides/zenn-editor/zenn-cli.md b/docs/guides/zenn-editor/zenn-cli.md index aa5d63b..a843da4 100644 --- a/docs/guides/zenn-editor/zenn-cli.md +++ b/docs/guides/zenn-editor/zenn-cli.md @@ -26,15 +26,15 @@ zenn-cli は記事や本のテンプレートを作成するコマンドツー ### その他のコマンドを開発環境で動かす -`pnpm build` でビルドを実行したうえで、`pnpm exec:zenn **` コマンドを実行します。 +`pnpm build` でビルドを実行したうえで、`pnpm -C ./packages/zenn-cli exec:zenn **` コマンドを実行します。 ```shell $ pnpm build -$ pnpm exec:zenn # = npx zenn -$ pnpm exec:zenn preview # = npx zenn preview (.mdの変更に伴うホットリロードも有効になります) -$ pnpm exec:zenn new:article --slug foo-bar-baz-qux # = npx zenn new:article --slug foo-bar-baz-qux -$ pnpm exec:zenn new:book --slug foo-bar-baz-qux # = npx zenn new:book --slug foo-bar-baz-qux -$ pnpm exec:zenn --help # = npx zenn --help +$ pnpm -C ./packages/zenn-cli exec:zenn # = npx zenn +$ pnpm -C ./packages/zenn-cli exec:zenn preview # = npx zenn preview (.mdの変更に伴うホットリロードも有効になります) +$ pnpm -C ./packages/zenn-cli exec:zenn new:article --slug foo-bar-baz-qux # = npx zenn new:article --slug foo-bar-baz-qux +$ pnpm -C ./packages/zenn-cli exec:zenn new:book --slug foo-bar-baz-qux # = npx zenn new:book --slug foo-bar-baz-qux +$ pnpm -C ./packages/zenn-cli exec:zenn --help # = npx zenn --help ``` ### 環境変数を設定する @@ -42,6 +42,12 @@ $ pnpm exec:zenn --help # = npx zenn --help zenn-cli ではビルドに必要な情報の一部を環境変数で設定します。 開発中に全ての機能を使いたい場合は、`./packages/zenn-cli/.env` ファイルを作成し以下のように設定します。 +```bash +cp ./packages/zenn-cli/.env.example ./packages/zenn-cli/.env +``` + +内容は以下のようになります。 + ```bash # 埋め込みサーバーのオリジン(viteにも対応するために`VITE_`をつけてます) VITE_EMBED_SERVER_ORIGIN="https://embed.zenn.studio" @@ -61,7 +67,7 @@ $ pnpm build ### webpackの使用について -zenn-cli では、依存関係（package.json の dependencies）を無くすため [webpack](https://webpack.js.org) でバンドルしたファイルをリリースしています。 +zenn-cli では、依存関係（package.json の dependencies）を無くすため [webpack](https://webpack.js.org)互換の[rspack](https://rspack.rs/)でバンドルしたファイルをリリースしています。 依存関係を無くす理由は以下の通りです。 From 48d8cdc36087dbc47548691b774a5cf2bb2c6fb8 Mon Sep 17 00:00:00 2001 From: cm-dyoshikawa Date: Mon, 27 Oct 2025 15:29:17 +0900 Subject: [PATCH 2/3] docs: add verification section for zenn-cli dependencies in zenn-editor guide --- docs/guides/zenn-editor/index.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/guides/zenn-editor/index.md b/docs/guides/zenn-editor/index.md index 2bc3e02..806a6f0 100644 --- a/docs/guides/zenn-editor/index.md +++ b/docs/guides/zenn-editor/index.md @@ -77,3 +77,8 @@ zenn-editor では、ビルドやテストなどを実行する時に使用し [lerna](https://lerna.js.org/) から `version` と `publish` 機能だけを抜き出したバージョン管理ツールです。 基本的な使い方は lerna と一緒ですが、多くの Monorepo 機能はデフォルトでは含まれていないことに注意してください。 zenn-editor では、workspace をリリースする際に使用しています。 + +## 動作確認 + +- `zenn-cli` は `zenn-content-css` `zenn-embed-elements` `zenn-markdown-html` `zenn-model` に依存しているため、 `zenn-cli` の動作確認をすることで、これらのパッケージの動作確認も行うことができます。 + - `zenn-cli` の動作確認方法は [zenn-cli](./zenn-cli.md) を参照してください。 From 081f5fec64d1f4c7d0e913a235a13fb98ca917cd Mon Sep 17 00:00:00 2001 From: cm-dyoshikawa <94024734+cm-dyoshikawa@users.noreply.github.com> Date: Mon, 27 Oct 2025 18:13:31 +0900 Subject: [PATCH 3/3] Update docs/guides/zenn-editor/zenn-cli.md Co-authored-by: Yusuke Wada --- docs/guides/zenn-editor/zenn-cli.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/guides/zenn-editor/zenn-cli.md b/docs/guides/zenn-editor/zenn-cli.md index a843da4..6f0c138 100644 --- a/docs/guides/zenn-editor/zenn-cli.md +++ b/docs/guides/zenn-editor/zenn-cli.md @@ -29,6 +29,7 @@ zenn-cli は記事や本のテンプレートを作成するコマンドツー `pnpm build` でビルドを実行したうえで、`pnpm -C ./packages/zenn-cli exec:zenn **` コマンドを実行します。 ```shell +# すべてプロジェクトルートで実行 $ pnpm build $ pnpm -C ./packages/zenn-cli exec:zenn # = npx zenn $ pnpm -C ./packages/zenn-cli exec:zenn preview # = npx zenn preview (.mdの変更に伴うホットリロードも有効になります)