@oxide/react-asciidoc 2.0.0--canary.54.27011587789.0 → 2.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +12 -10
- package/dist/react-asciidoc.js +120 -141
- package/dist/react-asciidoc.umd.cjs +11 -31
- package/dist/types/utils/prepareDocument.d.ts +3 -3
- package/package.json +1 -14
package/README.md
CHANGED
|
@@ -300,14 +300,16 @@ main document. Can surface in long documents that footnote heavily.
|
|
|
300
300
|
|
|
301
301
|
### Rarely an issue
|
|
302
302
|
|
|
303
|
-
| Difference | Example | Asciidoctor
|
|
304
|
-
| ------------------------------------------------------------------------------------------------------------------- | ---------------------------------- |
|
|
305
|
-
| Inline formatting straddling a span boundary | `` `a __b` c__ `` | `<code>a <em>b</code>c</em>`
|
|
306
|
-
| `manpage` doctype | `:doctype: manpage` + NAME section | special NAME header block
|
|
307
|
-
| `source-highlighter` with a `>` in the language token | `[source,console?prompt=$>]` | `data-lang="…$>"` (raw)
|
|
308
|
-
| Server-side highlighter markup (Rouge/CodeRay) | `:source-highlighter: rouge` | per-token `<span>` markup
|
|
309
|
-
| `xref` nested inside another link's text | `link:…[… <<id>> …]` | resolved `<a>`
|
|
310
|
-
| `{set:cellbgcolor}`, nested-document table cells, compat-mode toggling, `pass:` inside a body-level attribute value | — | —
|
|
303
|
+
| Difference | Example | Asciidoctor | This renderer | Notes |
|
|
304
|
+
| ------------------------------------------------------------------------------------------------------------------- | ---------------------------------- | ----------------------------- | --------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- |
|
|
305
|
+
| Inline formatting straddling a span boundary | `` `a __b` c__ `` | `<code>a <em>b</code>c</em>` | `<code>a __b</code>c__` | Rare in practice. |
|
|
306
|
+
| `manpage` doctype | `:doctype: manpage` + NAME section | special NAME header block | rendered as ordinary sections | Only relevant if you render man pages (~12 failures). |
|
|
307
|
+
| `source-highlighter` with a `>` in the language token | `[source,console?prompt=$>]` | `data-lang="…$>"` (raw) | `data-lang="…$>"` | Needs an unusual language token. |
|
|
308
|
+
| Server-side highlighter markup (Rouge/CodeRay) | `:source-highlighter: rouge` | per-token `<span>` markup | plain `<code class="language-…">` | Highlight on the client instead. |
|
|
309
|
+
| `xref` nested inside another link's text | `link:…[… <<id>> …]` | resolved `<a>` | literal `<<id>>` | Uncommon nesting. |
|
|
310
|
+
| `{set:cellbgcolor}`, nested-document table cells, compat-mode toggling, `pass:` inside a body-level attribute value | — | — | — | Rare/legacy features. |
|
|
311
|
+
| Audio/video `controls`/`autoplay`/`loop` attribute casing | `audio::…[] controls` | `controls` (bare) | `controls=""` via React | Default templates use raw HTML to match Asciidoctor; override `options.overrides.audio` / `video` to use React elements instead. |
|
|
312
|
+
| `inlineOverrides` silently bypassed for blocks with straddling passthrough HTML | `pass:q[<u>x *y*</u>]` | `<u>x <strong>y</strong></u>` | same (string path, no override) | Any `<`/`>` in the inline AST triggers the HTML-string fallback, bypassing registered `inlineOverrides` for that block. |
|
|
311
313
|
|
|
312
314
|
For ordinary technical prose — code blocks, tables, admonitions, lists, links, images,
|
|
313
315
|
xrefs, and footnotes — output should match Asciidoctor. The things most worth watching are
|
|
@@ -379,5 +381,5 @@ documents; the example suite (`renderer.test.tsx`) always runs.
|
|
|
379
381
|
|
|
380
382
|
- Prettier: 92-column width, no semicolons, single quotes, trailing commas.
|
|
381
383
|
- ESLint ignores `.js` files (the examples are intentionally plain JS).
|
|
382
|
-
- Releases
|
|
383
|
-
|
|
384
|
+
- Releases are triggered manually via the GitHub Actions `workflow_dispatch` event with an
|
|
385
|
+
explicit version number. Release notes are generated automatically in GitHub Releases.
|