visionbites / kirby-atai
A Kirby field plugin to generate alternative text for images using alttext.ai
Installs: 9
Dependents: 0
Suggesters: 0
Security: 0
Stars: 0
Watchers: 0
Forks: 0
Open Issues: 1
Type:kirby-plugin
Requires
README
A Kirby field plugin to generate alternative text for images using alttext.ai.
You need to have and enter a valid API-Key
Install
Download Zip file
Copy plugin folder into site/plugins
Composer
composer require visionbites/kirby-atai
Usage
Add a field atai
to your image blueprint where you want to enter the alternative text.
Example
Basic setup:
fields: alt: type: atai label: Alternative text
Options
there are only two options at the moment:
Option | Default | Description |
---|---|---|
api_key |
null |
Your api key for alttext.ai |
reference |
null |
a reference to that is sent to alttext.ai with the metadata. Can be used e.g. to track usage |
is_reachable |
false |
if the site is reachable from the internet. If yes only the images Url will be posted to alttext.ai. If not the whole image will be posted. |
set the options in config.php
:
return [ 'visionbites.kirby-atai' => [ 'api_key' => 'XXX', 'reference' => 'my-project', 'is_reachable' => false, ] ];
todos
- add option to pass tags
- add option to pass manufacturer and product data
- implement an option to batch process images
- implement an info section to get usage information
License
It is discouraged to use this plugin in any project that promotes racism, sexism, homophobia animal abuse, violence or any other form of hate speech.