Skip to content

Commit f8adf5b

Browse files
committed
docs: update zenn-editor and zenn-cli guides with new commands and file management instructions
1 parent 6852841 commit f8adf5b

File tree

2 files changed

+19
-8
lines changed

2 files changed

+19
-8
lines changed

docs/guides/zenn-editor/index.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,14 @@ pnpm のインストールには corepack を使用することを推奨しま
2424
corepack を使用しない場合は、corepack の[インストール方法](https://pnpm.io/ja/installation)を参照してインストールしてください。
2525
:::
2626

27-
2827
同様に、テストやビルドもプロジェクトのルートで `pnpm test``pnpm build` を実行することで、`./packages` にある全てのプロジェクトに対して行うことができます。これは依存するモジュールに対するテストや動作確認をしたい時に便利です。
2928

29+
AIコーディングエージェント向けのファイル管理には[rulesync](https://github.com/dyoshikawa/rulesync)を使用しています。次のコマンドを実行することで、主要なAIコーディングエージェントに対応した設定ファイルが生成されます。
30+
31+
```bash
32+
npx rulesync generate
33+
```
34+
3035
## ブランチ
3136

3237
- `canary`: 開発用のブランチです。新しいブランチを作る場合は、`canary`ブランチから作成します。`canary`の最新は `X.Y.Z-alpha.0` のようなバージョン指定または `@canary` でインストールすることができます。

docs/guides/zenn-editor/zenn-cli.md

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -26,22 +26,28 @@ zenn-cli は記事や本のテンプレートを作成するコマンドツー
2626

2727
### その他のコマンドを開発環境で動かす
2828

29-
`pnpm build` でビルドを実行したうえで、`pnpm exec:zenn **` コマンドを実行します。
29+
`pnpm build` でビルドを実行したうえで、`pnpm -C ./packages/zenn-cli exec:zenn **` コマンドを実行します。
3030

3131
```shell
3232
$ pnpm build
33-
$ pnpm exec:zenn # = npx zenn
34-
$ pnpm exec:zenn preview # = npx zenn preview (.mdの変更に伴うホットリロードも有効になります)
35-
$ pnpm exec:zenn new:article --slug foo-bar-baz-qux # = npx zenn new:article --slug foo-bar-baz-qux
36-
$ pnpm exec:zenn new:book --slug foo-bar-baz-qux # = npx zenn new:book --slug foo-bar-baz-qux
37-
$ pnpm exec:zenn --help # = npx zenn --help
33+
$ pnpm -C ./packages/zenn-cli exec:zenn # = npx zenn
34+
$ pnpm -C ./packages/zenn-cli exec:zenn preview # = npx zenn preview (.mdの変更に伴うホットリロードも有効になります)
35+
$ pnpm -C ./packages/zenn-cli exec:zenn new:article --slug foo-bar-baz-qux # = npx zenn new:article --slug foo-bar-baz-qux
36+
$ pnpm -C ./packages/zenn-cli exec:zenn new:book --slug foo-bar-baz-qux # = npx zenn new:book --slug foo-bar-baz-qux
37+
$ pnpm -C ./packages/zenn-cli exec:zenn --help # = npx zenn --help
3838
```
3939

4040
### 環境変数を設定する
4141

4242
zenn-cli ではビルドに必要な情報の一部を環境変数で設定します。
4343
開発中に全ての機能を使いたい場合は、`./packages/zenn-cli/.env` ファイルを作成し以下のように設定します。
4444

45+
```bash
46+
cp ./packages/zenn-cli/.env.example ./packages/zenn-cli/.env
47+
```
48+
49+
内容は以下のようになります。
50+
4551
```bash
4652
# 埋め込みサーバーのオリジン(viteにも対応するために`VITE_`をつけてます)
4753
VITE_EMBED_SERVER_ORIGIN="https://embed.zenn.studio"
@@ -61,7 +67,7 @@ $ pnpm build
6167

6268
### webpackの使用について
6369

64-
zenn-cli では、依存関係(package.json の dependencies)を無くすため [webpack](https://webpack.js.org) でバンドルしたファイルをリリースしています。
70+
zenn-cli では、依存関係(package.json の dependencies)を無くすため [webpack](https://webpack.js.org)互換の[rspack](https://rspack.rs/)でバンドルしたファイルをリリースしています。
6571

6672
依存関係を無くす理由は以下の通りです。
6773

0 commit comments

Comments
 (0)