quarto-dev / quarto-dev/quarto-cli

`margin-header`, `body-header`, etc. should document they allow HTML

Open Beginner friendly
#13,270 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation
Dominant language
JavaScript
Stars
6k
Forks
458
Avg merge
1d 9h
Merged PRs (30d)
41

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:

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

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.

Assessment

Tech stack
html
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
65/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.