forked from Joker/jade
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
replace module name to be included until author accepts my PR
- Loading branch information
Showing
11 changed files
with
15 additions
and
203 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,196 +1,8 @@ | ||
| # 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](https://pugjs.org/api/getting-started.html). | ||
| # Jade(Pug) Parser | ||
|
|
||
| [](https://godoc.org/github.com/Joker/jade) [](https://goreportcard.com/report/github.com/Joker/jade) | ||
| Read more about its syntax at: https://github.com/iris-contrib/jade. | ||
|
|
||
| ## Jade/Pug syntax | ||
| example: | ||
| Fixes: | ||
|
|
||
| ```jade | ||
| :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 | ||
|
|
||
| ```html | ||
| <!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> | ||
| ``` | ||
|
|
||
|
|
||
| See [more](https://github.com/Joker/jade/tree/master/testdata/v2) [examples](https://github.com/Joker/jade/tree/master/example). | ||
|
|
||
|
|
||
| ## Example usage | ||
|
|
||
| ```sh | ||
| 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` | ||
| ```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` | ||
| ```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 : | ||
| ```html | ||
| <!DOCTYPE html><html><body><p>Hello jade!</p></body></html> | ||
| ``` | ||
|
|
||
|
|
||
| or generate html/template at runtime | ||
|
|
||
|
|
||
| ```go | ||
| 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: | ||
|
|
||
| ```html | ||
| <!DOCTYPE html> | ||
| <html> | ||
| <body> | ||
| <p>Hello {{.Word}} !</p> | ||
| </body> | ||
| </html> | ||
| ``` | ||
|
|
||
|
|
||
| ## Installation | ||
|
|
||
| ```sh | ||
| $ 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 | ||
| ``` | ||
| - https://github.com/iris-contrib/jade/issues/33 | ||
| - https://github.com/kataras/iris/issues/1450 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -7,7 +7,7 @@ import ( | |
| "strings" | ||
| "text/template" | ||
|
|
||
| "github.com/Joker/jade" | ||
| "github.com/iris-contrib/jade" | ||
| ) | ||
|
|
||
| const ( | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,4 @@ | ||
| module github.com/Joker/jade | ||
| module github.com/iris-contrib/jade | ||
|
|
||
| require ( | ||
| github.com/Joker/hpp v1.0.0 | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters