YOCaml

YOCaml is framework for building static site generator, written in OCaml.

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)

Ensure that you have run dune fmt and dune test before waiting for your branch to be merged.

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
clementd	Repository
Linda-Njau	Repository
bthuillier	Repository
fantazio	Repository

Please feel free to add your website to this list!