Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/srackham/rimu-dart
A port of the Rimu Markup language written in the Dart language.
https://github.com/srackham/rimu-dart
asciidoc dart markdown rimu
Last synced: about 2 months ago
JSON representation
A port of the Rimu Markup language written in the Dart language.
- Host: GitHub
- URL: https://github.com/srackham/rimu-dart
- Owner: srackham
- License: mit
- Created: 2019-12-16T01:55:48.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2022-11-17T22:48:04.000Z (about 2 years ago)
- Last Synced: 2024-04-15T00:15:12.560Z (9 months ago)
- Topics: asciidoc, dart, markdown, rimu
- Language: Dart
- Homepage: https://srackham.github.io/rimu
- Size: 375 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
A port of the [Rimu Markup language](https://srackham.github.io/rimu/) written in the Dart
language.## Features
Functionally identical to the [TypeScript
implementation](https://github.com/srackham/rimu) version 11.4.x.## Using the Rimu package
The Rimu Dart package is hosted at [pub.dev](https://pub.dev/packages/rimu).
Example usage:``` dart
import 'package:rimu/rimu.dart';main(List arguments) {
print(render('Hello *Rimu*!'));
}
```See also Rimu [API documentation](https://srackham.github.io/rimu/reference.html#api).
## CLI command
The Dart port of the [Rimu CLI
command](https://srackham.github.io/rimu/reference.html#rimuc-command) can be
run as a script, for example:dart ./bin/rimuc.dart --version
Or compiled to a native executable, for example:
dart compile exe ./bin/rimuc.dart -o ~/local/bin/rimudart
## Building
1. Clone source repo from Github:git clone git@github.com:srackham/rimu-dart.git
2. Build and test:
cd rimu-dart/
dart pub get
make## 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).## Implementation
- The largely one-to-one correspondence between the canonical
[TypeScript code](https://github.com/srackham/rimu) and the Dart 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.