Docs

mkdocs material (this page)

Install dependencies

pip install mkdocs-glightbox mkdocs-nav-weight mkdocs-material

Official docs.

Commands

• mkdocs new [dir-name] - Create a new project.
• mkdocs serve - Start the live-reloading docs server.
• mkdocs build - Build the documentation site.
• mkdocs -h - Print help message and exit.

Project layout

mkdocs.yml    # The configuration file.
docs/
    index.md    # The documentation homepage.
    ...         # Other markdown pages, images and other files.
    blog/       # The blog
        posts/  # Blog posts

Including external files

--8<-- "engine/DEV.md:3:7"

Note that Hax uses JSON schemas: an OCaml module types.ml definining the types we declared on the Rust side with JSON parser and serializer is automatically generated. Thus, when we refer here to a Rust type in the context of the engine, we mean its OCaml automatically derived counterpart in Types.ml.