jon.recoil.org
this repo has no description
1Embed OCaml notebooks in any web page thanks to WebComponents! Just copy and paste the following script in your html page source to load the integration:
2
3```html
4<script async
5 src="https://cdn.jsdelivr.net/gh/art-w/x-ocaml.js@6/x-ocaml.js"
6 src-worker="https://cdn.jsdelivr.net/gh/art-w/x-ocaml.js@6/x-ocaml.worker+effects.js"
7 integrity="sha256-3ITn2LRgP/8Rz6oqP5ZQTysesNaSi6/iEdbDvBfyCSE="
8 crossorigin="anonymous"
9></script>
10```
11
12This will introduce a new html tag `<x-ocaml>` to present OCaml code, for example:
13
14```html
15<x-ocaml>let x = 42</x-ocaml>
16```
17
18The script will initialize a CodeMirror editor integrated with the OCaml interpreter, Merlin and OCamlformat (all running in a web worker). [**Check out the online demo**](https://art-w.github.io/x-ocaml/) for more details, including how to load additional OCaml libraries and ppx in your page.
19
20For an even easier integration, @patricoferris made a command-line tool [`xocmd`](https://github.com/patricoferris/xocmd) to convert markdown files to use `<x-ocaml>`!
21
22## Compilation
23
24To avoid relying on a public CDN and host your own copy of the `x-ocaml` scripts, you can reproduce the javascript files with:
25
26```shell
27$ git clone --recursive https://github.com/art-w/x-ocaml
28$ cd x-ocaml
29
30# Install the dependencies with either dune:
31x-ocaml/ $ dune pkg lock
32# Or with opam:
33x-ocaml/ $ opam update && opam install . --deps-only
34
35# Make sure to use the release profile to optimize the js file size
36x-ocaml/ $ dune build --profile=release
37
38x-ocaml/ $ ls *.js
39x-ocaml.js x-ocaml.worker+effects.js x-ocaml.worker.js
40```
41
42## Acknowledgments
43
44This project was heavily inspired by the amazing [`sketch.sh`](https://sketch.sh), [@jonludlam's notebooks in Odoc](https://jon.recoil.org/notebooks/foundations/foundations1.html#a-first-session-with-ocaml), [`blogaml` by @panglesd](https://github.com/panglesd/blogaml), and all the wonderful people who made [Try OCaml](https://try.ocamlpro.com/) and other online playgrounds! It was made possible thanks to the invaluable [`js_of_ocaml-toplevel`](https://github.com/ocsigen/js_of_ocaml) library, the magical [`merlin-js` by @voodoos](https://github.com/voodoos/merlin-js), the excellent [CodeMirror bindings by @patricoferris](https://github.com/patricoferris/jsoo-code-mirror/), the guidance of @Julow on `ocamlformat` and the javascript expertise of @xvw.