patternlab-node
patternlab-node copied to clipboard
Documentation on npm scripts
Just picking up the CLI edition of Pattern Lab.
Although the Readme goes into a little detail on the build options, there's no guidance for the options from here on....
Eg. Something to explain what each npm script does and which to run first or, how to modify Patten lab such as that your starter kit it doesn't get deleted when ./source
is cleaned.
I understand the documentation is a work in progress though, but I'd suggest these elements should be included and will submit a PR to improve any gaps I identify while attempting the setup for my use case (namely, getting SASS to compile.
Thank you.
Hey @MartinDM, thanks for reaching out. Yep, we realize we have a lot of catching up to do on the documentation side of things. Hoping to get around to tackling all that stuff over the coming months. Thanks again for posting!
It's hard to keep track of everything. This issue has been automatically marked as stale because it has not had recent activity, neither from the team nor the community. It will be closed if no further activity occurs. Please consider adding additional info, volunteering to contribute a fix for this issue, or making a further case that this is important to you, the team, and the project as a whole. Thanks!
Bump - still need to make sure we have adequate docs on this!
@MartinDM I don't suppose you figured out how to get SASS to compile. I'm currently struggling with it and wouldn't mind a hint.
@MartinDM I don't suppose you figured out how to get SASS to compile. I'm currently struggling with it and wouldn't mind a hint.
I didn't unfortunately Ryan. I think I just went with straight-up CSS in the end. Docs may still need updating as above though.
We're mentioning preprocessed files like SCSS now in the docs: https://patternlab.io/docs/managing-pattern-assets/#heading-preprocessed-files
So we need to further add informations that are defined in the section https://github.com/pattern-lab/patternlab-node/tree/dev/packages/cli#configuring-your-project-to-use-the-cli as well as the following one called "API & Usage"