Repository
Current version released
4 years ago
Versions
- 11.4.0Latest
- 11.3.0
- 11.2.0
- 11.1.14
- 11.1.13
- 11.1.12
- v3.0.10
- v3.0.9
- v3.0.8
- v3.0.7
- v3.0.6
- v3.0.5
- v3.0.4
- v3.0.3
- v3.0.2
- v3.0.1
- v3.0.0
- v2.1.4
- v2.1.3
- v2.1.2
- v2.1.1
- v2.1.0
- v2.0.2
- v2.0.1
- v2.0.0
- v1.0.5
- v1.0.4
- v1.0.3
- v1.0.2
- v1.0.1
- v1.0.0
- v0.9.0
- v0.8.4
- v0.8.3
- v0.8.2
- 11.1.11
- 11.1.10
- 11.1.9
- 11.1.8
- 11.1.7
- 11.1.6
- 11.1.5
- 11.1.4
- 11.1.3
- 11.1.1
- 11.1.0
- 11.0.0
- 10.4.2
- 10.4.1
- 10.4.0
- 10.3.1
- 10.3.0
- 10.2.0
- 10.1.0
- 10.0.0
- 9.3.0
- 9.2.0
- 9.1.3
- 9.1.2
- 9.1.1
- 9.1.0
- 9.0.3
- 9.0.2
- 9.0.1
- 9.0.0
- 8.0.1
- 8.0.0
- 7.3.0
- 7.2.1
- 7.2.0
- 7.1.0
- 7.0.3
- 7.0.2
- 7.0.1
- 7.0.0
- 6.1.0
- 6.0.0
- 5.4.0
- 5.3.0
- 5.2.0
- 5.1.0
- 5.0.0
- 4.0.1
- 4.0.0
- 3.4.2
- 3.4.1
- 3.4.0
- 3.3.1
- 3.3.0
- 3.2.2
- 3.2.1
- 3.2.0
- 3.1.0
- 3.0.12
- 3.0.11
- 0.8.1
- 0.8.0
- 0.7.3
- 0.7.2
- 0.7.1
- 0.7.0
- 0.6.6
- 0.6.5
- 0.6.3
- 0.6.2
- 0.6.1
Rimu Markup
Rimu is a readable-text to HTML markup language inspired by AsciiDoc and Markdown.
Features summary
- Markup generation can be customized and extended.
- Includes a simple, flexible macro language.
- HTML attribute injection and parametrized macros.
- Accepts raw HTML (a la Markdown).
- A subset of the Rimu syntax is Markdown compatible.
- Single JavaScript file (less than 22KB minified) that can be dropped onto a Web page or used as a Node module.
- No dependencies.
- One-function API.
- Written in TypeScript.
- Includes command-line compiler, JavaScript library, TypeScript library declaration file, playground GUI, Vim syntax highlighter and a unit test suite.
- MIT license.
- There is also a Kotlin port of Rimu for the JVM platform.
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.
Installing Rimu
Install Rimu as a Node.js module (includes the rimu library and the
rimuc command-line tool):
sudo npm install -g rimuRun a simple test from the command prompt to check rimuc is working:
echo 'Hello *Rimu*!' | rimucThis 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.gitInstall gh-pages sub-repository:
cd rimu git clone git@github.com:srackham/rimu.git -b gh-pages gh-pagesInstall dependencies:
npm installBuild Rimu:
jake build
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.
Browser compatibility
The generated HTML is compatible with all Web browsers. The Rimu JavaScript library works with IE11, Edge, Firefox, Chrome and Android.