superbig / craft-entry-instructions
A simple fieldtype to add instructions
Installs: 101 095
Dependents: 2
Suggesters: 0
Security: 0
Stars: 17
Watchers: 1
Forks: 4
Open Issues: 0
Type:craft-plugin
Requires
- craftcms/cms: ^3.0.0-RC1
- sabberworm/php-css-parser: ^8.2.0|^8.1.0
README
A simple fieldtype to add instructions.
Requirements
This plugin requires Craft CMS 3.0.0-beta.23 or later.
Installation
To install the plugin, follow these instructions.
-
Open your terminal and go to your Craft project:
cd /path/to/project
-
Then tell Composer to load the plugin:
composer require superbig/craft-entry-instructions
-
In the Control Panel, go to Settings → Plugins and click the “Install” button for Entry Instructions.
Using Entry Instructions
Create a new Entry Instructions field with instructions, and add it to a field layout.
You may add custom per-field CSS in the field settings; any CSS you add will be automatically scoped to the correct field.
Instructions will be parsed with Markdown.
Overriding Global CSS
You can override the global CSS by creating a file in your config/
directory called entry-instructions.php
and structuring it appropriately.
A sample can be found here (entry-instructions.php.sample) with the current defaults; copy it and modify or delete as you wish.
Credits
This fieldtype is a port of Entry Instructions by Tom Cunningham.
Icon by Ho Thi Ngoc Trinh from the Noun Project.
Brought to you by Superbig