-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[TASK] Add some readme and a litte documentation
- Loading branch information
1 parent
b9ac4cb
commit fb62a41
Showing
3 changed files
with
38 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,28 @@ | ||
## Installation | ||
|
||
1. Install Classify from the `Tools > Addons` section of your control panel, or via composer: | ||
|
||
``` | ||
composer require visuellverstehen/statamic-classify | ||
``` | ||
## Configuration | ||
|
||
After installation there will be a [classify.php](config/classify.php) file in the `config` folder. | ||
To add or change stylesets simply add or change an array with classes that should be added to the HTML Tag. | ||
|
||
## Usage | ||
|
||
To apply the classes to the HTML Tags you have to pipe the content through the modifier. | ||
|
||
If you don't give a special styleset the default styleset will be applied. | ||
``` | ||
{{ text | classify }} | ||
``` | ||
|
||
If you want to apply a special styleset wich is named `blog` you have to use the following. | ||
|
||
``` | ||
{{ text | classify:blog }} | ||
``` | ||
|
||
If you provide a styleset wich is not configured you will get the HTML Tag back without any changes. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,7 @@ | ||
[![Actions](https://github.com/visuellverstehen/statamic-classify/workflows/Tests/badge.svg)](https://github.com/visuellverstehen/statamic-classify/actions) | ||
[![Downloads](https://img.shields.io/packagist/dt/visuellverstehen/statamic-classify.svg)](https://packagist.org/packages/visuellverstehen/statamic-classify) | ||
|
||
# Statamic-Classify | ||
|
||
This addon lets you easily create sylesets which you can then apply to HTML tags coming from the Bard Editor. | ||
|
||
## [Documentation](DOCUMENTATION.md) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters