search

javalin / website

Javalin website source code
https://javalin.io
36 stars 87 forks source link

`javalin-rendering` integration docs are outdated #262

Closed dzikoysk closed 5 months ago

dzikoysk commented 5 months ago

Current documentation is outdated and a bit confusing for users:

  1. It still refers to the old approach of registering the template engine, e.g: JavalinFreemarker.init instead of cfg.fileRenderer(new JavalinFreemarker()
  2. References non-existing JavalinRenderer class: JavalinRenderer.register
  3. It mentions file extensions, but it looks like it doesn't really matter. Once file renderer is properly registered, like e.g. JavlinMustache, it'll also process other file extensions, because we have just one global FileRenderer. It might be a good idea to clarify this + mention, that FileRenderer can be implemented by user to e.g. support 2 template engines at the same time.
jbuhacoff commented 5 months ago

Thanks for opening this issue, making these edits will help new users get started faster.

tipsy commented 5 months ago

😩

I'll do it.

tipsy commented 5 months ago

Commit: https://github.com/javalin/javalin.github.io/commit/73ff0d07212abd98131f8895d2951041d20795a8 New docs: https://javalin.io/plugins/rendering

@jbuhacoff @dzikoysk how does this look?