vdc-editor
v0.1.34
Published
A modern WYSIWYG rich-text editor using tiptap + Vue.js for SBS
Downloads
2,310
Maintainers
Readme
Gemiso Web Editor
A powerful Vue 3 based rich text editor library with extensive features and customization options.
Tech Stack
- Vue 3 - Progressive JavaScript framework for building user interfaces
- TypeScript - Typed superset of JavaScript that compiles to plain JavaScript
- Tiptap - Headless WYSIWYG text editor framework
- Tailwind CSS - Utility-first CSS framework
- Vite - Next generation frontend tooling
- Shadcn UI - Re-usable components built with Tailwind CSS
Development
# Install dependencies
pnpm install
# Start development server
pnpm dev
# Build library
pnpm build:lib
Available Scripts
In the project directory, you can run:
Development
pnpm dev
- Starts the development server using Vitepnpm build:lib
- Builds the library for production
Code Quality
pnpm prettier
- Formats all files using Prettierpnpm lint
- Runs ESLint to check for code issuespnpm lint:fix
- Automatically fixes ESLint issues when possible
Publishing
pnpm push
- Builds the library and publishes it to npm registry
Version Management
pnpm version:patch
- Bumps patch version (0.0.x), creates git tag, and publishespnpm version:minor
- Bumps minor version (0.x.0), creates git tag, and publishespnpm version:major
- Bumps major version (x.0.0), creates git tag, and publishes
Git Hooks
pnpm prepare
- Sets up Husky for git hooks
License
Contributing
Contributions are welcome! Please feel free to submit a Pull Request.