Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve custom listings documentation to avoid caveats #11818

Open
mcanouil opened this issue Jan 8, 2025 · 0 comments
Open

Improve custom listings documentation to avoid caveats #11818

mcanouil opened this issue Jan 8, 2025 · 0 comments
Labels
documentation Doc improvements & quarto-web listings

Comments

@mcanouil
Copy link
Collaborator

mcanouil commented Jan 8, 2025

What would you like to do?

Give feedback or suggest an improvement

Description

As (re)discovered recently (#11760), EJS templates are in fact read as Markdown in Quarto, this means for safety but not only (#11701), HTML code should be enclosed in raw content blocks, except if some elements are to be evaluated as Markdown such as title, description, etc.

The current state of the documentation implies EJS files provided, as custom listings template, are pure HTML.

https://quarto.org/docs/websites/website-listings-custom.html

More advanced elements could be added such as the difference between the use of inline versus raw content block in the AST, such that Markdown lines are enclosed in <p> tags.

@mcanouil mcanouil added documentation Doc improvements & quarto-web listings labels Jan 8, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Doc improvements & quarto-web listings
Projects
None yet
Development

No branches or pull requests

1 participant