Skip to content
Bucklescript bindings for marky-markdown
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
src
.gitignore
README.md
bsconfig.json
package-lock.json
package.json

README.md

bs-marky-markdown

marky-markdown bindings for BuckleScript in Reason.

Has only been tested in the browser.

Installation

npm i bs-marky-markdown -s

Usage

Basic usage

MarkyMarkdown.marky("# My Markdown String", ())

With Options

MarkyMarkdown.marky(
    "# My Markdown String", 
    ~options=MarkyMarkdown.options(
        ~highlightSyntax=false, 
        ()
    ), 
    ()
)

Available Options

  • sanitize: bool
  • nofollow: bool
  • linkify: bool
  • highlightSyntax: bool
  • prefixHeadingIds: bool
  • enableHeadingLinkIcons: bool
  • serveImagesWithCDN: bool
  • debug: bool
  • package (what even is this??)
  • headingAnchorClass: string
  • headingSvgClass: array(string)
You can’t perform that action at this time.