https://github.com/srackham/go-rimu

A port of the Rimu Markup language written in the Go language.
https://github.com/srackham/go-rimu

asciidoc go golang markdown rimu

Last synced: 4 months ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/srackham/go-rimu
• Owner: srackham
• License: mit
• Created: 2018-09-07T03:11:50.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2025-01-21T02:08:33.000Z (over 1 year ago)
• Last Synced: 2025-04-28T00:14:36.680Z (about 1 year ago)
• Topics: asciidoc, go, golang, markdown, rimu
• Language: Go
• Homepage: https://srackham.github.io/rimu
• Size: 430 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Rimu Markup for Go

_go-rimu_ is a port of the [Rimu Markup

language](https://github.com/srackham/rimu) written in the Go language.

## Features

Functionally identical to the [JavaScript

implementation](https://github.com/srackham/rimu) version 11.4 with

the following exceptions:

-   Because the Go `regexp` package uses RE2 regular expressions there are

    [some limitations](https://srackham.github.io/rimu/reference.html#regular-expressions)

    on the regular expressions used in Replacements definitions and

    Inclusion/Exclusion macro invocations.

## Installation

Download, build, test and install (requires Go 1.17 or better):

    git clone https://github.com/srackham/go-rimu.git

    cd go-rimu

    make

## Using the go-rimu library

Example usage:

```go

package main

import (

    "fmt"

    "github.com/srackham/go-rimu/v11/rimu"

)

func main() {

    // Prints "
Hello Rimu!
"

    fmt.Println(rimu.Render("*Hello Rimu*!", rimu.RenderOptions{}))

}

```


To compile and run this simple application:

1.  Copy the code above to a file named `hello-rimu.go` and put it in an empty

    directory.

2.  Change to the directory and run the following Go commands:

        go mod init example.com/hello-rimu

        go mod tidy

        go run hello-rimu.go

See also Rimu

[API documentation](https://srackham.github.io/rimu/reference.html#api).

## Rimu CLI command

The [Rimu CLI command](https://srackham.github.io/rimu/reference.html#rimuc-command) is named

`rimugo`.

## Learn more

Read the [documentation](https://srackham.github.io/rimu/reference.html) and

experiment with Rimu in the [Rimu

Playground](http://srackham.github.io/rimu/rimuplayground.html).

See the Rimu [Change

Log](http://srackham.github.io/rimu/changelog.html) for the latest

changes.

## Implementation

-   The largely one-to-one correspondence between the canonical

    [TypeScript code](https://github.com/srackham/rimu) and the Go 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.