README
¶
Jade.go - template engine for Go (golang)
Package jade (github.com/Joker/jade) is a simple and fast template engine implementing Jade/Pug template.
Jade precompiles templates to Go code or generates html/template.
Now Jade-lang renamed to Pug template engine.
Jade/Pug syntax
example:
:go:func Index(pageTitle string, youAreUsingJade bool)
mixin for(golang)
#cmd Precompile jade templates to #{golang} code.
doctype html
html(lang="en")
head
title= pageTitle
script(type='text/javascript').
if(question){
answer(40 + 2)
}
body
h1 Jade - template engine
+for('Go')
#container.col
if youAreUsingJade
p You are amazing
else
p Get on it!
p.
Jade/Pug is a terse and simple
templating language with
a #[strong focus] on performance
and powerful features.
becomes
<!DOCTYPE html>
<html lang="en">
<head>
<title>Jade.go</title>
<script type="text/javascript">
if(question){
answer(40 + 2)
}
</script>
</head>
<body>
<h1>Jade - template engine
<div id="cmd">Precompile jade templates to Go code.</div>
</h1>
<div id="container" class="col">
<p>You are amazing</p>
<p>
Jade/Pug is a terse and simple
templating language with
a <strong>focus</strong> on performance
and powerful features.
</p>
</div>
</body>
</html>
Example usage
jade -pkg=main -writer hello.jade
jade command precompiles hello.jade to hello.jade.go
hello.jade
:go:func(arg) word string
doctype 5
html
body
p Hello #{word}!
hello.jade.go
// Code generated by "jade.go"; DO NOT EDIT.
package main
import "io"
const (
hello__0 = `<!DOCTYPE html><html><body><p>Hello `
hello__1 = `!</p></body></html>`
)
func tpl_hello(word string, wr io.Writer) {
buffer := &WriterAsBuffer{wr}
buffer.WriteString(hello__0)
WriteEscString(word, buffer)
buffer.WriteString(hello__1)
}
main.go
package main
//go:generate jade -pkg=main -writer hello.jade
import "net/http"
func main() {
http.HandleFunc("/", func(wr http.ResponseWriter, req *http.Request) {
tpl_hello("jade", wr)
})
http.ListenAndServe(":8080", nil)
}
Output on localhost:8080 :
<!DOCTYPE html><html><body><p>Hello jade!</p></body></html>
or generate html/template at runtime
package main
import (
"fmt"
"github.com/Joker/hpp" // Prettify HTML
"github.com/Joker/jade"
)
func main() {
tpl, err := jade.Parse("name_of_tpl", "doctype 5\n html: body: p Hello #{.Word} !")
if err != nil {
fmt.Printf("Parse error: %v", err)
return
}
fmt.Printf( "Output:\n\n%s", hpp.PrPrint(tpl) )
}
Output:
<!DOCTYPE html>
<html>
<body>
<p>Hello {{.Word}} !</p>
</body>
</html>
Installation
$ go get github.com/Joker/jade/cmd/jade
Custom filter :go
This filter is used as helper for command line tool
(to set imports, function name and parameters).
Filter may be located at any nesting level.
When jade used as library :go filter is not needed.
Nested filter :func
:go:func
CustomNameForTemplateFunc(any []int, input string, args map[string]int)
:go:func(name)
OnlyCustomNameForTemplateFunc
:go:func(args)
(only string, input float32, args uint)
Nested filter :import
:go:import
"github.com/Joker/jade"
github.com/Joker/hpp
Documentation
¶
Overview ¶
Jade.go - template engine. Package implements Jade-lang templates for generating Go html/template output.
Index ¶
- Variables
- func Config(c Cfg)
- func ConfigOtputPHP()
- func Parse(name string, text []byte) (string, error)
- func ParseFile(filename string) (string, error)
- type BlockNode
- type Cfg
- type CodeNode
- type CondNode
- type DoctypeNode
- type ListNode
- type MixinNode
- type Node
- type NodeType
- type Out
- type Pos
- type TagNode
- type TextNode
- type Tree
Constants ¶
This section is empty.
Variables ¶
View Source
var TabSize = 4
Functions ¶
func ConfigOtputPHP ¶
func ConfigOtputPHP()
func Parse ¶
Parse parses the template definition string to construct a representation of the template for execution.
Trivial usage:
package main
import (
"fmt"
"github.com/Joker/jade"
)
func main() {
tpl, err := jade.Parse("tpl_name", "doctype 5: html: body: p Hello world!")
if err != nil {
fmt.Printf("Parse error: %v", err)
return
}
fmt.Printf( "Output:\n\n%s", tpl )
}
Output:
<!DOCTYPE html><html><body><p>Hello world!</p></body></html>
Types ¶
type Cfg ¶
type Cfg struct {
GolangMode bool
TagBgn string
TagEnd string
TagVoid string
TagArgEsc string
TagArgUne string
TagArgStr string
TagArgAdd string
TagArgBgn string
TagArgEnd string
CondIf string
CondUnless string
CondCase string
CondWhile string
CondFor string
CondEnd string
CondForIf string
CodeForElse string
CodeLongcode string
CodeBuffered string
CodeUnescaped string
CodeElse string
CodeElseIf string
CodeCaseWhen string
CodeCaseDef string
CodeMixBlock string
TextStr string
TextComment string
MixinBgn string
MixinEnd string
MixinVarBgn string
MixinVar string
MixinVarRest string
MixinVarEnd string
MixinVarBlockBgn string
MixinVarBlock string
MixinVarBlockEnd string
}
type CodeNode ¶
type DoctypeNode ¶
func (*DoctypeNode) Copy ¶
func (d *DoctypeNode) Copy() Node
func (*DoctypeNode) String ¶
func (d *DoctypeNode) String() string
func (*DoctypeNode) WriteIn ¶
func (d *DoctypeNode) WriteIn(b io.Writer)
type ListNode ¶
type ListNode struct {
NodeType
Pos
Nodes []Node // The element nodes in lexical order.
// contains filtered or unexported fields
}
ListNode holds a sequence of nodes.
type MixinNode ¶
type Node ¶
type Node interface {
Type() NodeType
String() string
WriteIn(io.Writer)
// Copy does a deep copy of the Node and all its components.
// To avoid type assertions, some XxxNodes also have specialized
// CopyXxx methods that return *XxxNode.
Copy() Node
Position() Pos // byte position of start of node in full original input string
// contains filtered or unexported methods
}
A Node is an element in the parse tree. The interface is trivial. The interface contains an unexported method so that only types local to this package can satisfy it.
type Pos ¶
type Pos int
Pos represents a byte position in the original input text from which this template was parsed.
type TagNode ¶
type TextNode ¶
type Tree ¶
type Tree struct {
Name string // name of the template represented by the tree.
Root *ListNode // top-level root of the tree.
// contains filtered or unexported fields
}
Tree is the representation of a single parsed template.
Source Files
¶
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
Code generated by "jade.go"; DO NOT EDIT.
|
Code generated by "jade.go"; DO NOT EDIT. |
Click to show internal directories.
Click to hide internal directories.