/node-orgmode

The orgmode implementation for Node.js which contains a search engine and a parser written in Parser Combinator

Primary LanguageJavaScript

node-orgmode

NPM version Build status Dependency Status Downloads

The orgmode implementation for Node.js which contains:

  • A parser for orgmode based on the monadic LL(infinity) parser combinator library jneen/parsimmon
  • A simple search engine for outlines

Installation

npm install orgmode --save

Usage

const Orgmode = require('orgmode');
const document = new Orgmode('./path/to/your/document.org');

document.overview   // this is a getter for your document's OVERVIEW option
document.findByLevel(1) // you will get both level 1 outlines in array

API

To see the complete API documentation, see API Documentation.

NPM Commands

Run Tests

$ npm test

Release Documentation

$ npm docs

License

MIT