Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add info about looking in the next section #984

Closed
wants to merge 1 commit into from
Closed

Add info about looking in the next section #984

wants to merge 1 commit into from

Conversation

olivroy
Copy link
Contributor

@olivroy olivroy commented Jan 19, 2024

In the quarto dashboard theming section, I find it confusing where to look for to create custom.scss.

https://quarto.org/docs/dashboards/theming.html#theme-options

This link https://github.com/twbs/bootstrap/blob/main/scss/_variables.scss is very prominent, but it's not the correct place to look for.

The correct place to look for is actually https://quarto.org/docs/dashboards/theming.html#sass-variables

I am not sure how to put it, but I think that it should be more obvious.

I got confused in quarto-dev/quarto-cli#8351.

This is probably not right, maybe the correct thing would be to add {#sec-sass-variables} in https://github.com/quarto-dev/quarto-web/blob/main/docs/output-formats/_theme-variables.md but I don't know how it works with < include >

@mcanouil
Copy link
Contributor

mcanouil commented Jan 19, 2024

That is not correct.
The link targets the complete list of available SASS variables from Bootstrap which is correct.
The SASS variables section list the SASS variables defined/used by Quarto internally in addition to Bootstrap.

Here the change to make would be to add a cross-reference to the section (https://quarto.org/docs/dashboards/theming.html#sass-variables) and to state that there are more SASS variables available to ease customisation (in https://quarto.org/docs/dashboards/theming.html#theme-options).

Thanks @olivroy as there is indeed an improvement to be made here.

CC @cwickham

@cwickham
Copy link
Collaborator

cwickham commented Feb 8, 2024

Agreed, @mcanouil and @olivroy there are definitely improvements to be made here. I'm going to close this PR in favor of this issue tracking the issues with the theming content.

@cwickham cwickham closed this Feb 8, 2024
@olivroy olivroy deleted the patch-1 branch February 8, 2024 22:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants