package yocaml

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

Install

dune-project
 Dependency

Authors

Maintainers

Sources

yocaml-3.0.0.tbz
sha256=c5237c5f345f76c829fd9f4ec5fcd05051e6f4372b24ecf798a48c2649ce9a0e
sha512=babeab686e031160882b739f07773bf1a2ae94a10de8992a4d812b35a487a353c2d3d915ac17fe74b7961570984c62d022c9108aa72562b5d81f93829ef62576

Description

YOCaml is a build system dedicated to generate static document

Published: 12 Feb 2026

README

YOCaml

You will find a comprehensive tutorial on how to use YOCaml on the official website.

Dev setup

We suggest creating a local switch to create a sandboxed development environment.

opam update
opam switch create . --deps-only --with-doc --with-test --with-dev-setup -y
eval $(opam env)

When the environment is prepared, dune build should build the project.

Useful commands

  • dune fmt Format the entire code base according to the profile described in the .ocamlformat file.
  • dune test Run the tests (for expectation tests, following the command with dune promote will regenerate the tests that produce outputs)

Website using YOCaml

Here is a list of websites that use YOCaml, along with their repositories. In addition, you will find some basic examples in the example directory.

Website

Source

YOCaml Tutorial

Repository

Ring.muhokama

Repository

Gr-im

Repository

Xvw

Repository

Condor du plateau

Repository

Maiste

Repository

UnrealDev

Repository

zeenat.dev

Repository

paws-planets-plates

Repository

Dev-JoyA

Repository

Please feel free to add your website to this list!

Dependencies (4)

  1. ppx_expect
  2. logs >= "0.7.0"
  3. ocaml >= "5.1.1"
  4. dune >= "3.18"

Dev Dependencies (11)

  1. utop with-dev-setup
  2. merlin with-dev-setup
  3. ocp-indent with-dev-setup
  4. ocamlformat with-dev-setup
  5. mdx with-test & >= "2.5.0"
  6. qcheck-alcotest with-test & >= "0.91"
  7. qcheck with-test & >= "0.91"
  8. alcotest with-test & >= "1.3.0"
  9. fmt with-test
  10. sherlodoc with-doc
  11. odoc with-doc

Used by (13)

  1. yocaml_cmarkit >= "3.0.0"
  2. yocaml_eio >= "3.0.0"
  3. yocaml_git >= "3.0.0"
  4. yocaml_jingoo >= "3.0.0"
  5. yocaml_liquid >= "3.0.0"
  6. yocaml_markdown >= "3.0.0"
  7. yocaml_mustache >= "3.0.0"
  8. yocaml_omd >= "3.0.0"
  9. yocaml_otoml >= "3.0.0"
  10. yocaml_runtime >= "3.0.0"
  11. yocaml_syndication >= "3.0.0"
  12. yocaml_unix >= "3.0.0"
  13. yocaml_yaml >= "3.0.0"

Conflicts

None