|
3 | 3 | <!-- TODO add playground demo link --> |
4 | 4 |
|
5 | 5 | ## Overview |
6 | | -A collection of rich text formats for WordPress that enhance the block editor with interactive elements, starting with InfoTip tooltips and Marker highlights. More in the future! |
| 6 | +A collection of rich text formats for the WordPress block editor with interactive elements. Starting with InfoTip tooltips and Marker highlights. More to come in the future! |
7 | 7 |
|
8 | | -## Features |
9 | | - |
10 | | -### 🎯 Marker Format |
11 | | -- **Text Highlighting**: Emphasize important content with customizable markers |
12 | | -- **Visual Styling**: Multiple marker animations, styles and colors. |
13 | | -- **Easy Integration**: Simple toolbar button integration in the block editor |
14 | | - |
15 | | -### 🔍 InfoTip Format |
16 | | -- **Interactive Tooltips**: Add contextual information that appears on hover or click |
17 | | -- **Customizable Appearance**: Control background color, text color, and placement |
18 | | -- **Flexible Positioning**: 12 placement options (top, bottom, left, right with start/end variants) |
19 | | -- **Smart Placement**: Automatic fallback positioning to ensure tooltips stay visible |
20 | | -- **Responsive Design**: Works seamlessly across desktop and mobile devices |
| 8 | +## Requirements |
| 9 | +- WordPress 6.6+ |
| 10 | +- Modern browser with JavaScript enabled |
| 11 | +- Floating UI library (included) |
21 | 12 |
|
22 | 13 |
|
23 | 14 | ## Installation |
24 | 15 |
|
25 | | -1. Download the latest release zip file from GitHub <!--TODO - GH link to be added for release --> |
26 | | -2. Upload to your WordPress `/wp-content/plugins/` directory |
27 | | -3. Activate the plugin through the 'Plugins' menu in WordPress |
28 | | -4. Start using the new formats in your block editor |
| 16 | +1. Download the latest release from GitHub <!--TODO - GH link to be added for release --> |
| 17 | +2. Browse to `WP Admin > Plugins > Add New` |
| 18 | +3. Upload the `blablablocks-formats.zip` file |
| 19 | +4. Activate `BlaBlaBlocks Formats` from the plugins page |
29 | 20 |
|
30 | 21 | ## Usage |
31 | 22 |
|
32 | 23 | ### InfoTip Format |
33 | 24 |
|
| 25 | +<!-- TODO - add recording --> |
| 26 | + |
34 | 27 | 1. Select any text in the block editor |
35 | 28 | 2. Click the InfoTip button in the formatting toolbar |
36 | 29 | 3. Configure your tooltip with custom text, colors, and overlay placement |
37 | 30 |
|
38 | 31 |
|
39 | 32 | ### Marker Format |
40 | 33 |
|
| 34 | +<!-- TODO - add recording --> |
| 35 | + |
41 | 36 | 1. Select text you want to highlight |
42 | 37 | 2. Click the Marker button in the formatting toolbar |
43 | 38 | 3. Choose your preferred highlighting style and animation |
44 | 39 |
|
45 | | -## Technical Details |
46 | 40 |
|
47 | | -### Requirements |
48 | | -- WordPress 5.0+ |
49 | | -- Modern browser with JavaScript enabled |
50 | | -- Floating UI library (included) |
| 41 | +## Development |
51 | 42 |
|
52 | | -### Technologies Used |
53 | | -- **WordPress Block Editor API**: Native integration with Gutenberg via the [Rich Text API](https://developer.wordpress.org/block-editor/reference-guides/packages/packages-rich-text/). |
54 | | -- **Floating UI**: Advanced positioning system for tooltips |
55 | | -- **Web Components**: Custom elements for frontend rendering |
56 | | -- **React**: Editor interface components |
57 | | -- **SCSS**: Modular styling system |
| 43 | +### 1. Clone the repository |
| 44 | +Clone the repository to your local system: |
58 | 45 |
|
| 46 | +```bash |
| 47 | +git clone git@github.com:lubusIN/blablablocks-formats.git |
| 48 | +``` |
59 | 49 |
|
60 | | -## Development |
| 50 | +### 2. Go to the plugin folder |
61 | 51 |
|
62 | | -### Building the Plugin |
| 52 | +```bash |
| 53 | +cd blablablocks-formats |
| 54 | +``` |
| 55 | + |
| 56 | +### 3. Install dependencies |
63 | 57 |
|
64 | 58 | ```bash |
65 | | -# Install dependencies |
66 | 59 | npm install |
| 60 | +``` |
67 | 61 |
|
68 | | -# Build |
69 | | -npm run build |
| 62 | +### 4. Build plugin |
| 63 | +Build or start the development environment: |
| 64 | + |
| 65 | +```bash |
| 66 | +npm run build # Compile the source files |
| 67 | +# OR |
| 68 | +npm run start # Watch for changes and auto-compile |
| 69 | +``` |
| 70 | +### 5. Launch Playground |
70 | 71 |
|
71 | | -# Watch for changes |
72 | | -npm run start |
| 72 | +```bash |
| 73 | +npm run serve |
73 | 74 | ``` |
74 | 75 |
|
75 | | -## Contributing |
| 76 | +## Meet Your Artisans |
76 | 77 |
|
77 | | -1. Fork the repository |
78 | | -2. Create a feature branch (`git checkout -b feature/amazing-feature`) |
79 | | -3. Commit your changes (`git commit -m 'Add amazing feature'`) |
80 | | -4. Push to the branch (`git push origin feature/amazing-feature`) |
81 | | -5. Open a Pull Request |
| 78 | +[LUBUS](http://lubus.in) is a web design agency based in Mumbai. |
82 | 79 |
|
83 | | -## Changelog |
| 80 | +<a href="https://cal.com/lubus"> |
| 81 | +<img src="https://raw.githubusercontent.com/lubusIN/.github/refs/heads/main/profile/banner.png" /> |
| 82 | +</a> |
84 | 83 |
|
85 | | -### 1.0.0 |
86 | | -- Initial release |
87 | | -- InfoTip format with advanced positioning |
88 | | -- Marker format for text highlighting |
89 | | -- Web Components for frontend rendering |
90 | | -- Comprehensive editor integration |
| 84 | +## Credits |
| 85 | +<!-- TODO check if this works after repo is made public -->L |
| 86 | +<a href="https://github.com/lubusIN/blablablocks-formats/graphs/contributors"> |
| 87 | + <img height="36px" src="https://contrib.rocks/image?repo=lubusIN/blablablocks-formats"/> |
| 88 | +</a> |
91 | 89 |
|
92 | | -## Support |
| 90 | +* [Marker](https://thenounproject.com/icon/marker-7644139/) icon by [Amir Ali](https://thenounproject.com/amirali) from [Noun Project](https://thenounproject.com/browse/icons/term/marker/) (CC BY 3.0) |
93 | 91 |
|
94 | | -For support, feature requests, or bug reports, please open an issue on the project repository. |
95 | 92 |
|
96 | 93 | ## License |
97 | 94 |
|
98 | 95 | This project is licensed under the MIT license. |
99 | 96 |
|
100 | | -## Credits |
101 | | - |
102 | | -* [Marker](https://thenounproject.com/icon/marker-7644139/) icon by [Amir Ali](https://thenounproject.com/amirali) from [Noun Project](https://thenounproject.com/browse/icons/term/marker/) (CC BY 3.0) |
0 commit comments