htmlc

README

HTMLC (HTML Compiler)

Compiles HTML to Elixir. Who says HTML is not a programming language?

This module is just another templating engine, and a really fast one. With elixir, we can leverage its unique ability to call individual functions in iex mode. Elixir can quickly build templates on the fly, with our html stored in binary strings.

Installation

go get github.com/tkdeng/htmlc

Usage

import (
  "github.com/tkdeng/htmlc"
)

func main(){
  htmlc.Compile("./src", "./output.exs")
}

Using The Binary

You can opptionally just use the binary instead of importing the module.

./htmlc --src="./src" --out="./output.exs"

You can also specify a port number, to automatically start a static-like http server.

./htmlc --port="3000"

Note: by default, "--src" is set to the current working directory, and "--out" is set to the same directory, with the file name set to the base folder name.

You can also call this method without the "--src" or "--port"

./htmlc --src="/var/www/html"
# is equivalent to
./htmlc --src="/var/www/html"

./htmlc --port="3000"
# is equivalent to
./htmlc 3000

# so you can use the method like this
./htmlc /var/www/html 3000

# and the order doesnt matter, as long as the port number is a valid uint16
./htmlc 3000 /var/www/html

# note: the output file must still be specified with "--out"
./htmlc --out="html.exs" /var/www/html 3000

Elixir Template Usage

# start template engine
iex "./html.exs"

# render page
iex> App.render "mypage/home", "mylayout/layout", %{args: "myarg"}

# render widget (optional)
iex> App.widget "mywidget/app", %{args: "myarg"}

# render layout (optional)
iex> App.layout "mylayout/layout", %{args: "myarg"}, %{body: "page embed"}

# stop template engine
iex> System.halt

Documentation

Index

• Variables
• func Compile(src string, out string) error
• type ExsEngine
  • func Engine(file string) (*ExsEngine, error)
  • func (exs *ExsEngine) Render(name string, args Map, layout ...string) ([]byte, error)
• type Map

Variables

var ErrorStopped error = errors.New("elixir cmd stopped running")

var ErrorTimeout error = errors.New("request timed out")

Functions

func Compile

func Compile(src string, out string) error

Types

type ExsEngine

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

func Engine

func Engine(file string) (*ExsEngine, error)

func (*ExsEngine) Render

func (exs *ExsEngine) Render(name string, args Map, layout ...string) ([]byte, error)

type Map

type Map map[string]any