README
¶
GinT
GinT is an HTML template plug-in for the great Gin framework. It is somewhat opinionated about how templates are organized and rendered, but in exchange you won't have to write a lot of boilerplate code.
Getting Started
// example.go
import (
"github.com/gin-gonic/gin"
"github.com/janek-bieser/gint"
)
func main() {
r := gin.Default()
// create the renderer and plug it into the gin framework
r.HTMLRender = gint.NewHTMLRender()
r.GET("/", func(c *gin.Context){
c.HTML(http.StatusOK, "home", gin.H{"title": "Test"})
})
r.Run()
}
<!-- templates/layout.tmpl -->
<html>
<head>
<title>{{ .title }}</title>
</head>
<body>
<h1>Example</h1>
{{ template "content" . }}
<body>
</html>
<!-- templates/home.tmpl -->
<h2>Home</h2>
The call to c.HTML(http.StatusOK, "home", gin.H{"title": "Test"}) will render the following HTML:
<html>
<head>
<title>Test</title>
</head>
<body>
<h1>Example</h1>
<h2>Home</h2>
<body>
</html>
How it works
GinT expects you to organize all your HTML templates in a single
folder. Your TemplateDir needs to contain a layout.* file
which defines your application layout. The file extension of your
templates is configurable (default is tmpl), so it could be called
layout.html, layout.tpl.... Every time you call .HTML(status, templateName, data) on the gin.Context object, GinT will look
inside the templates folder and render templateName inside your
layout. In order for this to work, you have to render the content
template inside your layout using {{ template "content" . }}.
TODO
- cache templates in release mode
- document how partials work
- write some tests
Documentation
¶
Overview ¶
Package gint is an HTML Template plugin for the Gin (https://godoc.org/github.com/gin-gonic/gin) framework.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type HTMLRender ¶
HTMLRender is an implementation of the render.HTMLRender interface defined by the gin framework. It holds information like the location or file extension of your templates.
func NewHTMLRender ¶
func NewHTMLRender() *HTMLRender
NewHTMLRender constructs a default HTMLRender object.
Source Files
Directories