{"id":47968580,"url":"https://github.com/gdiasag/djotter","last_synced_at":"2026-06-22T19:32:41.942Z","repository":{"id":309633346,"uuid":"1037012733","full_name":"gdiasag/djotter","owner":"gdiasag","description":"Shallow Ruby wrapper for the jotdown (Djot parser) Rust crate","archived":false,"fork":false,"pushed_at":"2025-08-15T18:59:25.000Z","size":26,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-06-09T17:07:02.741Z","etag":null,"topics":["djot","html","jotdown","ruby"],"latest_commit_sha":null,"homepage":"","language":"Ruby","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/gdiasag.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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-08-12T23:47:08.000Z","updated_at":"2025-08-15T18:59:29.000Z","dependencies_parsed_at":"2025-08-13T01:27:22.622Z","dependency_job_id":"54dc1720-98b4-4e9c-80d6-fbf7efe64910","html_url":"https://github.com/gdiasag/djotter","commit_stats":null,"previous_names":["gustavodiasag/djotter","gdiasag/djotter"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/gdiasag/djotter","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gdiasag%2Fdjotter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gdiasag%2Fdjotter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gdiasag%2Fdjotter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gdiasag%2Fdjotter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/gdiasag","download_url":"https://codeload.github.com/gdiasag/djotter/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gdiasag%2Fdjotter/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34663524,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-22T02:00:06.391Z","response_time":106,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["djot","html","jotdown","ruby"],"created_at":"2026-04-04T10:40:48.058Z","updated_at":"2026-06-22T19:32:41.933Z","avatar_url":"https://github.com/gdiasag.png","language":"Ruby","funding_links":[],"categories":["Parsers \u0026 Libraries"],"sub_categories":["Ruby"],"readme":"# Djotter\n\n[![ci](https://github.com/gustavodiasag/djotter/actions/workflows/ci.yml/badge.svg)](https://github.com/gustavodiasag/djotter/actions/workflows/ci.yml)\n[![Gem Version](https://badge.fury.io/rb/djotter.svg)](https://badge.fury.io/rb/djotter)\n\nRuby wrapper for Rust's [jotdown][djot-rs] crate.\n\nInitially, djotter is designed to strictly generate HTML from a Djot document. The gem does not support features such as manipulating the AST generated by the underlying parser and the conversion of such intermediate representation to construct any type of output format other than HTML.\n\n\u003e [!NOTE]\n\u003e Even though `jotdown` aims to be feature complete and match the [reference implementation][djot-js], some edge cases are not yet dealt with. Since this wrapper mirrors the crate behavior, it is important to draw attention to that.\n\u003e\n\u003e For more information, see [the documentation below](#correctness)\n\n[djot-rs]: https://github.com/hellux/jotdown\n[djot-js]: https://github.com/jgm/djot.js\n\n## Installation\n\nAdd this line to your application's Gemfile:\n\n    gem 'djotter'\n\nand then execute:\n    \n    $ bundle\n\nOr install it yourself as:\n\n    $ gem install djotter\n\n## Usage\n\nThis gem expects to receive UTF-8 strings. Ensure your strings are the right encoding before passing them into `Djotter`.\n\n### Converting to HTML\n\nCall `to_html` on a string to convert it to HTML:\n\n```ruby\nrequire 'djotter'\n\nputs Djotter.to_html('a *b{#id key=\"*\"}*')\n\n# \u003cp\u003ea \u003cstrong\u003e\u003cspan id=\"id\" key=\"*\"\u003eb\u003c/span\u003e\u003c/strong\u003e\u003c/p\u003e\n```\n\n### Correctness\n\nEven though the underlying implementation supports all the current features of the Djot syntax, the authors explicitly state that:\n\n\u003e The HTML output is in some cases not exactly identical to the reference implementation.\n\nTaking that into consideration, the test cases against which the crate is submitted to are not as exhaustive as the [JavaScript][djot-js] and [Lua][djot-lua] versions. To address that, all the `.test` files from those parsers were [added][test-cases] to this wrapper for an extra layer of inspection. With that said, not all cases matched exactly the expected output, some just because of formatting shenanigans and others due to not completely handling edge cases. The exact cases where that happened were edited out.\n\nSome of those are actually pointed out by the crate author, such as [issue #51][issue-51].\n\n[djot-lua]: https://github.com/jgm/djot.lua\n[test-cases]: ./spec/cases/\n[issue-51]: https://github.com/hellux/jotdown/issues/51\n\n## Development\n\nAfter cloning the repo:\n\n    $ bundle install\n    $ bundle exec rake compile\n\nIf there were no errors, that's it! Otherwise, make sure you have all the tools required for both Ruby and Rust: `bundle`, `cargo`.\n\n## Contributing\n\nIssues, bug reports and pull requests are welcome.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgdiasag%2Fdjotter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgdiasag%2Fdjotter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgdiasag%2Fdjotter/lists"}