diff --git a/docs/_pages/docs/filters/nim-filters.md b/docs/_pages/docs/filters/nim-filters.md new file mode 100644 index 00000000..2cb29d7a --- /dev/null +++ b/docs/_pages/docs/filters/nim-filters.md @@ -0,0 +1,22 @@ +--- +permalink: /docs/nim-filters +layout: single +classes: wide +title: Nim Filters +sidebar: + nav: "sidebar" +--- + +The syntax for running a nim filter is this: + +```json +{ + "runWith": "nim", + "script": "./filters/example.nim" +} +``` + +## Requirements and Dependencies + +If your filter has dependencies, put a .nimble file in the same directory as your .nim file. +Documentation on how to make a .nimble file is located at https://github.com/nim-lang/nimble#creating-packages