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:
- Open the Rimu NPM Runkit page in your browser.
- Paste in this code then press the Run button.This will output
var rimu = require("rimu") var html = rimu.render('Hello *Rimu*!')
"<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:
Install the Git repository from Github.
git clone git@github.com:srackham/rimu.git
Install dependencies:
cd rimu npm install
Build Rimu:
jake build