README.md · rowtype-yoga/purescript-mdast-util-from-markdown

git.iko.soy/rowtype-yoga/purescript-mdast-util-from-markdown

rowtype-yoga/purescript-mdast-util-from-markdown/README.md

32 lines 1.0 kB history raw

1# purescript-mdast

3Purescript wrapper for [mdast-util-from-markdown](https://github.com/syntax-tree/mdast-util-from-markdown). `mdast-util-from-markdown` allows you to parse markdown into a markdown abstract syntaxt tree.

5## Usage

7Due to mdast being esm only, you will have to install the [`mdast-util-from-markdown-face`](./mdast-util-from-markdown-facade/) node module from this repo.

9```bash

10# clone this repo

11git clone https://github.com/sigma-andex/purescript-mdast-util-from-markdown.git

12```

14Add the repo to your `packages.dhall`

16```dhall

17let upstream = ...

18 with mdast-util-from-markdown = ../purescript-mdast-util-from-markdown/spago.dhall as Location // You might need to adapt this path

20```

22Install `mdast-util-from-markdown` with spago:

23```bash

24spago install mdast-util-from-markdown

25```

27Add the `mdast-util-from-markdown-facade` to your `package.json`

29```json

30"mdast-util-from-markdown-facade": "file:../purescript-mdast-util-from-markdown/mdast-util-from-markdown-facade",

31```