quarto-dev / quarto-cli

Open-source scientific and technical publishing system built on Pandoc.
https://quarto.org
Other
3.99k stars 328 forks source link

Improve the HTML Theming documentation page #8654

Open cwickham opened 9 months ago

cwickham commented 9 months ago

In particular the sections used both on Guide > Documents > HTML > HTML Theming and Guide > Dashboards > Using Dashboards > Theming:

Our HTML Theming Docs have a few issues:

mcanouil commented 9 months ago

The link to https://github.com/twbs/bootstrap/blob/main/scss/_variables.scss is quite prominent, but it isn't clear what a user should do with the contents of this file (e.g. are these variables they can set, or variables they can reference?)

  1. Users can set them which means anything using those variables will also be modified. For instance the $gray-700 variable used in the custom.scss could be redefined to something not grey everything from Bootstrap and Quarto with rules using this variable will be impacted. It's kind of a low-level set of variables. While Quarto SASS variables are more macro.

  2. They can use/reference them to harmonise components such as navbar colour, new CSS classes, etc.

mcanouil commented 9 months ago

Some feedback:

cwickham commented 9 months ago

We might consider generally talking about using existing Bootstrap classes, e.g. as in the example in https://github.com/quarto-dev/quarto-web/pull/948