/omd

an extensible Markdown tool in "pure OCaml"

Primary LanguageOCaml

OMD: a Markdown parser in OCaml

OMD implements a Markdown parser in OCaml.

OMD provides two things:

  1. the command-line tool omd, which takes some Markdown and converts it to HTML or Markdown.

    Use omd -help for more information on how to use it.

  2. the library for OCaml contains several modules:

    • the module Omd contains most functions a user will need for basic Markdown manipulation.
    • the modules Omd_parser, Omd_lexer, Omd_backend, Omd_representation and Omd_utils basically implement what their names say:
      • Omd_parser implements the parser (the hardest part).
      • Omd_lexer implements a (basic) lexer.
      • Omd_backend implements 3 backends:
        1. HTML: default backend.
        2. Markdown: sometimes it's useful to show that the fix-point is easily reachable.
        3. S-expression: it's mainly used for debugging.
      • Omd_representation declares the datatypes used in Omd. It also provides some functions to work on those datatypes.
      • Omd_utils provides some useful tools that are not very specific to the OMD-specific datatypes.

OMD aims at implementing the "original Markdown specs" with a few Github Flavour Markdown characteristics. OMD is also meant to be more "sane" than other Markdown parsers from the semantics point of view: if something bothers you from the semantics point of view, please open an issue.

Encoding

OMD assumes its input is US-ASCII or UTF-8 encoded.

Dependencies

OMD is implemented in OCaml, therefore it needs it to be compiled. OCaml 4.00.1 and then 4.01.0 have been used. OMD should be compatible with 3.12.0 as well, if it's not then please open an issue.

Usage

  • to install omd using opam (recommended)

    opam install omd

  • to get the development version of omd

    git clone git://github.com/pw374/omd.git

  • to compile omd

    • without oasis nor ocamlbuild

      cd omd/src && make

    • using oasis and ocamlbuild

      cd omd && make

Log

The recommended version numbers are typefaced in bold. As new releases come out and bugs are discovered, a version can stop being recommended.

  • 0.9.6: fix a bug (concerning extensions) introduced by 0.9.4.

    This version is recommended. If you need to have a version that still has Tag of extension instead of Tag of name * extension, you should use 0.9.3

  • 0.9.5: bug fix + Tag of extension changed to Tag of name * extension

  • 0.9.4: fixes a bug for the new feature

  • 0.9.3: new feature media:type="text/omd".

    This version is recommended if you do not use that new feature. Otherwise, it's strongly recommended that you use 0.9.6 instead.

  • 0.9.2: not released...

  • older versions: cf. commit log