# mork

[![Package Version](https://img.shields.io/hexpm/v/mork)](https://hex.pm/packages/mork)
[![Hex Docs](https://img.shields.io/badge/hex-docs-ffaff3)](https://hexdocs.pm/mork/)

__MÖRK__ is a Markdown parser written in pure Gleam, with the ambition to be
100% spec compliant with Commonmark and eventually to implement all of the
GFM Markdown extensions as well.

It has mainly been developed for the Erlang compilation target, but is tested
against and should work for both Node.js and Deno as Javascript runtimes. Bun is
not yet supported due to an upstream crash bug.

NOTE: This is a very early release of a new implementation of the Commonmark
spec, not using the C or javascript implementations at all. As such, it is
guaranteed to have bugs, differences in output and poor performance. Buyer
beware.

## Status

- All Commonmark spec tests are passing.
- Supports reference footnote syntax[^footnotes].

## Example

```sh
gleam add mork@1
```
```gleam
import simplifile
import mork

pub fn main() -> Nil {
  let readme = "./README.md"
  let assert Ok(markdown) = simplifile.read(from: readme)
  let html = markdown |> mork.parse |> mork.to_html
  let assert Ok(_) = html |> simplifile.write(to: "README.html")
}
```

Further documentation can be found at <https://hexdocs.pm/mork>.

## Development

```sh
gleam build        # Build the project
gleam test         # Run the tests
gleam test tabs    # Run only the Tabs section of tests
gleam test tabs 9  # Run only example number 9 from the test section
gleam test custom  # Run only extra tests (not from the spec)
```

## Requirements (Erlang)

- Gleam 1.13+
- Erlang 28+ (due to PCRE2 usage)

## Requirements (Javascript)

- Gleam 1.13+


[^footnotes]: <https://www.markdownguide.org/extended-syntax/#footnotes>