diff --git a/docs/build-module.md b/docs/build-module.md deleted file mode 100644 index 23e394810..000000000 --- a/docs/build-module.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: 'nuxt build-module' -description: 'Nuxt command to build your Nuxt module before publishing.' -links: - - label: Source - icon: i-simple-icons-github - to: https://github.com/nuxt/module-builder/blob/main/src/cli.ts - size: xs ---- - - -```bash [Terminal] -npx nuxt build-module [ROOTDIR] [--cwd=] [--logLevel=] [--build] [--stub] [--sourcemap] [--prepare] -``` - - -The `build-module` command runs `@nuxt/module-builder` to generate `dist` directory within your `rootDir` that contains the full build for your **nuxt-module**. - -## Arguments - - -| Argument | Description | -|---------------|------------------------------------------------| -| `ROOTDIR="."` | Specifies the working directory (default: `.`) | - - -## Options - - -| Option | Default | Description | -|--------------------------------------|---------|----------------------------------------------------------------------------------| -| `--cwd=` | | Specify the working directory, this takes precedence over ROOTDIR (default: `.`) | -| `--logLevel=` | | Specify build-time log level | -| `--build` | `false` | Build module for distribution | -| `--stub` | `false` | Stub dist instead of actually building it for development | -| `--sourcemap` | `false` | Generate sourcemaps | -| `--prepare` | `false` | Prepare module for local development | - - -::read-more{to="https://github.com/nuxt/module-builder" icon="i-simple-icons-github" target="\_blank"} -Read more about `@nuxt/module-builder`. -:: diff --git a/scripts/generate-command-docs.ts b/scripts/generate-command-docs.ts index 4447a3e72..a8e10ee45 100644 --- a/scripts/generate-command-docs.ts +++ b/scripts/generate-command-docs.ts @@ -61,7 +61,7 @@ interface DocEntry { * * `build-module.md` is absent: `nuxt build-module` is not a registered command, * it resolves the `@nuxt/module-builder` binary through the `nuxt-` - * fallback, so its flags are declared in another repository. + * fallback, and that repository now owns the command page. */ const DOCS: DocEntry[] = [ { id: 'add', file: 'add.md', command: ['add'] },