Git Product home page Git Product logo

mint-micromark's Introduction

Mint Micromark

CI

Mint package for converting markdown to html. Uses Micromark under the hood.

Basic usage

The easiest way to use Micromark is with Micromark.Component:

component Main {
  fun render {
    <Micromark.Component content="# Hello world"/>
  }
}

Extensions

You can enable extensions to unlock additional functionality:

component Main {
  fun render {
    <Micromark.Component
      extensions=[Micromark.Extension::Gfm]
      content="~~strikethrough~~"/>
  }
}

Advanced usage

If you want to directly access micromark, you can use the Micromark.load API

component Main {
  state micromark : Maybe(Function(String, String)) = (content: String) {content}

  fun componentDidMount {
    let micromark =
      await Micromark.load([Micromark.Extension::Gfm])

    next { micromark: Maybe::Just(micromark) }
  }

  fun render {
    case micromark {
      => <></>

      Maybe::Just(micromark) =>
        {
          let html =
            micromark(content)

          <div dangerouslySetInnerHTML={`{__html: #{html}}`}/>
        }
    }
  }
}

Why this package?

Mint supports out of the box markdown rendering using a here doc:

<<#MARKDOWN
# Hello world!
MARKDOWN

This is an amazing feature and great for simple markdown.

However, the Crystal shard used to enable this feature doesn't have support for some popular markdown extensions like GFM.

Goals

  • Be extremely easy to use
  • On-demand loading - extensions and css are optional and loaded on demand

Non-goals

  • Be fully featured. This package intentionally uses Micromark as the underlying markdown engine because micromark about as minimal as it can get.

mint-micromark's People

Contributors

farism avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.