package jekyll-format

  1. Overview
  2. Docs
Jekyll post parsing library

Install

Dune Dependency

Authors

Maintainers

Sources

jekyll-format-v0.2.0.tbz
sha256=8d5b438e235d712827a130906473951ed532522473262730043aa4783a60031a
sha512=ddd73dbf82ad5e8a613fe6600729b217658c478a445e2fd42c5da5f4cb66aad335a87ef239c37f97c53394e2d5d452034874fe424fd45e4503df3e71da7dff64

Description

This library provides an OCaml interface to parsing posts in the Jekyll format.

Published: 27 Apr 2021

README

jekyll-format — Jekyll post parsing library

v0.2.0

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.

If you want the unreleased version you can pin this repository.

opam pin add jekyll-format https://github.com/avsm/jekyll-format.git 

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 and run with:

dune runtest 

The resulting binaries are in _build/test.

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

Dependencies (11)

  1. ezjsonm >= "1.1.0"
  2. yaml < "3.0.0"
  3. fpath
  4. ptime
  5. rresult < "0.7.0"
  6. fmt
  7. omd
  8. astring
  9. result
  10. ocaml >= "4.05.0"
  11. dune >= "2.8"

Dev Dependencies (4)

  1. odoc with-doc
  2. bos with-test
  3. alcotest with-test
  4. yaml with-test & >= "2.0.0"

Used by

None

Conflicts

None