darkwiiplayer/glass
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Mention dependencies in readme

Browse source
This commit is contained in:
Talia 2022-09-26 12:53:45 +02:00
parent 4e363f2180
commit a69e0101bf
1 changed files with 4 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
readme.md
View file

@ -29,16 +29,18 @@ Glass offers the following loaders out of the box:
* `cosmo` loads cosmo templates * `cosmo` loads cosmo templates
* `discount` loads markdown files\*. * `discount` loads markdown files\*.
* `environment` loads environment variables. * `environment` loads environment variables.
* `json` loads a JSON file as a Lua table. * `json` loads a JSON file as a Lua table. (requires `cjson`)
* `lua` loads and executes a Lua file. * `lua` loads and executes a Lua file.
* `moonhtml` loads a MoonHTML template and returns it as a function. * `moonhtml` loads a MoonHTML template and returns it as a function.
* `readfile` loads a file as a string. * `readfile` loads a file as a string.
* `skooma` loads a skooma template and returns it as a function. * `skooma` loads a skooma template and returns it as a function.
* `table` looks up values in a Lua table * `table` looks up values in a Lua table
* `yaml` loads a YAML file as a Lua table. * `yaml` loads a YAML file as a Lua table. (requires `lyaml`)
\* For easier interoperability with other template loaders, the `discount` loader returns a static function which can be called to return the generated HTML. The markdown file is only parsed the first time. \* For easier interoperability with other template loaders, the `discount` loader returns a static function which can be called to return the generated HTML. The markdown file is only parsed the first time.
Note that some of these loaders require additional dependencies that are not included with glass to keep the installation small.
### Custom Loaders ### Custom Loaders
A glass loader is simply a Lua function that takes as its argument a path to a A glass loader is simply a Lua function that takes as its argument a path to a