diff --git a/docs/src/commands/build.md b/docs/src/commands/build.md index 884963b4..2305f50c 100644 --- a/docs/src/commands/build.md +++ b/docs/src/commands/build.md @@ -5,6 +5,10 @@ interoperability and for publishing a package to npm. This involves compiling your code to wasm and generating a pkg folder. This pkg folder will contain the wasm binary, a JS wrapper file, your `README`, and a `package.json` file. +The `pkg` directory is automatically `.gitignore`d by default, since it contains +build artifacts which are not intended to be checked into version +control.[0](#footnote-0) + ## Path The `wasm-pack build` command can be given an optional path argument, e.g.: @@ -85,3 +89,9 @@ wasm-pack build examples/js-hello-world --mode no-install |---------------|------------------------------------------------------------------------------------------| | `no-install` | `wasm-pack init` implicitly and create wasm binding without installing `wasm-bindgen`. | | `normal` | do all the stuffs of `no-install` with installed `wasm-bindgen`. | + +
+ +0 If you need to include additional assets in the pkg +directory and your NPM package, we intend to have a solution for your use case +soon. [↩](#wasm-pack-build) diff --git a/docs/src/commands/pack-and-publish.md b/docs/src/commands/pack-and-publish.md index 849fb3a0..0a9a4f7f 100644 --- a/docs/src/commands/pack-and-publish.md +++ b/docs/src/commands/pack-and-publish.md @@ -1,9 +1,9 @@ # pack and publish -The `publish` and `pack` commands interact with the pkg directory that's -created when you run `wasm-pack init`. The `pack` command creates a tarball -from the pkg directory and the `publish` command creates a tarball from the -pkg directory __and__ publishes it to the NPM registry. +The `publish` and `pack` commands interact with the pkg directory that's +created when you run `wasm-pack build`. The `pack` command creates a tarball +from the pkg directory and the `publish` command creates a tarball from the +pkg directory __and__ publishes it to the NPM registry. Underneath, these commands use `npm pack` and `npm publish`. You can read more about these in the NPM documentation: @@ -11,8 +11,8 @@ more about these in the NPM documentation: - [`npm pack`](https://docs.npmjs.com/cli/pack) - [`npm publish`](https://docs.npmjs.com/cli/publish) -Both these commands take the path to the pkg directory as the first argument. -You can either set the argument directly to the pkg directory or to the parent +Both these commands take the path to the pkg directory as the first argument. +You can either set the argument directly to the pkg directory or to the parent of the pkg directory: ```