rimu 0.0.1

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

PRE-RELEASE SCAFFOLDING

THIS PACKAGE IS NOT YET IMPLEMENTED

Tentative release date: March 2020

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

Example usage:

import rimu;

def main():
  print(rimu.render('Hello *Rimu*!'))

See also Rimu API documentation.

CLI command

The Rimu CLI command is rimupy.

TODO: Run it using ...

Building

1. Clone source repo from Github:

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

2. Build and test:

    cd rimu-py/
    TODO
   

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.