diff --git a/docs/_index.md b/docs/_index.md new file mode 100644 index 0000000..5024e59 --- /dev/null +++ b/docs/_index.md @@ -0,0 +1,10 @@ +--- +title: general +geekdocFlatSection: true +--- + +General custom content collection for Ansible. + + +{{< toc-tree >}} + diff --git a/docs/filters/_index.md b/docs/filters/_index.md new file mode 100644 index 0000000..391be32 --- /dev/null +++ b/docs/filters/_index.md @@ -0,0 +1,3 @@ +--- +title: Filters +--- diff --git a/docs/filters/prefix.md b/docs/filters/prefix.md new file mode 100644 index 0000000..0887c1b --- /dev/null +++ b/docs/filters/prefix.md @@ -0,0 +1,26 @@ +Simple filter to prefix all items from a list. Default prefix will be `--` but you can also pass a custom one. + +## Example + +```Yaml +my_list: + - item1 + - item2 + +{{ my_list | prefix | join(' ') }} + +# result: +# "--item1 --item2" +``` + +Or pass a custom prefix: +```Yaml +my_list: + - item1 + - item2 + +{{ my_list | prefix(prefix='-') | join(' ') }} + +# result: +# "-item1 -item2" +``` diff --git a/docs/filters/wrap.md b/docs/filters/wrap.md new file mode 100644 index 0000000..1a1032e --- /dev/null +++ b/docs/filters/wrap.md @@ -0,0 +1,26 @@ +Simple filter to wrap all items form a list. Default will wrap items in single quotes but you can also pass a custom wrapper character. + +## Example + +```Yaml +my_list: + - item1 + - item2 + +{{ my_list | wrap | join(',') }} + +# result: +# "'item1','item2'" +``` + +Or pass a custom wrapper: +```Yaml +my_list: + - item1 + - item2 + +{{ my_list | wrap(wrapper='/') | join(',') }} + +# result: +# "/item1/,/item2/" +```