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

Clarify documentation on config file #90

Open
jl-stellar opened this issue Mar 31, 2022 · 0 comments
Open

Clarify documentation on config file #90

jl-stellar opened this issue Mar 31, 2022 · 0 comments

Comments

@jl-stellar
Copy link

Under "Custom SVGO configuration", there are 2 code examples for config files.
The first one is a complete config file; however, the second one is missing the module.exports = before the curly braces.

So if someone just copies the entire block and pastes it into the svgo.config.js file, it won't work.

(Especially since the second code block is prefixed with the comment "For the record, here's the default configuration we use:")

It would be nice if this could be fixed, I don't think it will make the documentation less readable.

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

No branches or pull requests

1 participant