package yocaml_markdown

  1. Overview
  2. Docs
The recommended plugin for processing Markdown documents (based on Cmarkit)

Install

dune-project
 Dependency

Authors

Maintainers

Sources

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

Description

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

  1. textmate-language
  2. hilite >= "0.5.0"
  3. cmarkit
  4. yocaml = version
  5. ppx_expect
  6. ocaml >= "5.1.1"
  7. dune >= "3.18"

Dev Dependencies (2)

  1. odoc with-doc
  2. mdx with-test & >= "2.5.0"

Used by

None

Conflicts

None