package yocaml

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

Install

dune-project
 Dependency

Authors

Maintainers

Sources

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

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.