https://github.com/anisjonischkeit/bs-marky-markdown

Bucklescript bindings for marky-markdown
https://github.com/anisjonischkeit/bs-marky-markdown

Last synced: 2 days ago
JSON representation

Bucklescript bindings for marky-markdown

• Host: GitHub
• URL: https://github.com/anisjonischkeit/bs-marky-markdown
• Owner: anisjonischkeit
• Created: 2019-03-11T17:45:32.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2021-08-10T22:29:16.000Z (over 3 years ago)
• Last Synced: 2024-08-09T19:19:39.410Z (3 months ago)
• Language: C++
• Size: 134 KB
• Stars: 2
• Watchers: 3
• Forks: 0
• Open Issues: 7
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# bs-marky-markdown

[marky-markdown](http://npm.im/marky-markdown) bindings for [BuckleScript](https://bucklescript.github.io) in [Reason](https://reasonml.github.io).

Has only been tested in the browser.

# Installation

```

npm i bs-marky-markdown -s

```

# Usage

## Basic usage

```reasonml

let htmlStr = MarkyMarkdown.make("# My Markdown String")

```

## With Options

```reasonml

let htmlStr = MarkyMarkdown.(

  make(~options=options(~highlightSyntax=false, ()), "# My Markdown String")

)

```

# Available Options

- [x] sanitize: bool

- [x] nofollow: bool

- [x] linkify: bool

- [x] highlightSyntax: bool

- [x] prefixHeadingIds: bool

- [x] enableHeadingLinkIcons: bool

- [x] serveImagesWithCDN: bool

- [x] debug: bool

- [ ] package (what even is this??)

- [x] headingAnchorClass: string

- [x] headingSvgClass: array(string)