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

Document Sass version #1619

Closed
demurgos opened this issue Sep 14, 2021 · 2 comments
Closed

Document Sass version #1619

demurgos opened this issue Sep 14, 2021 · 2 comments
Labels
documentation done in pr Already done in a PR

Comments

@demurgos
Copy link

demurgos commented Sep 14, 2021

Documentation issue

Summary

What is the issue? Is the documentation unclear? Is it missing information?

The documentation should state which version of Sass is used to compile the stylesheets. In my case I wanted to use the @use directive but then noticed it wasn't supported.

Proposed solution

A quick explanation of what you would like to see to solve the issue.
If you want to add content, please explain what you were looking for and what was
your process while looking at the current documentation.

The situation with Sass is pretty complex. The official documentation recognizes 3 implementations: Dart Sass, LibSass and Ruby Sass. In particular, most features have a compatibility note similar to the following examples:

Compatibility: Dart Sass since 1.23.0 LibSass ✗ Ruby Sass ✗

https://sass-lang.com/documentation/at-rules/use

Compatibility: Dart Sass ✓ LibSass since 3.6.0 Ruby Sass since 3.6.0

https://sass-lang.com/documentation/at-rules/import#index-files

Zola does not use any of these implementations directly, instead it uses sass-rs.

sass-rs is based on LibSass, its README.md states that it supports LibSass 3.6.4.

As you see, the whole situation is pretty messy and it's really hard to figure our which Sass features are actually supported by Zola.

I would recommend adding something like the following line to the Sass documentation:

Zola $zolaVersion renders Sass files with [`sass-rs`](https://github.com/compass-rs/sass-rs) $sassRsVersion,
compatible with [LibSass](https://github.com/sass/libsass) $libSassVersion.

For the current release, it would read something like:

Zola 0.14.1 renders Sass files with sass-rs 0.2.2, compatible with LibSass 3.6.4.

@Keats
Copy link
Collaborator

Keats commented Sep 14, 2021

The plan is #1535
Libsass is a pain to build and will be dropped soon but as you mentioned it's tricky to explain which features are supported and which are not. Both rsass and grass are based on dartsass but not fully compatible yet.

sass-rs is based on LibSass but its CHANGELOG.md is pretty poor so it is not clear which which release uses which version of LibSass.

Isn't that answered by the first line of the README?

Overall +1 on adding that to the documentation

@demurgos
Copy link
Author

Isn't that answered by the first line of the README?

I was so lost in trying to find the version used by sass-rs that I missed it. You are right: it states that it supports LibSass 3.6.4.
(I edited the original message.)

I am very glad to hear that there are plans to move to a more recent version of Sass. I still hope that it will be documented: I expect rsass to not always be at feature parity.

@Keats Keats added documentation done in pr Already done in a PR labels Jan 23, 2022
Keats added a commit that referenced this issue Jan 23, 2022
mwcz pushed a commit to mwcz/zola that referenced this issue Mar 7, 2022
@Keats Keats closed this as completed in 53fca74 Jul 16, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation done in pr Already done in a PR
Projects
None yet
Development

No branches or pull requests

2 participants