|
1 | 1 | === Blablablocks Formats === |
2 | | -Contributors: Lubus |
3 | | -Tags: format |
4 | | -Tested up to: 6.7 |
5 | | -Stable tag: 0.1.0 |
| 2 | +Contributors: lubus, ajitbohra, punitv342, nagpai |
| 3 | +Tags: format, rich text format, BlaBlaBlocks |
| 4 | +Requires at least: 6.6 |
| 5 | +Tested up to: 6.8 |
| 6 | +Requires PHP: 7.4 |
| 7 | +Stable tag: 1.0 |
6 | 8 | License: MIT |
| 9 | +License URI: https://www.gnu.org/licenses/MIT |
7 | 10 |
|
8 | | -== Description == |
9 | | - |
10 | | -This is the long description. No limit, and you can use Markdown (as well as in the following sections). |
11 | | - |
12 | | -For backwards compatibility, if this section is missing, the full length of the short description will be used, and |
13 | | -Markdown parsed. |
14 | | - |
15 | | -== Installation == |
16 | | - |
17 | | -This section describes how to install the plugin and get it working. |
18 | | - |
19 | | -e.g. |
20 | | - |
21 | | -1. Upload the plugin files to the `/wp-content/plugins/blablablocks-formats` directory, or install the plugin through the WordPress plugins screen directly. |
22 | | -1. Activate the plugin through the 'Plugins' screen in WordPress |
23 | | - |
| 11 | +Interactive rich text formats for the WordPress block editor. |
24 | 12 |
|
25 | | -== Frequently Asked Questions == |
26 | | - |
27 | | -= A question that someone might have = |
28 | | - |
29 | | -An answer to that question. |
30 | | - |
31 | | -= What about foo bar? = |
| 13 | +== Description == |
| 14 | +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! |
32 | 15 |
|
33 | | -Answer to foo bar dilemma. |
| 16 | +=== What makes BlaBlaBlocks Formats special? === |
| 17 | +* **Simple usage** - Add interactive tooltips and animated highlights with the ease of adding any simple text format. |
| 18 | +* **More control** - A variety of customization possible in behavior, colors and animation for each format |
| 19 | +* **Editor Compatibility** – fully integrated with the Block Editor’s UI and server-side rendering pipeline. |
34 | 20 |
|
35 | 21 | == Screenshots == |
| 22 | +( TODO add screenshots ) |
36 | 23 |
|
37 | | -1. This screen shot description corresponds to screenshot-1.(png|jpg|jpeg|gif). Note that the screenshot is taken from |
38 | | -the /assets directory or the directory that contains the stable readme.txt (tags or trunk). Screenshots in the /assets |
39 | | -directory take precedence. For example, `/assets/screenshot-1.png` would win over `/tags/4.3/screenshot-1.png` |
40 | | -(or jpg, jpeg, gif). |
41 | | -2. This is the second screen shot |
| 24 | +1. **Marker settings** - Select and adjust Marker type and settings. |
| 25 | +2. **InfoTip settings** - Add InfoTip text and adjust settings. |
| 26 | +3. **Frontend view of Marker** |
| 27 | +4. **Frontend view of InfoTip** |
42 | 28 |
|
43 | | -== Changelog == |
44 | | - |
45 | | -= 0.1.0 = |
46 | | -* Release |
| 29 | +== Installation == |
| 30 | +1. Download the latest release from GitHub ( TODO - add link to latest release ) |
| 31 | +2. Browse to `WP Admin > Plugins > Add New` |
| 32 | +3. Upload the `blablablocks-formats.zip` file |
| 33 | +4. Activate `BlaBlaBlocks Formats` from the plugins page |
47 | 34 |
|
48 | | -== Arbitrary section == |
| 35 | +== Changelog == |
49 | 36 |
|
50 | | -You may provide arbitrary sections, in the same format as the ones above. This may be of use for extremely complicated |
51 | | -plugins where more information needs to be conveyed that doesn't fit into the categories of "description" or |
52 | | -"installation." Arbitrary sections will be shown below the built-in sections outlined above. |
| 37 | += 1.0.0 = |
| 38 | +* Initial release 🎉 |
| 39 | +* InfoTip format - Add customizable tooltips to any text in the editor. |
| 40 | +* Marker format - Add customizable animated or static text highlights. |
0 commit comments