package jekyll-format

  1. Overview
  2. Docs
Jekyll post parsing library

Install

Dune Dependency

Authors

Maintainers

Sources

jekyll-format-0.3.1.tbz
sha256=1587cb9f32772e4f22dbc933be0cef9d5aa55e6f666967220b56081f576a1f43
sha512=d3f5991c664ef7729d20ab3ff2ace67da4d8093e90bc17dae33566b15b6711de4f17d26ea067c7de6f7547708ad79e7438b56d22745f44ac1d2828ba6ad9c838

Description

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

Published: 03 Jun 2022

README

jekyll-format — Jekyll post parsing library

v0.3.1

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 (13)

  1. ezjsonm >= "1.1.0"
  2. fpath
  3. ptime
  4. rresult
  5. fmt >= "0.8.7"
  6. omd
  7. astring
  8. result
  9. sexplib
  10. yaml >= "3.0.0"
  11. yaml-sexp >= "3.0.0"
  12. ocaml >= "4.05.0"
  13. dune >= "2.9"

Dev Dependencies (3)

  1. odoc with-doc
  2. bos with-test
  3. alcotest with-test

Used by

None

Conflicts

None