# koara-html

> Koara to Html 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-html
pnpm add koara-html
yarn add koara-html
bun add koara-html
```

## 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 | 2016-03-29 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 0.10.0 |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Andy Van Den Heuvel |
| Maintainers | codeaddslife |
| Keywords | koara, markup, html |

## Links

- npm: https://www.npmjs.com/package/koara-html
- 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-html

## Dependencies (1)

- [koara](https://npm.io/package/koara.md) ^0.14.0

## Alternatives

- [@tsparticles/shape-image](https://npm.io/package/@tsparticles/shape-image.md) — 303.7K weekly downloads
- [@tsparticles/shape-line](https://npm.io/package/@tsparticles/shape-line.md) — 233.7K weekly downloads
- [stringify-attributes](https://npm.io/package/stringify-attributes.md) — 58.6K weekly downloads
- [mobile-drag-drop](https://npm.io/package/mobile-drag-drop.md) — 46.3K weekly downloads
- [@comunica/actor-rdf-parse-html](https://npm.io/package/@comunica/actor-rdf-parse-html.md) — 29.2K weekly downloads

## Recent versions

- 0.14.0 (latest) — 2016-12-26
- 0.13.0 — 2016-08-14
- 0.12.0 — 2016-06-20
- 0.10.0 — 2016-04-14
- 0.9.3 — 2016-03-29

## README

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

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

# Koara-js-html
[Koara](http://www.koara.io) is a modular lightweight markup language. This project can render the koara AST to Html in Javascript.  
The AST is created by the [core koara parser](https://github.com/koara/koara-js).

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

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

  ```xml
  bower install koara-html
  ```

## Usage
- Node

  ```js
  var koara = require('koara');
  var koaraHtml = require('koara-html');

  var parser = new koara.Parser();
  var result = parser.parse("Hello World!");
  var renderer = new koaraHtml.Html5Renderer();
  result.accept(renderer);
  console.log(renderer.getOutput());
  ```
  
- Browser
  
  ```js
  <!doctype html>
  <html>
    <body>
      <script type="text/javascript" src="koara.min.js"></script>
      <script type="text/javascript" src="koara-html.min.js"></script>
      <script type="text/javascript">
        var parser = new koara.Parser();
        var result = parser.parse("Hello World!");
        var renderer = new koaraHtml.Html5Renderer();
        result.accept(renderer);
        document.write(renderer.getOutput());
      </script>
    </body>
  </html>
  ```

## Configuration
You can configure the Renderer:
-  **renderer.hardWrap**  
   Default:	`false`
   
   Specify if newlines should be hard-wrapped (return-based linebreaks) by default.

-  **renderer.partial**  
   Default:	`true`
   
   When false, the output will be wrapped with a `<html>` and `<body>` tag to make a complete Html document.

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