Deuxfleurs/alps
23
1
Fork 0
Code Issues Pull requests 1 Projects Releases Wiki Activity

docs/themes-and-plugins: extract from README

Browse source
This commit is contained in:
Simon Ser 2020-02-11 17:42:10 +01:00
parent 02b59bc365
commit 0a56365672
No known key found for this signature in database
GPG key ID: 0FDE7BE0E88F5E48
2 changed files with 32 additions and 39 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

39
README.md
View file

@ -16,45 +16,6 @@ To manually specify upstream servers:
See `docs/cli.md` for more information.
## Themes
They should be put in `themes/<name>/`.
Templates in `themes/<name>/*.html` override default templates in plugins.
Assets in `themes/<name>/assets/*` are served by the HTTP server at
`/themes/<name>/assets/*`.
## Plugins
Plugins can be written in Go or in Lua and live in `plugins/<name>/`.
Plugins can provide their own templates in `plugins/<name>/public/*.html`.
Assets in `plugins/<name>/public/assets/*` are served by the HTTP server at
`/plugins/<name>/assets/*`.
### Go plugins
They can use the [Go plugin helpers] and need to be included at compile-time in
`cmd/koushin/main.go`.
### Lua plugins
The entry point is at `plugins/<name>/main.lua`.
API:
* `koushin.on_render(name, f)`: prior to rendering the template `name`, call
`f` with the template data (the special name `*` matches all templates)
* `koushin.set_filter(name, f)`: set a template function
* `koushin.set_route(method, path, f)`: register a new HTTP route, `f` will be
called with the HTTP context
## Hot reload
Lua plugins and templates can be reloaded by sending `SIGUSR1` to koushin.
killall -USR1 koushin
## Contributing
Send patches on the [mailing list], report bugs on the [issue tracker].

32
docs/themes-and-plugins.md Normal file
View file

@ -0,0 +1,32 @@
# Themes
They should be put in `themes/<name>/`.
Templates in `themes/<name>/*.html` override default templates in plugins.
Assets in `themes/<name>/assets/*` are served by the HTTP server at
`/themes/<name>/assets/*`.
# Plugins
Plugins can be written in Go or in Lua and live in `plugins/<name>/`.
Plugins can provide their own templates in `plugins/<name>/public/*.html`.
Assets in `plugins/<name>/public/assets/*` are served by the HTTP server at
`/plugins/<name>/assets/*`.
## Go plugins
They can use the [Go plugin helpers] and need to be included at compile-time in
`cmd/koushin/main.go`.
## Lua plugins
The entry point is at `plugins/<name>/main.lua`.
API:
* `koushin.on_render(name, f)`: prior to rendering the template `name`, call
`f` with the template data (the special name `*` matches all templates)
* `koushin.set_filter(name, f)`: set a template function
* `koushin.set_route(method, path, f)`: register a new HTTP route, `f` will be
called with the HTTP context