pug

README

Pug

Pug is a template engine create by joker, to see the original syntax documentation please click here

Basic Example

./views/index.pug

include views/partials/header.pug

h1 #{.Title}

include views/partials/footer.pug

./views/partials/header.pug

h2 Header

./views/partials/footer.pug

h2 Footer

./views/layouts/main.pug

doctype html
html
  head
    title Main
  body
    | {{embed}}

package main

import (
	"log"

	"github.com/gofiber/fiber/v2"
	"github.com/gofiber/template/pug"

	// "net/http" // embedded system
)

func main() {
	// Create a new engine
	engine := pug.New("./views", ".pug")

	// Or from an embedded system
	// See github.com/gofiber/embed for examples
	// engine := pug.NewFileSystem(http.Dir("./views", ".pug"))

	// Pass the engine to the Views
	app := fiber.New(fiber.Config{
		Views: engine,
	})

	app.Get("/", func(c *fiber.Ctx) error {
		// Render index
		return c.Render("index", fiber.Map{
			"Title": "Hello, World!",
		})
	})

	app.Get("/layout", func(c *fiber.Ctx) error {
		// Render index within layouts/main
		return c.Render("index", fiber.Map{
			"Title": "Hello, World!",
		}, "layouts/main")
	})

	log.Fatal(app.Listen(":3000"))
}

Documentation

Index

• type Engine
  • func New(directory, extension string) *Engine
  • func NewFileSystem(fs http.FileSystem, extension string) *Engine
  • func (e *Engine) AddFunc(name string, fn interface{}) *Engine
  • func (e *Engine) Debug(enabled bool) *Engine
  • func (e *Engine) Delims(left, right string) *Engine
  • func (e *Engine) Layout(key string) *Engine
  • func (e *Engine) Load() error
  • func (e *Engine) Parse() (err error)
  • func (e *Engine) Reload(enabled bool) *Engine
  • func (e *Engine) Render(out io.Writer, template string, binding interface{}, layout ...string) error

Types

type Engine

type Engine struct {

	//  templates
	Templates *template.Template
	// contains filtered or unexported fields
}

Engine struct

func New

func New(directory, extension string) *Engine

New returns a Pug render engine for Fiber

func NewFileSystem

func NewFileSystem(fs http.FileSystem, extension string) *Engine

New returns a Pug render engine for Fiber

func (*Engine) AddFunc

func (e *Engine) AddFunc(name string, fn interface{}) *Engine

AddFunc adds the function to the template's function map. It is legal to overwrite elements of the default actions

func (*Engine) Debug

func (e *Engine) Debug(enabled bool) *Engine

Debug will print the parsed templates when Load is triggered.

func (*Engine) Delims

func (e *Engine) Delims(left, right string) *Engine

Delims sets the action delimiters to the specified strings, to be used in templates. An empty delimiter stands for the corresponding default: {{ or }}.

func (*Engine) Layout

func (e *Engine) Layout(key string) *Engine

Layout defines the variable name that will incapsulate the template

func (*Engine) Load

func (e *Engine) Load() error

Load parses the templates to the engine.

func (*Engine) Parse

func (e *Engine) Parse() (err error)

Parse is deprecated, please use Load() instead

func (*Engine) Reload

func (e *Engine) Reload(enabled bool) *Engine

Reload if set to true the templates are reloading on each render, use it when you're in development and you don't want to restart the application when you edit a template file.

func (*Engine) Render

func (e *Engine) Render(out io.Writer, template string, binding interface{}, layout ...string) error

Execute will render the template by name