quarto-dev / quarto-dev/quarto-cli

Custom callout boxes

Aperta
#844 23 commenti 25 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

callouts enhancement
Lingua principale
JavaScript
Stelle
6k
Fork
458
Merge medio
1g 9h
PR unite (30g)
41

Descrizione

Firstly, many thanks for the fantastic package you are developing!

I am following from @athulsudheesh's comment in #556, to request a new feature for custom callout boxes.

One use case I have in mind is for exercises in books or course materials, for example:

:::{.callout-exercise}

Exercise description.

:::{.callout-answer collapse="true"}
The answer to the exercise
:::

:::

I guess these would have to be defined somewhere following a template (on the front matter? or on a separate YAML, that is then referenced on the front-matter?).

callout: "exercise"
    title: "Exercise"
    color: "purple"
    icon: "fa-question"
    collapse: "false"
callout: "answer"
    title: "Answer"
    color: "green"
    icon: "fa-pen"
    collapse: "true"    

Alternatively maybe this could be done through a generic callout with a couple of extra options, such as:

:::{.callout-custom color="purple" icon="fa-question"}
## Exercise

A purple callout block with a question mark icon.
:::

The disadvantage here is that there is more typing involved.

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Review the existing callout behavior and the discussion in #556, including the linked comment. Compare the proposed custom syntax and YAML configuration examples, then determine the supported design and verify that custom exercise and answer callouts render with their requested titles, colors, icons, and collapse behavior.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
markdown, yaml
Ambito
content, documentation
Tipo di issue
Funzionalità
Difficoltà
5/5
Tempo stimato
Più di una settimana
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
35/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.