Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fork/craft-embeds
Allow using Embeds within Redactor. Embeds are referenced Matrix Blocks within the Redactor body.
https://github.com/fork/craft-embeds
Last synced: 1 day ago
JSON representation
Allow using Embeds within Redactor. Embeds are referenced Matrix Blocks within the Redactor body.
- Host: GitHub
- URL: https://github.com/fork/craft-embeds
- Owner: fork
- License: mit
- Created: 2018-12-10T14:09:15.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2024-12-17T16:31:16.000Z (11 days ago)
- Last Synced: 2024-12-17T16:35:43.285Z (11 days ago)
- Language: PHP
- Size: 266 KB
- Stars: 2
- Watchers: 16
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Embeds plugin for Craft CMS 4.x
Allow using Embeds within Redactor. Embeds are referenced Matrix Blocks within the Redactor body.
## Requirements
This plugin requires Craft CMS 4.12.8 or later and the Craft Redactor plugin.
The plugin has not been tested with current Craft CMS 5.0.
## Installation
To install the plugin, follow these instructions.
1. Open your terminal and go to your Craft project:
```
cd /path/to/project
```
2. (As long as this is unreleased) Add the repository to your composer.json:
```
{
"repositories": [
{
"type": "vcs",
"url": "[email protected]:fork/craft-embeds.git"
}
]
}
```
3. Then tell Composer to load the plugin.
```
composer require fork/embeds
```
4. In the Control Panel, go to Settings → Plugins and click the “Install” button for Embeds. This will also install
Redactor if it wasn't already installed before.
5. Enable the plugin in redactor by putting it into your config/redactor/MyConfig.json (see [Embeds.json](src/config/redactor/Embeds.json))
## Embeds Overview
This plugin adds a Redactor plugin which enables editors to set markers between paragraphs in a redactor field. These
markers then work as placeholders for blocks from a matrix field (_embeds_). In the current development phase, this
plugin only supports one redactor field and one matrix field whit the names _embedsCopy_ and _embeds_. The install
migration of the plugin creates these fields automatically and also adds a Redactor configuration file for the copy
field. **Warning**: Renaming the handles of these fields breaks the plugin! The matrix field will be empty. Redactor
will be installed automatically by the install migration of this plugin.
## Configuring Embeds
Currently there are no configuration options.
## Using Embeds
Add the two fields to any of your EntryTypes' FieldLayout and don't forget to add some MatrixBlocks to the embeds field.
When you add an embed marker to the copy text and add blocks to the matrix field, the plugin will show you which embed
will appear at which placeholder.
## Embeds Roadmap
Some things to do, and ideas for potential features:
- Fix the merging of copy and embeds
- Enable using multiple fields via plugin settings
- Evaluate possibilities for adding srcsets
