package yocaml

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

Install

dune-project
 Dependency

Authors

Maintainers

Sources

yocaml-3.0.1.tbz
sha256=9091d2c578cfbd15ff87f3d0dc9a64f9e02e714a22d37da14823083ec46a51b1
sha512=22231c3852a8345b6a6947c367e7cc311b57ccf2869a5d7c681384e7c0c18f0a17217ebc04ae9523833941ac71f136185cdc75090fe0849fa42a4f8a01d5e203

Description

YOCaml is a build system dedicated to generate static document

Added to opam-repository:

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

clementd

Repository

Linda-Njau

Repository

bthuillier

Repository

fantazio

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

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

Conflicts

None