Getting Started


This page is a WIP

The minimal setup you need for orga to work is @orgajs/reorg, it is a unified parser.

To simply compile org-mode content into html.

npm install @orgajs/reorg @orgajs/reorg-rehype rehype-stringify unified-stream
// compile.js
const stream = require('unified-stream')
const reorg = require('@orgajs/reorg')
const mutate = require('@orgajs/reorg-rehype')
const html = require('rehype-stringify')

const processor = reorg()
      .use(mutate)
      .use(html)

process.stdin.pipe(stream(processor)).pipe(process.stdout)

Given that you have a org-mode file readme.org.

node compile.js < readme.org > readme.html

Take a look at the getting started example project.