Highlight Plugin for Contentstack RTE

A modern, accessible highlight text plugin for Contentstack's JSON Rich Text Editor that allows you to highlight important content with customizable styling.

✨ Features

• ⚡ Easy Integration: Simple setup with Contentstack's JSON Rich Text Editor.
• 🎯 Accessible: Designed with accessibility in mind.
• 📱 Responsive: Works seamlessly across all devices.
• 🔧 Customizable: Easily modify the highlight styles to match your brand.

📋 Prerequisites

• Node.js (v16 or higher)
• npm (v8 or higher)
• A Contentstack account

🚀 Quick Start

Installation

# Clone the repository
git clone https://github.com/contentstack/marketplace-highlight-app.git
cd marketplace-highlight-app

# Install dependencies
npm install

Development

# Start the development server
npm start

Building for Production

# Build the application for production
npm run build

# The bundled plugin will be in the `dist` directory

🏗️ Project Structure

rte-highlight-plugin/
├── src/              # Source code
│   ├── components/   # React components (if any)     # Styles for the plugin
│   ├── styles/styles.css    # Styles for the plugin
│   └── plugin.tsx    # Main plugin entry point
├── dist/             # Production build output
└── config files...   # package.json, webpack.config.js, etc.

Code Quality

• TSLint for code linting.
• Prettier for code formatting (via tslint-config-prettier).

🛠️ Development Workflow

Adding New Features

1. Create a feature branch from main.
2. Implement your changes in the src directory.
3. Add or update tests for the new functionality.
4. Update the documentation (README.md) if necessary.
5. Submit a pull request for review.

Code Style

This project uses TSLint with the Standard and Prettier configurations to enforce a consistent code style.

Commit Convention

This project follows the Conventional Commits specification.

📦 Deployment

1. Build the Plugin: Run npm run build to create the production bundle in the dist/ directory.
2. Host the Plugin: Upload the contents of the dist/ folder to a secure hosting provider.
3. Add to Contentstack: In your Contentstack stack, navigate to Settings > Extensions, and add a new Custom Field. Point the "Hosting method" to the URL where you hosted your plugin.

🤝 Contributing

We welcome contributions! Please see the following guide for details.

How to Contribute

1. Fork the repository.
2. Create a feature branch (git checkout -b feature/amazing-feature).
3. Commit your changes (git commit -m 'feat: add amazing feature').
4. Push to the branch (git push origin feature/amazing-feature).
5. Open a Pull Request.

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

🙏 Acknowledgments

• Contentstack for the amazing CMS platform.

📞 Support

• Issues: GitHub Issues
• Documentation: Contentstack Developer Hub
• Marketplace: Contentstack Marketplace App Guide
• Community: Contentstack Community

---

Made with ❤️ by the Contentstack team