quarto-dev / quarto-dev/quarto-cli

Possible features in `minimal` option, and a working example

Open
#9,305 7 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Bug description

(This is my first feedback, so I want to start sharing that I find Quarto really awesome.)

In the documentation it is said that using the minimal option, When specifying minimal: true you can still selectively re-enable features you do want, for example:

---
title: "My Document"
format:
  html:
    minimal: true
    code-copy: true
---

But:

  1. the example of code-copy: true does not work well as the button is created by a CSS class (class="code-copy-button") and not by a regular UTF-8 char (such as 📋): the button appears very small, without any char, and it's very difficult to understand this is a button and its usage
  2. what features are we talking about? It would be great to know what features can be enabled.
Steps to reproduce

Create a new .qmd document and add the following YAML plus some code. Eg.

---
title: "My Document"
format:
  html:
    minimal: true
    code-copy: true
---

Just testing:
```{r}

# Some R code

#library(leaflet)
#leaflet() %>%
#  addTiles() %>%  # Add default OpenStreetMap map tiles
#  addMarkers(lng=174.768, lat=-36.852, popup="The birthplace of R")
```

Then render it.

Expected behavior

I would expect:

  • to have an easy to read copy button
  • to know what features can be enabled (and works)
Actual behavior
Your environment

Quarto 1.4.553
IDE: RStudio 2023.12.1 Build 402
OS: Garuda Linux (Arch based)

Quarto check output

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 minimal HTML documentation section linked in the issue and review the minimal: true and code-copy: true options. Reproduce the provided .qmd example, then trace how the code-copy-button styling and selectively enabled features are documented. Done means the copy control is readable and the documentation clearly lists supported features.

Written by the indexing model from the issue text.

Assessment

Tech stack
css, html
Domain
documentation, frontend
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.