{"id":13534580,"url":"https://github.com/srackham/rimu","last_synced_at":"2025-05-03T02:31:19.465Z","repository":{"id":5888215,"uuid":"7106284","full_name":"srackham/rimu","owner":"srackham","description":"Readable text to HTML markup language","archived":false,"fork":false,"pushed_at":"2025-01-21T02:54:15.000Z","size":3021,"stargazers_count":42,"open_issues_count":2,"forks_count":4,"subscribers_count":7,"default_branch":"master","last_synced_at":"2025-04-27T14:39:32.553Z","etag":null,"topics":["asciidoc","javascript","markdown","rimu","typescript"],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2012-12-11T05:14:25.000Z","updated_at":"2025-01-21T02:54:19.000Z","dependencies_parsed_at":"2024-06-06T09:59:55.232Z","dependency_job_id":"5874c1e4-d451-462d-8e3d-d99bd3d9e117","html_url":"https://github.com/srackham/rimu","commit_stats":{"total_commits":1654,"total_committers":1,"mean_commits":1654.0,"dds":0.0,"last_synced_commit":"de1615a92d2cdebf8a16e4eac75b845e71f0675e"},"previous_names":[],"tags_count":82,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/srackham%2Frimu","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/srackham%2Frimu/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/srackham%2Frimu/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/srackham%2Frimu/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/srackham","download_url":"https://codeload.github.com/srackham/rimu/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252133699,"owners_count":21699582,"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","javascript","markdown","rimu","typescript"],"created_at":"2024-08-01T08:00:28.285Z","updated_at":"2025-05-03T02:31:19.459Z","avatar_url":"https://github.com/srackham.png","language":"TypeScript","funding_links":[],"categories":["The list"],"sub_categories":[],"readme":"# Rimu Markup\n\nRimu is a readable-text to HTML markup language inspired by AsciiDoc\nand Markdown.\n\nAt its core Rimu is a simple readable-text markup similar in scope to\nMarkdown, but with two additional areas of functionality (both built\ninto the Rimu markup syntax):\n\n1. Markup generation can be customized and extended.\n2. Rimu includes a simple, flexible macro language.\n\nIn addition, a subset of Rimu is compatible with a [subset of Markdown](https://srackham.github.io/rimu/tips.html#markdown-compatible)\nand Rimu has been ported to a number of [languages and runtime environments](https://srackham.github.io/rimu/reference.html#rimu-implementations).\n\n## Learn more\n\n[Read the documentation](https://srackham.github.io/rimu/) and experiment with Rimu\nin the [Rimu Playground](https://srackham.github.io/rimu/rimuplayground.html) or\nopen the `rimuplayground.html` file locally in your browser.\n\nSee the Rimu [Change Log](https://srackham.github.io/rimu/changelog.html) for\nthe latest changes.\n\n**NOTE**: The remainder of this document is specific to the\n[TypeScript implementation](https://github.com/srackham/rimu) for\nNode.js, Deno, and browser platforms.\n\n## Quick start\n\nTry the Rimu library on the npm Runkit page:\n\n1. Open the [Rimu npm Runkit page](https://npm.runkit.com/rimu) in your browser.\n2. Paste in this code then press the _Run_ button.\n\n```javascript\nconst rimu = require(\"rimu\");\nconst html = rimu.render(\"Hello *Rimu*!\");\n```\n\nThis will output `\"\u003cp\u003eHello \u003cem\u003eRimu\u003c/em\u003e!\u003c/p\u003e\"`.\n\n## Installing and using Rimu\n\n**Node.js**\n\nUse `npm` to install the Node.js Rimu library module and the `rimuc`\nCLI:\n\n    npm install -g rimu\n\nRun a test from the command prompt to check the `rimuc` CLI command is\nworking:\n\n    echo 'Hello *Rimu*!' | rimuc\n\nThis should print:\n\n    \u003cp\u003eHello \u003cem\u003eRimu\u003c/em\u003e!\u003c/p\u003e\n\n**Deno**\n\nDeno modules don't need explicit installation just import the module\nURL, for example:\n\n```javascript\nimport * as rimu from \"https://deno.land/x/rimu@11.4.0/mod.ts\";\n\nconsole.log(rimu.render(\"Hello *Rimu*!\"));\n```\n\nUse the Deno `install` command to install the Rimu CLI executable.\nThe following example creates the CLI executable named `rimudeno`\nin `$HOME/.deno/bin/rimudeno`:\n\n    deno install -A --name rimudeno https://deno.land/x/rimu@11.4.0/src/deno/rimuc.ts\n\n**Browser**\n\nRimu builds JavaScript ES module files in the `./lib/esm` directory along with a\nbundled version `./lib/esm/rimu.min.js`. The `rimu.min.js` ES module file was\nbundled by [Rollup](https://github.com/rollup/rollup) and minimized with\n[terser](https://github.com/terser/terser). Example usage:\n\n```html\n\u003cscript type=\"module\"\u003e\n    import * as rimu from \"./rimu.min.js\";\n    alert(rimu.render(\"Hello *Rimu*!\"));\n\u003c/script\u003e\n```\n\n## Building Rimu and the Rimu documentation\n\nTo build Rimu you need to have [Deno](https://deno.land/) and\n[Node.js](https://nodejs.org/) installed.\n\n1.  Install the Git repository from [Github](https://github.com/srackham/rimu).\n\n        git clone https://github.com/srackham/rimu.git\n\n2.  Install dependencies:\n\n        cd rimu\n        npm install\n        deno cache --reload src/deno/rimuc.ts\n\n3.  Use the [Drake](https://github.com/srackham/drake) task runner\n    module to build and test Rimu library modules and CLIs for Deno and Node.js\n    platforms:\n\n         deno run -A Drakefile.ts build test\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsrackham%2Frimu","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsrackham%2Frimu","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsrackham%2Frimu/lists"}