OCaml parser for Jekyll-format blog posts
OCaml Shell
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
doc
pkg
src
test
.gitignore
.merlin
.ocp-indent
.travis.yml
CHANGES.md
LICENSE.md
README.md
TODO.md
_tags
build
opam

README.md

jekyll-format — Jekyll post parsing library

%%VERSION%%

Jekyll is a simple, blog-aware static site generator that takes a template directory of files and turns them into a website. This library exists to parse those blog posts and make them easy to manipulate from OCaml code.

jekyll-format is distributed under the ISC license.

Homepage: https://github.com/avsm/jekyll-format
Contact: Anil Madhavapeddy <anil@recoil.org>

Installation

jekyll-format can be installed with opam:

opam install jekyll-format

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.

Sample programs

If you installed jekyll-format with opam sample programs are located in the directory opam config var jekyll-format:doc.

In the distribution sample programs and tests are located in the test directory of the distribution. They can be built with:

ocamlbuild -use-ocamlfind test/tests.otarget

The resulting binaries are in _build/test.

  • test.native tests the library, nothing should fail.