uniorg-parse/README.md

uniorg plugin to parse org-mode

# `uniorg-parse`

[Org-mode](https://orgmode.org/) parser compatible with [unified](https://github.com/unifiedjs/unified) ecosystem.

## Install

```sh
npm install uniorg-parse
```


## Use

```js
var unified = require('unified')
var createStream = require('unified-stream')
var uniorgParse = require('uniorg-parse')
var uniorg2rehype = require('uniorg-rehype')
var html = require('rehype-stringify')

var processor = unified().use(uniorgParse).use(uniorg2rehype).use(html)

process.stdin.pipe(createStream(processor)).pipe(process.stdout)
```


## API


### `processor().use(uniorgParse, [, options])`

Configure the `processor` to read Org as input and process **[uniorg](https://github.com/rasendubi/uniorg)** syntax trees.


### `parse(string[, options])`

Parse string.

```js
import { parse } from 'uniorg-parse/lib/parser';

console.log(parse('* example document'))
```


## License

[GNU General Public License v3.0 or later](./LICENSE)