package yocaml

  1. Overview
  2. Docs
Core engine of the YOCaml Static Site Generator

Install 

dune-project
 Dependency

github.com Readme Changelog Edit opam file Versions (13)

Authors

  1. T
    The XHTMLBoy <xhtmlboi@gmail.com>

Maintainers

  1. T
    The XHTMLBoy <xhtmlboi@gmail.com>

Sources

yocaml-2.0.0.tbz
sha256=fddf61500e828ac88d86ba982084cc817299302082a6e797b36787ff18235ec2
sha512=8b71a8cecd3e101df55eef0bba7a24d4dde9d66b5ecedd9f6d55834fcdc8d33fd875092ca73a398e1715664caee06cdc1bdb1b4da85bff0a687faac5c0445023

doc/yocaml/Yocaml/Required/module-type-DATA_READER/index.html

Module type Required.DATA_READER

Describes a provider for reading Metadata from a DATA_PROVIDER.

type t

The type that describes the data provider

type 'a eff

Effect type. Usually Yocaml.Eff.t.

type ('a, 'b) arr

Arrow type. Usually Yocaml.Task.t.

type extraction_strategy

The extraction strategy. Usually Yocaml.Metadata.extraction_strategy

Reading file with metadata

Just as the Yocaml package describes a low-level interface for propagating effects, the Yocaml.Eff module, and an interface for composing arrows, via the Yocaml.Pipeline module, the plugin describes two sub-modules to serve the same needs.

module Eff : sig ... end

Describes the low-level interface for reading a file and parsing its metadata described by the type t.

module Pipeline : sig ... end

Describes the arrowized interface for reading a file and parsing its metadata.

Data Provider

As it is possible to describe metadata as a Data_provider.

val from_string : string -> (t, provider_error) result

Produces a type t value from a string.

val normalize : t -> Data.t

Converts a value of type t into a value of type Yocaml.Data.t.