{"id":29675819,"url":"https://github.com/oxidecomputer/react-asciidoc","last_synced_at":"2025-07-22T23:38:50.374Z","repository":{"id":103490638,"uuid":"551539789","full_name":"oxidecomputer/react-asciidoc","owner":"oxidecomputer","description":"A React renderer for AsciiDoc. Built on top of Asciidoctor.js.","archived":false,"fork":false,"pushed_at":"2025-03-24T11:18:21.000Z","size":2025,"stargazers_count":23,"open_issues_count":5,"forks_count":1,"subscribers_count":20,"default_branch":"main","last_synced_at":"2025-03-24T12:22:33.507Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mpl-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/oxidecomputer.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","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":"2022-10-14T15:40:50.000Z","updated_at":"2025-03-24T11:17:14.000Z","dependencies_parsed_at":"2024-02-20T16:57:14.401Z","dependency_job_id":"44912dfe-2224-48c0-9e8f-df3cf8b74483","html_url":"https://github.com/oxidecomputer/react-asciidoc","commit_stats":null,"previous_names":[],"tags_count":14,"template":false,"template_full_name":null,"purl":"pkg:github/oxidecomputer/react-asciidoc","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oxidecomputer%2Freact-asciidoc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oxidecomputer%2Freact-asciidoc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oxidecomputer%2Freact-asciidoc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oxidecomputer%2Freact-asciidoc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/oxidecomputer","download_url":"https://codeload.github.com/oxidecomputer/react-asciidoc/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oxidecomputer%2Freact-asciidoc/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":266591233,"owners_count":23953082,"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","status":"online","status_checked_at":"2025-07-22T02:00:09.085Z","response_time":66,"last_error":null,"robots_txt_status":null,"robots_txt_updated_at":null,"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":[],"created_at":"2025-07-22T23:38:49.547Z","updated_at":"2025-07-22T23:38:50.355Z","avatar_url":"https://github.com/oxidecomputer.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# React AsciiDoc\n\n\u003e **Warning** Work in progress, not ready for use\n\nA React renderer for AsciiDoc. Built on top of\n[Asciidoctor.js](https://github.com/asciidoctor/asciidoctor.js/). Designed to be equivalent\nin output of the built-in HTML5 converter. Will allow for custom components to be passed in\nsimilar to\n[Custom converters in Asciidoctor.js](https://docs.asciidoctor.org/asciidoctor.js/latest/extend/converter/custom-converter/)\nand custom block types.\n\nCurrently just a proof of concept, working towards style parity with the built-in converter.\n\n## Installing\n\nTo view any of the examples first install all necessary modules:\n\n```\nnpm install\n```\n\n## Previewing\n\nYou can then preview any of the examples by running `npm run dev` and visting\n`http://localhost:8000/?example=[EXAMPLE]\u0026renderer=[RENDERER]`. See\n[here](https://github.com/oxidecomputer/react-asciidoc/tree/main/src/examples) for the\nexample names. Use `renderer=react` for the React renderer and `renderer=html` for the HTML\none.\n\n\u003e **Note** The example name must be identical to the file name without the file ending, it\n\u003e is case sensitive\n\n## Running tests\n\nBefore running the full set of tests we must first generate the screenshots. The tests are\nrunning a visual diff on the original renderer and the React one. You must therefore run the\nfollowing command first:\n\n```\nnpm run test:init\n```\n\nThis will produce an error on first run; this is expected, as it needs to generate the\nscreenshots. You should then run the following command, which runs all of the React renderer\ntests, comparing them to the baseline.\n\n```\nnpm run test:run\n```\n\n![GIF of the visual diff tests](https://user-images.githubusercontent.com/4020798/196468163-a3fac4eb-ddec-43d1-99ee-a38fe7cd7062.gif)\n\n## Limitations\n\nWe do not have access to the inline nodes. They can be customised but not with React. You\ncan write a standard asciidoctor.js custom converter instead. Using a JSX to string\nconverter is planned to make it easier to create converters for inline nodes.\n\n## Current Progress\n\nTests are showing the following examples are identical to the HTML5 renderer using the\n[default asciidoctor stylesheet](https://github.com/asciidoctor/asciidoctor/blob/f80441fd2ad46439cce19bf54581eb9d79097f3d/src/stylesheets/asciidoctor.css).\n\n- [x] Audio\n- [x] Admonition\n- [x] CoList\n- [x] DList\n- [x] Example\n- [x] Floating Title\n- [x] Inline Anchor\n- [x] Inline Break\n- [x] Inline Button\n- [x] Inline Callout\n- [x] Inline Image\n- [x] Inline KBD\n- [x] Inline Menu\n- [x] Inline Quoteed\n- [x] Listing\n- [x] Literal\n- [x] OList\n- [x] Open\n- [x] Page Break\n- [x] Paragraph\n- [x] Pass\n- [x] Preamble\n- [x] Quote\n- [x] Sidebar\n- [x] Thematic Break\n- [x] Toc\n- [ ] Document\n- [ ] Embedded\n- [ ] Image\n- [ ] Inline Footnote\n- [ ] Outline\n- [ ] Section\n- [ ] Stem\n- [ ] Table\n- [ ] Video\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foxidecomputer%2Freact-asciidoc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Foxidecomputer%2Freact-asciidoc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foxidecomputer%2Freact-asciidoc/lists"}