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

docs: include Vuetify SASS variables overriding #288

Merged
merged 24 commits into from
Nov 23, 2024
Merged

Conversation

anonmos
Copy link
Contributor

@anonmos anonmos commented Nov 20, 2024

Description

Overriding SASS variables was difficult to figure out when using this module. Provide some sample documentation for getting it to work.

Linked Issues

N/A

Additional Context

Out of the box the documentation on the Vuetify site does not provide a way to get a working example up and running for overriding SASS variables that is compatible with the Vuetify Nuxt Module. Additionally there is no existing documentation on this module's page for getting it to work.

This extra md file provides step-by-step instructions for configuring SASS variable overrides that work with this Nuxt module.


Tip

The author of this PR can publish a preview release by commenting /publish below.

SAAS variable overriding was difficult to figure out how to configure using this module.  Provide some sample documentation for how to get it to work.
@userquin
Copy link
Member

Move the entry using h2 (##) to https://nuxt.vuetifyjs.com/guide/sass-modern-compiler.html, add also a reference somewhere here https://nuxt.vuetifyjs.com/guide/server-side-rendering.html#vuetify-sass-variables to the new h2.

Myabe we can change the menu title here https://nuxt.vuetifyjs.com/guide/sass-modern-compiler.html to SASS Modern Compiler and SASS Variables

@userquin
Copy link
Member

/cc @TechAkayy

For some reason my tired brain was thinking Software as a Service, rather than SASS.  Replace them all.
Use 'other options' verbiage instead of comment with ellipsis for clarity
@anonmos anonmos changed the title Add documentation for Vuetify SAAS variable overriding Add documentation for Vuetify SASS variable overriding Nov 20, 2024
Per PR review, moving the contents of saas-variables.md (sic, sorry) to sass-modern-compiler.md as a sub-section.
@anonmos
Copy link
Contributor Author

anonmos commented Nov 20, 2024

@userquin thanks for the speedy review! Happy to make more changes as you or @TechAkayy see fit.

Reference SASS Modern Compiler sub-section in Server Side Rendering doc
@userquin
Copy link
Member

Change VP config file entry here (set text to SASS Modern Compiler and SASS Variables): https://github.com/vuetifyjs/nuxt-module/blob/main/docs/.vitepress/config.ts#L194

@userquin userquin changed the title Add documentation for Vuetify SASS variable overriding docs: include Vuetify SASS variables overriding Nov 20, 2024
Copy link
Collaborator

@TechAkayy TechAkayy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just two more minor feedbacks. Otherwise, it reads really good. Anyone using our module will find this very valuable. Thanks bunch @anonmos 👍

By the way, renaming main.scss to global.scss is really a good idea, I will update my sample repos too. On the same line, wondering if renaming settings.scss to components.scss makes sense, thoughts @anonmos? @userquin?

@TechAkayy
Copy link
Collaborator

Thanks @anonmos. Let's wait for @userquin's final review & closure.

Copy link
Member

@userquin userquin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thx

@userquin userquin merged commit 8f93bcb into vuetifyjs:main Nov 23, 2024
2 checks passed
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