`margin-header`, `body-header`, etc. should document they allow HTML
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 65/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Stale
- Tech stack
- html
- Domain
- documentation
Research direction
Start with the Headers and Footers section in website-tools.html and the corresponding section in reference/projects/websites.html, then compare the subscribe example in website-blog.html. Check website-navigation-md.ts around lines 716-731 for the HTML handling, and update the documentation so the supported HTML behavior is stated consistently.
Written by the indexing model from the issue text.
Description
What would you like to do?
Report an issue on quarto.org
Description
The documentation about margin-header, body-header, etc. states that it only allows Markdown text or string, but The "subscribe" example shows the use of HTML file with raw HTML.
As pointed out by @cderv, Quarto is handling the HTML case here but does not state it does.
This can lead to confusion about why some fields allow HTML while asking for Markdown but not all of them.
I initially updated the "subscribe" example (I did not know Quarto was adding the raw block at the time):
After some discussion, it might be better to actually document that these fields actually support HTML:
- Dominant language
- JavaScript
- Stars
- 6k
- Forks
- 458
- Avg merge
- 1d 8h
- Merged PRs (30d)
- 42
Contributor 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/quarto-cli
-
documentation
Difficulty 2/5 1-3 hours Newbie friendliness 86/100
quarto-dev/quarto-cli#14915 ·
-
binder bug
Difficulty 1/5 Under an hour Newbie friendliness 92/100
quarto-dev/quarto-cli#14907 · 3 comments · 1 reaction ·
-
brand bug
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
quarto-dev/quarto-cli#14891 ·
-
brand bug html revealjs
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
quarto-dev/quarto-cli#14882 ·
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
quarto-dev/quarto-cli#14875 ·
All issues in quarto-dev/quarto-cli
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
HarperFast/skills#96 ·
-
[Block] Latest Posts [Type] Bug
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
Automattic/studio#4908 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 86/100
sugarlabs/musicblocks#8847 ·