{"id":19916840,"url":"https://github.com/srackham/rimu-kt","last_synced_at":"2026-05-06T19:40:51.207Z","repository":{"id":39737799,"uuid":"99287737","full_name":"srackham/rimu-kt","owner":"srackham","description":"Rimu Markup for the JVM","archived":false,"fork":false,"pushed_at":"2022-11-20T07:03:03.000Z","size":468,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-01-11T23:34:30.574Z","etag":null,"topics":["asciidoc","java","kotlin","markdown","rimu"],"latest_commit_sha":null,"homepage":"https://srackham.github.io/rimu","language":"Kotlin","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/srackham.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-08-04T00:56:55.000Z","updated_at":"2022-06-03T09:38:33.000Z","dependencies_parsed_at":"2023-01-22T02:37:10.295Z","dependency_job_id":null,"html_url":"https://github.com/srackham/rimu-kt","commit_stats":null,"previous_names":[],"tags_count":17,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/srackham%2Frimu-kt","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/srackham%2Frimu-kt/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/srackham%2Frimu-kt/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/srackham%2Frimu-kt/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/srackham","download_url":"https://codeload.github.com/srackham/rimu-kt/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241347252,"owners_count":19948121,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["asciidoc","java","kotlin","markdown","rimu"],"created_at":"2024-11-12T21:47:47.306Z","updated_at":"2025-11-24T03:02:13.333Z","avatar_url":"https://github.com/srackham.png","language":"Kotlin","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Rimu Markup for the JVM\n\n_rimu-kt_ is a port of the [Rimu Markup\nlanguage](https://srackham.github.io/rimu/) for the Java platform written in\n[Kotlin](https://kotlinlang.org/). It is functionally identical to the canonical\n[TypeScript implementation](https://github.com/srackham/rimu).\n\n## Using the Rimu library\nThe Rimu Kotlin library package is can be installed from the\n[JitPack](https://jitpack.io/#srackham/rimu-kt) Maven repository.\nTo use the `rimu-kt` library in a Gradle based project you need to\ninclude the JitPack repository and the `rimu-kt` dependency in your project's\n`build.gradle.kts` file e.g.\n\n``` kotlin\nrepositories {\n    mavenCentral()\n    maven(\"https://jitpack.io\")\n}\n\ndependencies {\n    testImplementation(kotlin(\"test\"))\n    implementation(\"com.github.srackham:rimu-kt:11.4.0\")\n}\n```\nThe above code is taken from the [Minimal Rimu Kotlin\nApplication](https://github.com/srackham/rimu-kotlin-example) on GitHub.\n\nMore examples:\n\n- [Kotlin examples](https://github.com/srackham/rimu-kt/blob/master/src/test/kotlin/KotlinExamplesTest.kt)\n- [Java examples](https://github.com/srackham/rimu-kt/blob/master/src/test/java/JavaExamplesTest.java)\n\n\n## Building rimu-kt\nTo build from source:\n\n1. Install the Git repository from [Github](https://github.com/srackham/rimu-kt).\n\n        git clone https://github.com/srackham/rimu-kotlin-example.git\n\n2. Build and test:\n\n        ./gradlew clean test\n\n## rimukt CLI\nThe CLI executable is named `rimukt` and is functionally identical to the\n[rimuc](https://srackham.github.io/rimu/reference.html#rimuc-command)\ncommand.\n\nThe Gradle `installDist` task builds Rimu CLI command startup scripts: `rimukt`\n(for Linux) and `rimukt.bat` (for Windows). These scripts are located in the\n`./build/install/rimukt/bin` directory:\n\n    ./gradlew installDist\n    ./build/install/rimukt/bin/rimukt --version\n    echo '**Hello World!**' | ./build/install/rimukt/bin/rimukt\n\nThe last command outputs:\n\n    \u003cp\u003eHello \u003cem\u003eRimu\u003c/em\u003e!\u003c/p\u003e\n\n## Implementation\nThe one-to-one correspondence between the canonical\n[TypeScript code](https://github.com/srackham/rimu) and the Kotlin\ncode eased porting and debugging.  This also makes it easier to\ncross-port new features and bug-fixes.\n\nBoth the Kotlin and the TypeScript implementations share the same JSON\ndriven test suites comprising over 300 compatibility checks.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsrackham%2Frimu-kt","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsrackham%2Frimu-kt","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsrackham%2Frimu-kt/lists"}