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 (14)

Authors

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

Maintainers

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

Sources

yocaml-2.7.0.tbz
sha256=89a74bd5cb37e580e45e4ed3d43b07b2cca5af9ab7f98966c48fe9730dc4af2e
sha512=ae77555570320c28c47d748e75056ccc44bb43cddf6fef70e8b556254fd809d67b915b313bd1833c28581db1fdeefbe34e81d5548744d6ecabe466ee1ef6284c

doc/yocaml/Yocaml/Slug/index.html

Module Yocaml.SlugSource

An incredibly simple (and opinionated) implementation of Slug.

The implementation is rather dirigiste, and relatively unconfigurable, but it can easily be replaced by a different implementation and is only there to make it easier to bootstrap a blog.

Types

Sourcetype t = string

A slug is just an alias on string.

Building slugs

Sourceval from : ?mapping:(char * string) list -> ?separator:char -> ?unknown_char:char -> string -> t

from str build a naive slug from a given string.

Validating slugs

Sourceval validate : ?separator:char -> ?unknown_char:char -> Data.t -> t Data.Validation.validated_value

Validate a slug.

Sourceval validate_string : ?separator:char -> ?unknown_char:char -> string -> t Data.Validation.validated_value

Validate a slug from a string.

Utils

Sourceval default_mapping : (char * string) list