create-notion-widget

Create a workspace for building Notion widgets with React. Requires Node.js 22.18 or later.

pnpm create notion-widget my-widgets
cd my-widgets
pnpm install
pnpm dev

Omit the directory argument to create a workspace in the current directory. The initializer stops if a target file already exists to avoid overwriting it.

pnpm create notion-widget my-widgets --install

--install installs dependencies with the package manager that invoked the command. It supports pnpm, npm, Yarn, and Bun, and falls back to pnpm if the package manager cannot be detected. Follow-up commands use the same package manager. You can also use npm create notion-widget@latest, yarn create notion-widget, or bun create notion-widget.

| Option | Purpose | | --- | --- | | [directory] | Workspace directory; defaults to the current directory | | --install | Install dependencies after creating the workspace | | --help, -h | Show usage instructions | | --version, -v | Show the version |

A new workspace includes a greeting widget, package.json, TypeScript configuration, and AGENTS.md and CLAUDE.md pointers to node_modules/notion-widget/docs/README.md. Workspace scripts invoke the daily notion-widget dev, build, check, and preview commands.

This package only initializes workspaces and has no runtime package dependencies. The workspace's installed notion-widget package provides the framework, public APIs, and versioned documentation. Both packages share the same release version.