Skip to content

Commit

Permalink
Change the documentation related to the triggers section
Browse files Browse the repository at this point in the history
  • Loading branch information
HexRx committed Dec 2, 2024
1 parent 84da0ce commit 25408ce
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 6 deletions.
9 changes: 4 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
- TLS support
- Highly configurable
- Automatically create directory if it doesn't exists on the server
- Execute custom triggers on save / delete (see example usage [here](https://gist.github.com/Aiq0/790aa5f04209e5b049138445fd79c522))
- Trigger custom actions, such as run JS or CSS minification scripts, upon saving or deleting files

## How to Install

Expand Down Expand Up @@ -116,16 +116,15 @@ List of events that won't prompt you (for example if you do not want to click `D
Available events are: `"deleteFile"`, `"createFolder"`

`"triggers"` *array of triggers (objects), optional (default: `[]`)*
List of custom triggers to call when specific event happens. Each trigger can contain:
List of custom triggers to run specific scripts when a certain event occurs. For instance, you can execute scripts to minify JS or CSS files upon the occurrence of certain events. To view an example of trigger usage with [css-html-js-minify](https://github.com/juancarlospaco/css-html-js-minify) script, please refer to this [link](https://gist.github.com/Aiq0/790aa5f04209e5b049138445fd79c522).

Each trigger can contain:

* `"on"` *string* - When to call trigger (available values: `"save"` or `"delete"`).
* `"extensions"` *array of string, optional* - For which file extensions call this trigger. See `"ignoredExtension"` for more info.
* `"filenames"` *array of string, options* - For which filenames call this trigger. See `"ignoredFilenames"` for more info.
* `"execute"` *string* - Path (relative from project root) to python file to execute

See example usage of triggers [here](https://gist.github.com/Aiq0/790aa5f04209e5b049138445fd79c522)


## Contributors
- [Aiq0](https://github.com/Aiq0)
- [themiddlehalf](https://github.com/themiddlehalf)
Expand Down
3 changes: 2 additions & 1 deletion messages.json
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
{
"1.8.0": "messages/1.8.0.md"
"1.8.0": "messages/1.8.0.md",
"1.8.1": "messages/1.8.1.md"
}
4 changes: 4 additions & 0 deletions messages/1.8.1.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# 1.8.1 - Updated documentation

## Updates
* Modify the documentation related to the `triggers` section

0 comments on commit 25408ce

Please sign in to comment.