runme

Runme.js

A JavaScript module to use Runme in Node.js, Deno or browser environments.

Runme.js contains the the Runme CLI as WASM and allows to access its functionality through a simple JavaScript interface.

Install

You can run this module in Node.js and Deno environments.

Node.js

Install the module through NPM:

$ npm install runme
# or Yarn
$ yarn add runme

Deno

You can import the module directly through e.g. esm.sh:

import { parse } from 'https://esm.sh/runme@0.1.0'

Usage

The module exposes the following methods:

parse

Parse markdown into AST:

import { parse } from 'runme'

console.log(await parse('## Hello World\n'))
/**
 * outputs:
 * [{ markdown: '## Hello World' }]
 */

---

Copyright 2022 © Stateful – Apache 2.0 License