# org

> A parser and converter for org-mode notation

Latest version **0.2.0** (published 2015-02-21) · 0 weekly downloads

## Install

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

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.0 |
| Published | 2015-02-21 |
| First published | 2014-01-01 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 575 |
| Author | Masafumi Oyamada |
| Maintainers | mooz |
| Keywords | org-mode, emacs, parser |

## Links

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

## 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.2.0 (latest) — 2015-02-21
- 0.1.0 — 2014-11-23
- 0.0.5 — 2014-01-03
- 0.0.4 — 2014-01-02
- 0.0.3 — 2014-01-01
- 0.0.2 — 2014-01-01

## README

org-js
======

Parser and converter for org-mode (<http://orgmode.org/>) notation written in JavaScript.

Interactive Editor
------------------

For working example, see http://mooz.github.com/org-js/editor/.

Installation
------------

    npm install org

Simple example of org -> HTML conversion
----------------------------------------

```javascript
var org = require("org");

var parser = new org.Parser();
var orgDocument = parser.parse(orgCode);
var orgHTMLDocument = orgDocument.convert(org.ConverterHTML, {
  headerOffset: 1,
  exportFromLineNumber: false,
  suppressSubScriptHandling: false,
  suppressAutoLink: false
});

console.dir(orgHTMLDocument); // => { title, contentHTML, tocHTML, toc }
console.log(orgHTMLDocument.toString()) // => Rendered HTML
```

Writing yet another converter
-----------------------------

See `lib/org/converter/html.js`.

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