https://github.com/o1-labs/ocamlbyexample

Learn Ocaml by reading code examples
https://github.com/o1-labs/ocamlbyexample

dune examples examples-ocaml ocaml opam utop

Last synced: 13 days ago
JSON representation

Learn Ocaml by reading code examples

• Host: GitHub
• URL: https://github.com/o1-labs/ocamlbyexample
• Owner: o1-labs
• Created: 2021-05-13T04:12:46.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2022-12-13T09:46:29.000Z (about 2 years ago)
• Last Synced: 2023-08-01T06:43:31.885Z (over 1 year ago)
• Topics: dune, examples, examples-ocaml, ocaml, opam, utop
• Language: OCaml
• Homepage: https://o1-labs.github.io/ocamlbyexample/
• Size: 223 KB
• Stars: 35
• Watchers: 8
• Forks: 3
• Open Issues: 18
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Ocaml By Example



Learn the OCaml language, following a series of examples!

You can visit the rendered course here: https://o1-labs.github.io/ocamlbyexample/.

This page is inspired by https://gobyexample.com.

## Adding your own examples (chapters)

Create a folder in `book/chapters/` (using another example), then add your chapter in `book/chapters.json`.

Some guidelines: 

1. short examples are best

1. one chapter teaches one concept well

1. one block of explanation teaches one subconcept well

1. a concept is always introduced and explained the first time it is being used in an example

## How to render the webpage locally

You need the [OCaml](https://ocaml.org/) language setup.

Once you've set up OCaml you can install the dependencies needed by the project with:

```

make deps

```

Then simply run:

```

make

```

or to automatically update the website as you change files:

```

make watch

```

## Can I use this for another programming language?

Yes, while the code is written in OCaml you can use it to build similar webpages for any programming language (although syntax highlighting will only work for languages supported by [highlight.js](https://github.com/highlightjs/highlight.js/blob/main/SUPPORTED_LANGUAGES.md)).

So feel free to fork this page and use to teach your own stuff!