Rimu Markup

Rimu is a readable-text to HTML markup language inspired by AsciiDoc and Markdown.

At its core Rimu is a simple readable-text markup similar in scope to Markdown, but with two additional areas of functionality (both built into the Rimu markup syntax):

Learn more

Read the documentation and experiment with Rimu in the Rimu Playground or open the rimuplayground.html file locally in your browser.

See the Rimu Change Log for the latest changes.

NOTE: The remainder of this document is specific to the JavaScript port.

Quick start

To try the Rimu library in your browser:

  1. Open the Rimu NPM Runkit page in your browser.
  2. Paste in this code then press the Run button.
    var rimu = require("rimu")
    var html = rimu.render('Hello *Rimu*!')

This will output "<p>Hello <em>Rimu</em>!</p>".

Installing Rimu

Install Rimu as a Node.js module (includes the rimu library and the rimuc command-line tool):

sudo npm install -g rimu

Run a simple test from the command prompt to check the rimuc CLI command is working:

echo 'Hello *Rimu*!' | rimuc

This should output:

<p>Hello <em>Rimu</em>!</p>

Building Rimu

To build Rimu and the Rimu documentation from source:

  1. Install the Git repository from Github.
    git clone git@github.com:srackham/rimu.git
  2. Install dependencies:
    cd rimu
    npm install
  3. Build Rimu:
    jake build