Improve the HTML Theming documentation page

Open
#8,654 3 comments 0 reactions 1 assignee View on GitHub

@cwickham is already working on this.

Since Feb 8, 2024.

Assessment

This issue has not been assessed yet.

Description

documentation enhancement

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

  • /docs/output-formats/_theme-options.md
  • /docs/output-formats/_theme-custom.md
  • /docs/output-formats/_theme-variables.md

Our HTML Theming Docs have a few issues:

  • The custom.scss example doesn't work as-is. Fixed in 61a0365
  • There isn't a clear articulation of the pathway for users to customize their theme, e.g. start with the YAML options, if they aren't enough add a custom.scss on top of a Bootswatch theme, if that isn't enough do a standalone custom.scss theme.
  • The Quarto SCSS variables, which I think cover most customizations, aren't prominent enough. At the very least they should be much closer to the section currently called Theme Options.
  • 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?)
Dominant language
JavaScript
Stars
6k
Forks
458
Avg merge
1d 9h
Merged PRs (30d)
41

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.

More from quarto-dev/quarto-cli

All issues in quarto-dev/quarto-cli

Similar issues

More JavaScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.