Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

uniorg-parse

rasendubi888GPL-3.0-or-later3.2.0TypeScript support: included

uniorg plugin to parse org-mode

uniorg, unified, plugin, org-mode, parse

readme

uniorg-parse

Org-mode parser compatible with unified ecosystem.

Install

npm install uniorg-parse

Use

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 syntax trees.

parse(string[, options])

Parse string.

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

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

License

GNU General Public License v3.0 or later