Index of values

body t retrieves the blog post content from the blog post

body_to_string body serialises the body to an OCaml string, maintaining the original layout and whitespace.

compare a b will compare by date and then lexigraphically on the title

date ?fname f will query the post date from the YAML metadata, and fallback to parsing the optional fname filename of the post if no explicit key is found.

date_exn ?fname f operates as Jekyll_format.date except that it raises a Jekyll_format.Parse_failure in the error case.

endhighlight s checks if a {% endhighlight %} tag is present.

extract_liquid_tag behaves as Jekyll_tags.extract_tag but is specialised to parse Jekyll liquid tags of the form {% ... %}.

extract_liquid_tags behaves as Jekyll_tags.extract_tags but is specialised to parse Jekyll liquid tags of the form {% ... %}.

extract_tag ?start ~start_tag ~stop_tag s will extract the indices that represents the text in "<start><ws><text><ws><stop>".

extract_tags ?start ~start_tag ~stop_tag s will extract the list of indices that represent the text in "<start_Tag><ws><text><ws><stop_tag>".

fields t retrieves the YAML front matter fields from the blog post

find key t retrieves the first key from the YAML front matter, and None if the key is not present.

highlight s attempts to parse the contents of a {% highlight %} tag.

highlight body parses the body for Jekyll ` tags and applies f to them and substitutes the result into the tag body.

highlight_markdown_code s will wrap the code in s in a Markdown code segment.

keys f retrieves all of the key names in the YAML front matter.

map_liquid_tag_bodies operates as Jekyll_tags.map_tag_bodies but is specialised to parse Jekyll liquid tags of the form {% ... %}.

map_liquid_tags ~f body behaves as Jekyll_tags.map_tags but is specialised to parse Jekyll liquid tags of the form {% ... %}.

map_tag ~sub tag_info body will substitute the tag_info (typically returned by Jekyll_tags.extract_tag with the value of sub

map_tag_bodies ~start_tag ~stop_tag ~f_start ~f_stop ~f_map body searches for tags delimited by start_tag and stop_tag.

map_tags ~start_tag ~stop_tag ~f body will apply the function f to all the tags found that match start_tag and stop_tag.

mk_highlight constructs a Jekyll_liquid.Tags.highlight value.

of_string t parses a Jekyll-format blog post and either returns a Jekyll_format.t or signals an error in the result.

of_string ?fname body

of_string_exn t parses a Jekyll-format blog post and either returns a Jekyll_format.t or raises a Jekyll_format.Parse_failure exception with the error string.

of_string_exn ?fname body operates as Jekyll_post.of_string except that it raises a Jekyll_format.Parse_failure exception on error.

parse_date ?and_time s parses a Jekyll format date field in YYYY-MM-DD HH:MM:SS +/-TT:TT format, where the HMS and timezone components are optional.

parse_date_exn ?and_time s operates as Jekyll_format.parse_date except that it raises a Jekyll_format.Parse_failure in the error case.

parse_filename f parses a Jekyll format filename YEAR-MONTH-DAY-title.MARKUP and returns the time, title and markup components respectively.

parse_filename_exn f operates as Jekyll_format.parse_filename except that it raises a Jekyll_format.Parse_failure in the error case.

pp t prints out the blog post and YAML front matter, using Jekyll_format.pp_fields and Jekyll_format.pp_body respectively.

pp_body body prints out the blog post body in the original layout.

pp_fields f prints out the YAML front matter in the original layout.

pp_highlight formats a Jekyll_liquid.Tags.highlight in human-readable format.

slug ?fname f will query the slug name from the YAML metadata, or calculate it from the filename if no explicit slug field is set, and finally fallback to parsing the Jekyll_format.title of the post if nothing else is found.

slug_exn ?fname f operates as Jekyll_format.slug except that it raises a Jekyll_format.Parse_failure in the error case.

slug_of_string s replaces all non-ascii characters (a..zA..Z0..9) with the - hyphen character.

title ?fname f will query the title from the YAML metadata, and fallback to parsing the optional fname filename of the post if no explicit key is found.

title_exn ?fname f operates as Jekyll_format.title except that it raises a Jekyll_format.Parse_failure exception on error.