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.
- Rimu is fast (same speed as marked 0.3.2 compiling Rimu
- No dependencies.
- One-function API.
- Features include raw HTML (a la Markdown), HTML attribute injection and parametrized macros.
- Element syntax and behavior can be modified and extended.
- Written in TypeScript.
- MIT license.
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.
Install Rimu as a Node.js module (includes the
rimu library and the
rimuc command-line tool):
sudo npm install -g rimu
To build Rimu and the Rimu documentation from source:
- Install the Git repository from Github.
git clone firstname.lastname@example.org:srackham/rimu.git
- Install gh-pages sub-repository:
cd rimu git clone email@example.com:srackham/rimu.git -b gh-pages gh-pages
- Install dependencies:
- Build Rimu:
Using the Rimu library
- First read the Rimu API documentation.
- A minimal TypeScript example minimal-example.ts.
- Rimu includes the rimuc command-line tool and the Rimu Playground — examples of using Rimu in Node.js and in the browser respectively.
- A simple Chrome browser extension for rendering Rimu Markup files directly in the browser.