package yocaml_jingoo

  1. Overview
  2. Docs
package yocaml_jingoo
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module Yocaml_jingooSource

Plugin for describing templates using Jingoo, a template engine inspired by Jinja2 (from the Python world).

Injection

Description of a pipeline for reading a template and injecting content.

Sourceval read_template : ?snapshot:bool -> ?strict:bool -> Yocaml.Path.t -> (unit, (module Yocaml.Required.DATA_INJECTABLE with type t = 'a) -> metadata:'a -> string -> string) Yocaml.Task.t

Return a function that apply ~metadata and ~content to a given template. Made the usage with applicative easier.

Sourceval read_templates : ?snapshot:bool -> ?strict:bool -> Yocaml.Path.t list -> (unit, (module Yocaml.Required.DATA_INJECTABLE with type t = 'a) -> metadata:'a -> string -> string) Yocaml.Task.t

Return a function that apply ~metadata and ~content to a list of templates (in sequential order). Made the usage with applicative easier.

Sourcemodule Pipeline : sig ... end

Describes the arrowized interface for reading a file as a template and injecting content and variables.

Data template

Describes the Yocaml_jingoo module as a template engine. Allows the latter to be passed to any function requiring it.

The type that describes the template language.

Sourceval from : Yocaml.Data.t -> t

from data Transforms a normalized data representation (data) into an associative list of data that can be injected into a template.

Sourceval render : ?strict:bool -> (string * t) list -> string -> string

render ?strict parameters content injects parameters data into content and returns the result of the applied content. To inject metadata into a template.