docs: Improve custom listing using raw HTML #1677
Open
+35
−9
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
/deploy-preview |
📝 Preview Deployment🔍 Full site preview: https://deploy-preview-1677.quarto.org 🔄 Modified Documents |
cderv
reviewed
Jun 10, 2025
There was a problem hiding this comment.
I think I would revisit the order and explain, for the start, that EJS templates are processed as a markdown document, and explain that it is best to use Raw HTML to
- avoid performance issue when processing part that are meant to be HTML with no Markdown
- avoid escaping problem for those part too
Then show an example for a simple template having only HTML, and then your example with mixing Markdown and HTML.
Internally, we use .ejs.md extension, not sure why we don't use that too for our recommendation. This makes it kind of clear
Anyhow, just sharing though. I'll let @cwickham review
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Enhance clarity and formatting in the custom listing documentation, ensuring better understanding and usability for users creating EJS templates.
From quarto-dev/quarto-cli#11769