create-lexiwind
v3.1.0
Published
Scaffold production-ready Lexiwind editors with zero config
Maintainers
Readme
@lexiwind/create-lexiwind
Scaffold production-ready Lexiwind editors with zero config.
Overview
This package provides a CLI tool to quickly scaffold a new Lexiwind editor project. It sets up all necessary dependencies, configurations, and example code so you can start building rich text editors immediately.
Installation
npm install @lexiwind/create-lexiwindQuick Start
Create a new Lexiwind project:
npx @lexiwind/create-lexiwind initThis will guide you through:
- Project name and description
- Theme selection (shadcn, Tailwind, etc.)
- Plugin selection (code blocks, tables, history, etc.)
- Framework setup (React, Vue, etc.)
Commands
Init
Initialize a new Lexiwind editor project:
npx @lexiwind/create-lexiwind initAdd Plugin
Add a new plugin to an existing project:
npx @lexiwind/create-lexiwind addSelect from available plugins:
- Code blocks
- Tables
- History (undo/redo)
- Mentions
- Embeds
- Slash commands
- And more...
Add Theme
Add or change the project theme:
npx @lexiwind/create-lexiwind themeAvailable themes:
- shadcn/ui
- Tailwind CSS
- Custom themes
Features
- ✨ Zero configuration — Works out of the box
- 🎨 Theme selection — Choose from pre-built themes
- 🔌 Plugin discovery — Easily add plugins to your project
- 📦 Package management — Automatic dependency installation
- 🎯 Project generation — TypeScript + Vite by default
Project Structure
After initialization, your project will have:
my-editor/
├── src/
│ ├── components/
│ ├── hooks/
│ └── App.tsx
├── package.json
├── tsconfig.json
└── vite.config.tsLearn More
See the main Lexiwind documentation for examples and advanced configuration.
