@makoojs/create-makoo

The project scaffold for Makoo. Answer a few questions and you get a userscript project that runs right away: the Vite config, dev commands, and an example component are all ready.

Usage

pnpm dlx @makoojs/create-makoo

You can also use npx @makoojs/create-makoo or yarn dlx @makoojs/create-makoo.

The scaffold asks, in order, for the project name, userscript name, version, namespace, and match URLs, then lets you choose TypeScript or JavaScript and Vue or React, and finally asks whether to install dependencies right away.

After it finishes:

cd makoo-project
pnpm dev

Open the address printed in the terminal in your browser and install the dev script, then visit a matching page, and you'll see the example component.

[!NOTE] When the target directory already exists and isn't empty, the scaffold lets you cancel, remove the existing files and continue, or keep the existing files and continue.

Documentation

• Quick Start: from creating a project to seeing your first component on a web page.
• Tutorial: A Toggleable Tool Panel: build a complete small feature on top of the generated project.