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):

  • Markup generation can be customized and extended.
  • Rimu includes a simple, flexible macro language.
  • A subset of Rimu syntax is Markdown compatible.
  • The generated HTML is compatible with all modern browsers.
  • A number of Rimu implementations are available for various languages and runtime environments.

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.
    const rimu = require("rimu")
const 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).

Linux, macOS

    sudo npm install -g rimu

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

    $ echo 'Hello *Rimu*!' | rimuc
    <p>Hello <em>Rimu</em>!</p>

Windows

    npm install -g rimu
    npm link

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

    > echo "Hello *Rimu*!" | rimuc.cmd
    <p>Hello <em>Rimu</em>!</p>

Building Rimu and the Rimu documentation

  1. Install the Git repository from Github.

     git clone https://github.com/srackham/rimu.git

  2. Install dependencies:

     cd rimu
 npm install

  3. Build Rimu using either Jake or Drake (NOTE 1):

     jake build     # Linux, macOS.
 drake build    # Linux, macOS, Windows (NOTE 1)

NOTE 1: Rimu is moving to the Drake project builder and includes a platform independent drakefile. Drake should build Rimu on all platforms but may be unstable (the rapidly evolving Deno runtime is currently an alpha release).