Interactive gists for the web

Requirements

OCaml 4.04.2

A recent Node and NPM version

Installation

opam install ocaml-gist

Btw. we'd love to know if you are using ocaml-gist.

Usage

jbuilder

This is an example of a create-gist rule for jbuilder that invokes the og-create command. The resulting gist has support for the OCaml stdlib and Base library. It also has a dependency on a local foo library.

(alias (
  (name create-gist)
  (deps (foo.cma))
  (action (progn
    (run og-create
         --input input_base
         --output output_base
         --dependency foo.cma
         --lib stdlib
         --lib +base/runtime.js
         --lib base
         --doc
    )
  ))
))
      

The used arguments have the following meaning:

• --input (a directory with ml files)
  the code to be included in the generated gist experience.
• --output (output directory)
  where the resulting gist experience should be placed
• --dependency (string)
  a local dependency
• --lib (string)
  a library
• --doc
  indicates that the gist most have documentation support

Once a gist is created you need to start a server that serves the output directory.

To use the gist tool in your website, just copy the files needed around. Keep in mind that the output directory will be generated again on the next run.

Command line

This is an example of using the og-create command directly to create a gist experience that supports LWT.

      og-create
         --input input_lwt
         --output output_lwt
         --dependency foo.cma
         --lib stdlib
         --lib result
         --lib lwt
         --lib js_of_ocaml-lwt
         --lib js_of_ocaml
    

Limitations

• Limited support for OCaml versions. Right now there is support for OCaml 4.04.2 and probably 4.02.3 but this hasn't been tested recently.
• Not all libraries can be used
• No input support

Contribute

Contributions are very welcome