ace

package module

v0.0.4 Latest Latest Go to latest Published: Aug 2, 2014 License: MIT Imports: 8 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/albrow/ace

Links

Open Source Insights

README ¶

Ace - HTML template engine for Go

Overview

Ace is an HTML template engine for Go. This is inspired by Slim and Jade. This is a refinement of Gold.

Example

= doctype html
html lang=en
  head
    title Hello Ace
    = css
      h1 { color: blue; }
  body
    h1 {{.Msg}}
    #container.wrapper
      p..
        Ace is an HTML template engine for Go.
        This engine simplifies HTML coding in Go web application development.
    = javascript
      console.log('Welcome to Ace');

becomes

<!DOCTYPE html>
<html lang="en">
  <head>
    <title>Hello Ace</title>
    <style type="text/css">
      h1 { color: blue; }
    </style>
  </head>
  <body>
    <h1>Hello Ace</h1>
    <div id="container" class="wrapper">
      <p>
        Ace is an HTML template engine for Go.<br>
        This engine simplifies HTML coding in Go web application development.
      </p>
    </div>
    <script type="text/javascript">
      console.log('Welcome to Ace');
    </script>
  </body>
</html>

Features

Making Use of the Go Standard Template Package

Ace fully utilizes the strength of the html/template package. You can embed actions of the template package in Ace templates. Ace also uses nested template definitions of the template package and Ace templates can pass pipelines (parameters) to other templates which they include.

Simple Syntax

Ace has a simple syntax and this makes template files simple and light.

Caching Function

Ace has a caching function which caches the result data of the templates parsing process. You can omit the templates parsing process and save template parsing time by using this function.

Binary Template Load Function

Ace has a binary template load function which loads Ace templates from binary data in memory instead of template files on disk. You can compile your web application into one binary file by using this function. go-bindata is the best for generating binary data from template files.

Getting Started

Please check the following documentation.

Getting Started - shows the getting started guide.
Examples - shows the examples of the web applications which use the Ace template engine.

Documentation

You can get the documentation about Ace via the following channels:

Documentation - includes the getting started guide and the syntax documentation.
GoDoc - includes the API docuemntation.

Official Information & Announcement

You can get the official information and announcement about Ace via the following channels:

Discussion & Contact

You can discuss Ace and contact the Ace development team via the following channels:

Contributions

Any contributions are welcome. Please feel free to create an issue or send a pull request.

Renderers for web frameworks

Martini Acerender - For Martini

Tools

vim-ace - Vim syntax highlighting for Ace templates

Documentation ¶

Overview ¶

Package ace provides an HTML template engine.

Index ¶

func CompileResult(name string, rslt *result, opts *Options) (*template.Template, error)
func Load(basePath, innerPath string, opts *Options) (*template.Template, error)
func NewSource(base, inner *File, includes []*File) *source
func ParseSource(src *source, opts *Options) (*result, error)
type File
- func NewFile(path string, data []byte) *File
type Options

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func CompileResult ¶

func CompileResult(name string, rslt *result, opts *Options) (*template.Template, error)

CompileResult compiles the parsed result to the template.Template.

func Load ¶ added in v0.0.4

func Load(basePath, innerPath string, opts *Options) (*template.Template, error)

Load loads and returns an HTML template. Each Ace templates are parsed only once and cached if the "DynamicReload" option are not set.

func NewSource ¶

func NewSource(base, inner *File, includes []*File) *source

NewSource creates and returns source.

func ParseSource ¶

func ParseSource(src *source, opts *Options) (*result, error)

ParseSource parses the source and returns the result.

Types ¶

type File ¶

type File struct {
	// contains filtered or unexported fields
}

File represents a file.

func NewFile ¶

func NewFile(path string, data []byte) *File

NewFile creates and returns a file.

type Options ¶

type Options struct {
	// Extension represents an extension of files.
	Extension string
	// DelimLeft represents a left delimiter for the html template.
	DelimLeft string
	// DelimRight represents a right delimiter for the html template.
	DelimRight string
	// DynamicReload represents a flag which means whether Ace reloads
	// templates dynamically.
	// This option should only be true in development.
	DynamicReload bool
	// BaseDir represents a base directory of the Ace templates.
	BaseDir string
	// Asset loads and returns the asset for the given name.
	// If this function is set, Ace load the template data from
	// this function instead of the template files.
	Asset func(name string) ([]byte, error)
	// FuncMap represents a template.FuncMap which is set to
	// the result template.
	FuncMap template.FuncMap
}

Options represents options for the template engine.

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
examples
actions
base_inner_template
change_action_delimiter
comments
css_javascript_helper_method
dynamic_reload
html_tags
include_helper_method
load_templates_from_binary_data
pass_pipeline_to_included_template
plain_texts
set_custom_functions
set_default_value_to_the_yield_helper_method
single_template

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL