# koara

> Koara parser written in Javascript

Latest version **0.14.0** (published 2016-12-26) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install koara
pnpm add koara
yarn add koara
bun add koara
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.14.0 |
| Published | 2016-12-26 |
| First published | 2014-10-17 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 0.10.0 |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Andy Van Den Heuvel |
| Maintainers | codeaddslife |
| Keywords | koara, markup, html, xml |

## Links

- npm: https://www.npmjs.com/package/koara
- Repository: https://github.com/koara/koara-js
- Homepage: http://www.koara.io
- Issues: https://github.com/koara/koara-js/issues
- npm.io page: https://npm.io/package/koara

## Alternatives

- [babylon](https://npm.io/package/babylon.md) — 5.1M weekly downloads
- [csscolorparser](https://npm.io/package/csscolorparser.md) — 3.7M weekly downloads
- [expr-eval-fork](https://npm.io/package/expr-eval-fork.md) — 1.5M weekly downloads
- [@leeoniya/ufuzzy](https://npm.io/package/@leeoniya/ufuzzy.md) — 247.7K weekly downloads
- [xml-parser](https://npm.io/package/xml-parser.md) — 78.4K weekly downloads

## Recent versions

- 0.14.0 (latest) — 2016-12-26
- 0.13.0 — 2016-08-14
- 0.12.0 — 2016-06-20
- 0.11.0 — 2016-04-27
- 0.10.0 — 2016-03-30
- 0.9.3 — 2016-03-29
- 0.6.2 — 2016-03-22
- 0.6.1 — 2016-03-08
- 0.5.9 — 2014-10-17
- 0.5.8 — 2014-10-17

## README

[![Koara](http://www.koara.io/logo.png)](http://www.koara.io)

[![Build Status](https://img.shields.io/travis/koara/koara-js.svg)](https://travis-ci.org/koara/koara-js)
[![Coverage Status](https://img.shields.io/coveralls/koara/koara-js.svg)](https://coveralls.io/github/koara/koara-js?branch=master)
[![Npm](https://img.shields.io/npm/v/koara.svg?maxAge=2592000)]()
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://github.com/koara/koara-js/blob/master/LICENSE)

# Koara-js
[Koara](http://www.koara.io) 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](#related-projects) section.

## Getting started
- Download [ZIP file](https://github.com/koara/koara-js/archive/0.14.0.zip)
- Npm

  ```bash
  npm install koara --save-dev
  ```
  
- Bower

  ```xml
  bower install koara
  ```

## Usage
- Node

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

- Browser

  ```js
  <!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

- [koara / koara-js-html](http://www.github.com/koara/koara-js-html): Koara to Html renderer written in Javascript
- [koara / koara-js-xml](http://www.github.com/koara/koara-js-html): Koara to Xml renderer written in Javascript

---
_Source: https://npm.io/package/koara · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
