This README is the one indexed from the repository at its latest ref, not from the tag for this version.

cr-discount

A crystal wrapper for Discount, a Markdown implementation

Installation

1. Add the dependency to your shard.yml:

   dependencies:
     cr-discount:
       github: ralsina/cr-discount

2. Run shards install

Usage

require "cr-discount"

You can use Discount to compile markdown to HTML like this:

      markdown = "This *is* **markdown**"
      html = Discount.compile(markdown)

This is the whole API:

  # Compile `text` from Markdown to HTML
  def self.compile(
    text : String,
    with_toc : Bool = false,
    flags = LibDiscount::MKD_FENCEDCODE | LibDiscount::MKD_TOC
  )

• with_toc adds a simple table of contents at the beginning of the returned HTML
• flags can be any combination of the flags in the discount docs

Development

I am not planning on developing this much further since it already does what I want :-)

Contributing

1. Fork it (https://github.com/ralsina/cr-discount/fork)
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create a new Pull Request

Contributors

• Roberto Alsina - creator and maintainer