Skip to content

fix: zenn-cli のコマンドの間違いを修正 #4

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Feb 15, 2023
Merged

fix: zenn-cli のコマンドの間違いを修正 #4

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 9 additions & 7 deletions docs/guides/zenn-editor/zenn-cli.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,15 +26,15 @@ zenn-cli は記事や本のテンプレートを作成するコマンドツー

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

`pnpm build` でビルドを実行したうえで、`pnpm zenn **` コマンドを実行します。
`pnpm build` でビルドを実行したうえで、`pnpm exec:zenn **` コマンドを実行します。

```shell
$ pnpm build
$ pnpm zenn # = npx zenn
$ pnpm zenn preview # = npx zenn preview (.mdの変更に伴うホットリロードも有効になります)
$ pnpm zenn new:article --slug foo-bar-baz-qux # = npx zenn new:article --slug foo-bar-baz-qux
$ pnpm zenn new:book --slug foo-bar-baz-qux # = npx zenn new:book --slug foo-bar-baz-qux
$ pnpm zenn --help # = npx zenn --help
$ 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
```

## ビルド
Expand All @@ -61,4 +61,6 @@ zenn-cli では、依存関係（package.json の dependencies）を無くすた

## lint

`pnpm lint:fix` で実行します。
`pnpm lint` で実行します。
厳密にチェックしたい場合は `pnpm strict:lint` を実行します。
また、Linter などの警告を修正したい場合は `pnpm fix` を実行します。