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

Add explanation about custom loaders

Browse source
This commit is contained in:
Talia 2022-08-27 07:50:48 +02:00
parent 84ee3360a5
commit 55665ad013
Signed by: darkwiiplayer
GPG key ID: 7808674088232B3E
1 changed files with 12 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
readme.md
View file

@ -36,3 +36,15 @@ Glass offers the following loaders out of the box:
* `yaml` loads a YAML file as a Lua table. * `yaml` loads a YAML file as a Lua table.
\* 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.
### Custom Loaders
A glass loader is simply a Lua function that takes as its argument a path to a
file and attempts to load it into a Lua value.
Loaders will typically add an extension to the given file name before checking
whether that file exists and can be loaded.
When a loader cannot find the expected file, it should return `nil` to let glass
continue the loader chain. When a loader returns a truthy value, this will be
used and no further loaders will be tried.