bug: css custom properties documentation is not generated on `stencil docs`

[shivajivarma]

Prerequisites

• [x] I have read the Contributing Guidelines.
• [X] I agree to follow the Code of Conduct.
• [X] I have searched for existing issues that already report this problem, without success.

Stencil Version

4.11.0

Current Behavior

stencil build --docs generates css custom properties to readme output.

but stencil docs command does not generates.

Expected Behavior

stencil docs expected to generate css custom properties to readme output.

System Info

No response

Steps to Reproduce

run stencil docs and see readme generated files will not have css custom properties

Code Reproduction URL

https://github.com/goatui/components

Additional Information

No response

[christian-bromann]

Thanks @shivajivarma for raising the issue. I was able to verify the bug and kindly ask to help assist us with a resolution on this problem. Our team is short staffed and we are unlikely to tackle this soon, hence any type of contribution that help to resolve the problem is much appreciated.

[ShaneK]

Hey! Thanks for the issue report!

I've been looking at this and what I've found is it looks like the commands are intentionally different. The command stencil docs seems to be intended to be used as a quick doc update command, as it does not build anything. As a result, it cannot output documentation about things that require building like CSS (especially if you use SASS/have SASS plugins), but it is very fast and efficient for changes that do not need to be rebuilt to process.

On the other hand, stencil build --docs, does build the code and can output documentation that requires building first, like CSS styles. It takes longer, and therefor isn't optimal for minor changes that just need quick updates.

We understand that this isn't very clear in the documentation and soon I'll make a PR to improve that by outlining the differences. We're planning on reworking the Stencil CLI in the future to address issues like these, and I'm curious how what kind of changes you'd like to see to it when it comes to documentation generation?

[shivajivarma]

Hi @ShaneK,

I understand that stencil docs is a lightweight command for generating quick documentation. However, is there a way to preserve CSS Custom Properties previously generated using stencil build --docs while still using the stencil docs command to update only the sections it handles?