minima-theme

README.md.html

minima-theme — Port of Jekyll Minima theme as an OCaml library

v1.0.0

minima-theme is an OCaml port of the Jekyll Minima that is the default blog format for many users. It provides a typed interface for easy use from OCaml code.

minima-theme is distributed under the ISC license. The original Minima HTML templates bundled with this repository remain under the MIT license.

Installation

minima-theme can be installed with opam:

opam install minima-theme

If you don't use opam consult the opam file for build
instructions.

Documentation

The documentation and API reference is automatically generated by
ocamldoc from the interfaces. It can be consulted online
and there is a generated version in the doc directory of the
distribution.

Templates

If you installed minima-theme with opam the runtime templates are located in
the directory opam config var minima-theme:share. This is looked up
by default if no base directory is provided when Minima_theme.v is called.