create-quilltap-theme

Scaffold a new Quilltap theme plugin with a single command.

Usage

Using npm init (recommended)

npm init quilltap-theme my-theme

Using npx

npx create-quilltap-theme my-theme

Interactive mode

Run without arguments for interactive prompts:

npm init quilltap-theme

Skip prompts

Use -y or --yes to use defaults:

npm init quilltap-theme my-theme --yes

What gets created

qtap-plugin-theme-my-theme/
├── package.json          # npm package configuration
├── manifest.json         # Quilltap plugin manifest
├── tokens.json           # Theme design tokens (colors, fonts, spacing)
├── index.ts              # Plugin entry point
├── styles.css            # CSS component overrides (optional)
├── tsconfig.json         # TypeScript configuration
├── esbuild.config.mjs    # Build configuration
├── README.md             # Documentation
├── .gitignore            # Git ignore rules
├── docs/                 # Development documentation
│   └── THEME_PLUGIN_DEVELOPMENT.md
└── .storybook/           # Storybook setup (optional)
    ├── main.ts
    ├── preview.ts
    └── ThemeProvider.tsx

Options

| Option | Description | |--------|-------------| | -y, --yes | Skip prompts and use default values | | -h, --help | Show help message |

Interactive prompts

When run without --yes, you'll be asked:

1. Theme name - e.g., "sunset", "ocean-breeze"
2. Description - Brief description of your theme
3. Author name - Your name
4. Author email - Your email
5. Primary color - Main theme color in HSL format
6. Include CSS overrides? - Whether to create styles.css
7. Include Storybook? - Whether to set up Storybook for development

Next steps after scaffolding

cd qtap-plugin-theme-my-theme
npm install
npm run build

To preview in Storybook (if included):

npm run storybook

To publish:

npm publish --access public

Documentation

Every scaffolded theme includes a complete development guide at docs/THEME_PLUGIN_DEVELOPMENT.md.

For the latest online documentation:

• Theme Plugin Development Guide
• Plugin Manifest Reference
• @quilltap/theme-storybook

License

MIT