Now that all templates are provided by plugins, there's no need to have
a public/ directory. Themes can be in /themes instead of /public/themes.

2019-12-16 12:58:21 +01:00

1.2 KiB

Raw Blame History

koushin

Usage

go run ./cmd/koushin imaps://mail.example.org:993 smtps://mail.example.org:465

See -h 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

Lua plugins are supported. They can be dropped in plugins/<name>/main.lua.

API:

koushin.on_render(name, f): prior to rendering the template name, call f with the template data
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

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/*.

Contributing

Send patches on the mailing list, report bugs on the issue tracker.

License

MIT

1.2 KiB Raw Blame History