yocaml fork to add a flake and nix packages for the components.
- OCaml 90.5%
- Standard ML 6.6%
- Perl 1.3%
- Nix 0.7%
- Dune 0.5%
- Other 0.3%
reym
54c4677b62
Some checks failed
YOCaml Deploy Documentation / opam build & run tests (push) Has been cancelled
Test / build-and-test (5, macos-latest) (push) Has been cancelled
Test / build-and-test (5, ubuntu-latest) (push) Has been cancelled
Test / lint-fmt (ocaml-base-compiler.5.3.0, ubuntu-latest) (push) Has been cancelled
|
||
|---|---|---|
| .github/workflows | ||
| doc | ||
| examples | ||
| lib | ||
| plugins | ||
| test | ||
| .gitignore | ||
| .ocamlformat | ||
| .ocamlformat-ignore | ||
| CHANGES.md | ||
| dune-project | ||
| flake.lock | ||
| flake.nix | ||
| LICENSE | ||
| package.nix | ||
| README.md | ||
| yocaml.opam | ||
| yocaml_cmarkit.opam | ||
| yocaml_eio.opam | ||
| yocaml_git.opam | ||
| yocaml_jingoo.opam | ||
| yocaml_liquid.opam | ||
| yocaml_markdown.nix | ||
| yocaml_markdown.opam | ||
| yocaml_mustache.opam | ||
| yocaml_omd.opam | ||
| yocaml_otoml.opam | ||
| yocaml_runtime.nix | ||
| yocaml_runtime.opam | ||
| yocaml_syndication.opam | ||
| yocaml_unix.nix | ||
| yocaml_unix.opam | ||
| yocaml_yaml.nix | ||
| yocaml_yaml.opam | ||
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 fmtFormat the entire code base according to the profile described in the.ocamlformatfile.dune testRun the tests (for expectation tests, following the command withdune promotewill regenerate the tests that produce outputs)
Ensure that you have run
dune fmtanddune testbefore 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.
Please feel free to add your website to this list!