Code Monkey home page Code Monkey logo

ocaml-book's Introduction

ocaml-book

A free culture 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 website generator, version 1.8 or newer.
  • cmark for Markdown to HTML conversion.
  • highlight 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 0.29 made "safe mode" the default and removes HTML tags from Markdown source (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.

Reading

A draft more or less in sync with the repo lives at https://ocaml-book.baturin.org I should setup a CI for it eventually.

ocaml-book's People

Contributors

dmbaturin avatar milisarge avatar fccm avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.