https://github.com/ocamlpro/ocp-reveal
An OCaml binding for reveal.js, a html presentation framework.
https://github.com/ocamlpro/ocp-reveal
Last synced: about 1 year ago
JSON representation
An OCaml binding for reveal.js, a html presentation framework.
- Host: GitHub
- URL: https://github.com/ocamlpro/ocp-reveal
- Owner: OCamlPro
- License: other
- Created: 2015-10-01T09:43:41.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2020-05-18T08:51:51.000Z (about 6 years ago)
- Last Synced: 2025-06-12T02:09:34.526Z (about 1 year ago)
- Language: OCaml
- Homepage:
- Size: 1.01 MB
- Stars: 5
- Watchers: 5
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGES.md
- License: LICENSE.md
Awesome Lists containing this project
README
# ocp-reveal
OCaml bindings to [reveal.js] library.
`Reveal.js` is a framework for easily creating beautiful presentations using
HTML.
`reveal.js` comes with a broad range of features including nested slides,
Markdown contents, PDF export, speaker notes and a JavaScript API. It's best
viewed in a modern browser but fallbacks are available to make sure your
presentation can still be viewed elsewhere.
## Dependencies
ocp-reveal depends on [dune], [omd], [js_of_ocaml]. You can install them using [opam]:
````sj
opam install dune js_of_ocaml omd
````````````
## Usage
This will build the library and the exemples.
```sh
dune build
```
After building, you can see the examples with:
```sh
xdg-open _build/default/examples/example.html
xdg-open _build/default/examples/example_2.html
```
You can also see an [online demo].
To start your own slides, you can have a look at the `examples` folder. It's just a matter of creating an HTML file, an OCaml file and compiling.
[dune]: https://dune.build/
[omd]: https://github.com/ocaml/omd
[js_of_ocaml]: https://github.com/ocsigen/js_of_ocaml
[online demo]: https://cagdas.bozman.fr/demo-ocp-reveal/#/
[opam]: https://opam.ocaml.org/
[reveal.js]: https://github.com/hakimel/reveal.js