Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ocaml/omd
extensible Markdown library and tool in "pure OCaml"
https://github.com/ocaml/omd
Last synced: about 1 month ago
JSON representation
extensible Markdown library and tool in "pure OCaml"
- Host: GitHub
- URL: https://github.com/ocaml/omd
- Owner: ocaml
- License: isc
- Created: 2013-07-12T14:25:34.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2024-07-02T04:25:40.000Z (5 months ago)
- Last Synced: 2024-09-30T06:23:30.183Z (about 2 months ago)
- Language: OCaml
- Homepage:
- Size: 2.43 MB
- Stars: 156
- Watchers: 15
- Forks: 45
- Open Issues: 26
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGES.md
- License: LICENSE
Awesome Lists containing this project
- awesome-list - omd
README
`omd`: Markdown library and tool in OCaml
=========================================
Omd is an OCaml library designed to parse, manipulate, and print Markdown into
different formats. In addition to the library, a command-line tool `omd` is
included to easily convert markdown into HTML.
Omd aims for compliance with the [CommonMark](https://commonmark.org/) standard.
We are currently compliant with [0.30 of the ComonMark
spec](https://spec.commonmark.org/0.30/).
Omd is developed on GitHub. If you need to report an issue, please do so at
https://github.com/ocaml/omd/issues.
Installation
------------
The recommended way to install `omd` is via the [opam package manager][opam].
You can install versions published to opam with:
```sh
$ opam install omd
```
You can install the current development version from the GitHub repository with
```sh
$ opam pin [email protected]:ocaml/omd.git
```
Documentation
-------------
- View API docs online: https://ocaml.github.io/omd
- View the API docs locally: `odig doc omd`
Building from source
--------------------
You can also build it manually from source with:
```sh
$ git clone https://github.com/ocaml/omd.git
$ cd omd
$ make build
```
You can run the test suite with
```sh
$ make test
```
Dependencies
------------
The minimum version of OCaml required is 4.13.
Dependencies are tracked in the [dune-project](./dune-project) and can be
installed by running:
```sh
$ opam install . --deps-only
# or
$ make deps
```
History
-------
Omd 1 was developed by [Philippe Wang](https://github.com/pw374/) at [OCaml
Labs](http://ocaml.io/) in [Cambridge](http://www.cl.cam.ac.uk).
Its development was motivated by at least these facts:
- We wanted an OCaml implementation of Markdown; some OCaml parsers of Markdown
existed before but they were incomplete. It's easier for an OCaml project to
depend on an pure-OCaml implementation of Markdown than to depend some
interface to a library implemented using another language, and this is ever
more important since [Opam](https://opam.ocaml.org) exists.
- We wanted to provide a way to make the contents of the
[OCaml.org](http://ocaml.org/) website be essentially in Markdown instead of
HTML. And we wanted to this website to be implemented in OCaml.
- Having an OCaml implementation of Markdown is virtually mandatory for those
who want to use a Markdown parser in a [Mirage](http://www.openmirage.org)
application. Note that OMD has replaced the previous Markdown parser of
[COW](https://github.com/mirage/ocaml-cow), which has been developed as part
of the Mirage project.
Omd 2 started development in 2020, beginning [Nicolás Ojeda
Bär](https://github.com/nojb)'s redesign and rewrite, and is currently ongoing.
Omd 2 has yet to reach feature parity with Omd 1.
Thanks
------
Special thanks for feedback and contributions to this project goes out to:
- [Christophe Troestler](https://github.com/Chris00)
- [Ashish Argawal](https://github.com/agarwal)
- [Sebastien Mondet](https://github.com/smondet)
- [Thomas Gazagnaire](https://github.com/samoht)
- [Daniel Bünzli](https://github.com/dbuenzli)
- [Amir Chaudry](https://github.com/amirmc)
- [Anil Madhavapeddy](https://github.com/avsm/)
- [David Sheets](https://github.com/dsheets/)
- [Jeremy Yallop](https://github.com/yallop/)
- [Nicolás Ojeda Bär](https://github.com/nojb)
- [Raphael Sousa Santos](https://sonologi.co/)
- [Corentin Leruth](https://github.com/tatchi)
- [Bob Atkey](https://bentnib.org/)
- *please insert your name here if you believe you've been forgotten*