quarto-dev / quarto-dev/quarto-cli

echo and output options not working in manuscript companion notebooks

Open
#8,680 7 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Hi there,

Very excited about the new manuscript project type. I think I may have encountered a bug, however. I have a companion.qmd file with R code sitting alongside index.qmd. When I render the project with knitr and view index.html, the companion notebook is automatically displayed in the "Notebooks" section of the sidebar of my rendered index.md. So far, so good.

The problem is that output: false not echo: false in companion.qmd don't appear to be working, either in the YAML header or within individual code blocks. I set them to false and both the code and the code output still appear in the rendered companion.html file. (Note that this file has a blue bar at the top that says "Back to Article", it isn't rendered separately.)

output and false options work just fine in the index.md article, however. I'm using quarto version 1.4.549, using the VSCode extension (though I doubt that matters).

Apologies is if this is posted in the wrong repo! Would love any help I can get.

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 by rendering the reported companion.qmd alongside index.qmd with knitr and compare how YAML and code-block options are handled in the generated companion.html versus index.html. The fix is complete when echo: false and output: false work in the companion notebook, both in its YAML header and individual code blocks.

Written by the indexing model from the issue text.

Assessment

Tech stack
r
Domain
tooling
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.