package handlebars-ml

  1. Overview
  2. Docs
Handlebars templating for OCaml

Install

dune-project
 Dependency

Authors

Maintainers

Sources

0.1.2.tar.gz
md5=b28e6d2839a8f433a71c303c0e248ae4
sha512=556a272b7c77f9abba2dfd3227360e9337f816322844f7460ef4831b9b2cd3fd9b9e372530299274dd97c61c043446d0c0c1aa278786125f19bb845dff4417a2

Description

OCaml port of the Handlebars.js templating engine

Tags

handlebars template

Published: 04 Oct 2025

README

handlebars-ml

Handlebars templating for OCaml.

Installation

Install with opam:

opam install handlebars-ml

CLI usage

opam install handlebars-ml
handlebars-ml -d data.json template.hbs

Optionally, pass a partials directory with -p partials_dir.

Pass the -h (or --help) flag to see all options.

handlebars-ml -h

Library usage

Use Yojson values for passing JSON data as template context.

let () =
    let data = Yojson.Basic.from_string {| { "name": "World" } |} in 
    let template = "Hello, {{name}}!" in
    match Handlebars_ml.Compiler.compile template data with
    | Ok result -> print_endline result
    | Error err -> prerr_endline ("Error: " ^ err)

Pass get_helper and get_partial functions as named arguments to compile to use custom helpers and partials. Use JSON types for arguments and return values.

let custom_get_helper name =
    let shout = function
    | [ `String s ] -> Some (`String (String.uppercase_ascii arg))
    | _ -> None
    in
    match name with
    | "shout" -> Some shout
    | _ -> None

let () =
    let data = Yojson.Basic.from_string {| { "name": "World" } |} in 
    let template = "Hello, {{shout name}}!" in
    match Handlebars_ml.Compiler.compile ~get_helper:custom_get_helper template data with
    | Ok result -> print_endline result
    | Error err -> prerr_endline ("Error: " ^ err)

handlebars-ml provides a default_get_helper function in Handlebars_ml.Compiler that can be used in your custom implementation to still keep the default helpers.

License

MIT

Dependencies (4)

  1. ppx_deriving
  2. yojson >= "2.0"
  3. ocaml >= "4.14"
  4. dune >= "3.18"

Dev Dependencies (2)

  1. odoc with-doc
  2. ppx_inline_test with-test

Used by

None

Conflicts

None