https://github.com/srackham/rimu-deno
A port of the Rimu Markup language to the Deno runtime.
https://github.com/srackham/rimu-deno
asciidoc deno markdown rimu rimu-markup-language typescript
Last synced: about 2 months ago
JSON representation
A port of the Rimu Markup language to the Deno runtime.
- Host: GitHub
- URL: https://github.com/srackham/rimu-deno
- Owner: srackham
- Created: 2020-01-24T03:10:24.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2020-04-03T20:51:32.000Z (about 6 years ago)
- Last Synced: 2025-04-28T00:14:39.253Z (about 1 year ago)
- Topics: asciidoc, deno, markdown, rimu, rimu-markup-language, typescript
- Language: TypeScript
- Size: 172 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Rimu Markup for Deno
___
## **NOTE:** This project has merged with the Rimu TypeScript codebase and is no longer active. Please visit https://github.com/srackham/rimu for the latest version of Rimu for Deno.
___
A port of the [Rimu Markup language](https://srackham.github.io/rimu/) to the
[Deno](https://deno.land/) runtime.
**NOTE**: This is a development release. A production release will follow once Deno has
reached 1.0.
If you experience compilation errors try forcing a cache reload
with the Deno `fetch` command e.g. `deno fetch Drakefile.ts --reload`
Tested with Deno 0.38.0 running on Ubuntu 18.04.
## Features
Functionally identical to the [Rimu JavaScript
implementation](https://github.com/srackham/rimu) version 11.1 with the
following exceptions:
- Does not support deprecated _Expression macro values_.
- Does not support deprecated _Imported Layouts_.
## API
Example usage:
``` typescript
import * as rimu from "https://raw.github.com/srackham/rimu-deno/master/mod.ts";
console.log(rimu.render("Hello *Rimu*!"));
```
Save the above code as file `minimal-example.ts` then run it using:
deno --reload minimal-example.ts
The `--reload` option forces the latest version of the Rimu library to be downloaded.
See also the [Rimu API
documentation](https://srackham.github.io/rimu/reference.html#api).
## CLI command
The [Rimu CLI
command](https://srackham.github.io/rimu/reference.html#rimuc-command) is
implemented by `rimuc.ts`.
Use the Deno `install` command to install an executable CLI wrapper. The
following example creates the executable `$HOME/.deno/bin/rimudeno`:
deno install --force rimudeno --allow-env --allow-read --allow-write https://raw.github.com/srackham/rimu-deno/master/src/rimuc.ts
Run it with e.g.
rimudeno --version
## Building
No explicit build setup is required, just import or run the TypeScript URL.
## Learn more about Rimu
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 Deno Rimu port is built using the TypeScript source code from the [canonical
Rimu implementation](https://github.com/srackham/rimu) with the following minor
modifications:
1. An explicit `.ts` extension was added to all TypeScript import and export statements
(see the Makefile `update` task).
2. `rimuc.ts` was ported from the Node.js API to the Deno API.