rimu 11.1.7

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

A port of the Rimu Markup language written in the Python language.

Features

Functionally identical to the JavaScript implementation version 11.1 with the following exceptions:

• Does not support deprecated Expression macro values.
• Does not support deprecated Imported Layouts.

Usage

Install from PyPI:

pip3 install rimu

Example usage:

import rimu

print(rimu.render('*Hello World*!'))

See also Rimu API documentation.

CLI command

The Rimu CLI command installed by Pip is rimupy. CLI command example:

    echo 'Hello *Rimu*!' | rimupy

This will output:

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

Building

To build from source:

1. Clone source repo from Github:

    git clone [e-mail]:srackham/rimu-py.git
   

2. Create and initialize virtual environment:

    cd rimu-py/
    make init
   

3. Activate virtual environment:

    source .venv/bin/activate
   

4. Test and build:

    make build
   

Learn more

Read the documentation and experiment with Rimu in the Rimu Playground.

Implementation

• The largely one-to-one correspondence between the canonical TypeScript code and the Python code eased porting and debugging. This will also make it easier to cross-port new features and bug-fixes.

• All Rimu implementations share the same JSON driven test suites comprising over 300 compatibility checks.