`pandoc.read` has no HTML reader
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 52/100
- Issue type
- Feature
- Clarity
- Mostly clear
- Activity status
- Active
- Domain
- backend-api-design
Research direction
Start by locating the Lua API implementation of pandoc.read and how it dispatches supported reader formats; the issue does not name source files or tests. Compare the existing Markdown readers with the expected HTML AST output and identify the project’s reader tests. Done means pandoc.read(text, "html") handles common HTML elements as described, or the Lua API documentation lists unsupported reader formats if HTML support is not planned.
Written by the indexing model from the issue text.
Description
This issue was written by Claude while adding q2 support to Great Docs. The output shown comes from running each repro.
Bug description
In a Lua filter, pandoc.read(text, "html") raises "Unsupported reader format: html". q2's
readers are qmd, markdown, commonmark, json and raw-json. Under Quarto 1, filters commonly
use Pandoc's HTML reader to turn raw HTML into AST elements, for instance HTML returned by a
shortcode, or raw HTML blocks a filter wants to transform or convert to another format.
Great Docs writes a Markdown companion of every page, linked from the page as
<link rel="alternate" type="text/markdown">. Its markdown-pages filter reads each raw HTML block
and inline with pandoc.read(..., "html"), so that the content of shortcodes and generated HTML
appears in the Markdown. Under q2 those reads fail, and that content is left out of the companions.
Steps to reproduce
mkdir html-reader && cd html-reader
cat > read-html.lua <<'LUA'
function Pandoc(doc)
local ok, result = pcall(pandoc.read, "<p>Press <kbd>Ctrl</kbd> and <strong>save</strong>.</p>", "html")
if ok then
quarto.log.output(pandoc.write(result, "native"))
else
quarto.log.output("pandoc.read failed: " .. tostring(result))
end
end
LUA
printf -- '---\ntitle: Read HTML\nfilters:\n - read-html.lua\n---\n\nText.\n' > doc.qmd
q2 render doc.qmd
Actual behavior
pandoc.read failed: runtime error: Unsupported reader format: html. Supported formats: ["qmd", "markdown", "commonmark", "json", "raw-json"]
Expected behavior
As in Quarto 1.9.37:
[ Para
[ Str "Press"
, Space
, Span ( "" , [ "kbd" ] , [] ) [ Str "Ctrl" ]
, Space
, Str "and"
, Space
, Strong [ Str "save" ]
, Str "."
]
]
An HTML reader for pandoc.read, even one that covers only common elements (paragraphs, headings,
lists, tables, code, links, emphasis, and <span> and <div> with their attributes), would cover
most filter use. If it isn't planned, a list of the unsupported reader formats in the Lua API docs
would help extension authors.
- Dominant language
- Rust
- Stars
- 302
- Forks
- 22
- Avg merge
- 5h 2m
- Merged PRs (30d)
- 213
Getting set up
- No Dockerfile or Docker Compose file
- No pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from quarto-dev/q2
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
quarto-dev/q2#1219 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
quarto-dev/q2#1188 · 3 comments ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 73/100
quarto-dev/q2#1179 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
quarto-dev/q2#1133 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
quarto-dev/q2#1103 · 1 comment ·
Maintainers usually reply within 1 day
Similar issues
-
priority: low
Difficulty 2/5 1-3 hours Newbie friendliness 67/100
storytold/photocraft#15350 ·
Maintainers usually reply within 1 day
-
area:davinci
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
ubugeeei-prod/vize#13167 ·
Maintainers usually reply within 1 day
-
area:ui enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
transit-audio/transit#738 ·
Maintainers usually reply within 1 day
-
enhancement good first issue help wanted
Difficulty 2/5 1-3 hours Newbie friendliness 91/100
hocinehacherouf/liberarr#78 ·
Maintainers usually reply within 1 day
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
Maintainers usually reply within 1 day