Skip to content

koara/koara-js

Repository files navigation

Koara

Build Status Coverage Status Npm License

Koara-js

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

Getting started

  • Download ZIP file

  • Npm

    npm install @koara/koara --save-dev
  • Bower

    bower install koara

Usage

  • Node

    var koara = require('@koara/koara');
    var parser = new koara.Parser();
    var result1 = parser.parse("Hello World!"); // parse a string
  • Browser

    <!doctype html>
    <html>
      <body>
        <script type="text/javascript" src="koara.min.js"></script>
        <script type="text/javascript">
          var parser = new koara.Parser();
          var result1 = parser.parse("Hello World!"); // parse a string
        </script>
      </body>
    </html>

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