https://github.com/dmbaturin/ocamlbook.org

A free (as in freedom) OCaml textbook
https://github.com/dmbaturin/ocamlbook.org

hacktoberfest ocaml textbook

Last synced: about 2 months ago
JSON representation

A free (as in freedom) OCaml textbook

• Host: GitHub
• URL: https://github.com/dmbaturin/ocamlbook.org
• Owner: dmbaturin
• License: cc-by-sa-4.0
• Created: 2018-12-15T22:10:55.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2024-05-11T16:23:30.000Z (4 months ago)
• Last Synced: 2024-07-28T09:22:25.008Z (about 2 months ago)
• Topics: hacktoberfest, ocaml, textbook
• Language: CSS
• Homepage: https://ocamlbook.org
• Size: 279 KB
• Stars: 127
• Watchers: 14
• Forks: 10
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-list - ocamlbook.org

README

        
# ocaml-book

A free (as in freedom) OCaml textbook.

## Contributing

This book is licensed under Creative Commons Attribution Share-Alike,

a free culture license.

It's meant to be a collaborative effort that belongs to the community

and can freely shared, updated and maintained even if the original authors no longer

have the time and motivation to maintain it.

Everyone is welcome to contribute. Just create a pull request.

## Building

You will need:

* [soupault](https://soupault.app) website generator, version 2.0.0 or newer

* [cmark](https://github.com/commonmark/cmark) for Markdown to HTML conversion

* [highlight](http://www.andre-simon.de/doku/highlight/en/highlight.php) for static syntax highlighting

* The OCaml compiler for build-time example typechecking

* GNU Make

Once you have all dependencies, run `make all`, the output will be in `build/`.

### Note on cmark

cmark versions before and after 0.29 have different HTML tag stripping behaviour

and there is no set of options that can work for both.

Pre-0.29 versions would leave HTML tags alone unless run in "safe mode" (`--safe`).

cmark 0.29 unexpectedly made "safe mode" the new default and will remove all HTML tags

unless you run it with `--unsafe`.

Why a locally run program working with local files would want to do that by default is beyond me.

Why they didn't add a backwards-compatibility mechanism like an environment variable is also beyond me.

Anyway, the `md = "cmark --unsafe"` line in `soupault.conf` will only work with cmark >=0.29.

If you are building on a system with an older cmark version, remove `--unsafe`

because older cmark versions do not understand that option, but neither do they need it.

Maybe I should just move to another convertor.

## Reading

A live version is available at https://ocamlbook.org