Skip to content

koara/koara-rb

Repository files navigation

Koara

Build Status Coverage Status Gem License

Koara-rb

Koara is a modular lightweight markup language. This project is the core koara parser written in Ruby. If you are interested in converting koara to a specific outputFormat, please look the Related Projects section.

Getting started

gem install koara

Usage

require 'koara'

parser = Koara::Parser.new
result1 = parser.parse('Hello World!') # parse a string

Configuration

You can configure the Parser:

  • parser.modules
    Default: ["paragraphs", "headings", "lists", "links", "images", "formatting", "blockquotes", "code"]

    Specify which parts of the syntax are allowed to be parsed. The rest will render as plain text.

Related Projects