-
Notifications
You must be signed in to change notification settings - Fork 798
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
CSS Variables are not documented using docs-readme output target #3034
Comments
I just tested it and it works on my side with Stencil 2.7.1 Did you run Example on my side:
|
👋 Hey there! I tried to reproduce this locally with the following "build": "stencil build --docs" and was unable to reproduce this. Can you please push a minimal reproduction up to GitHub for us to investigate further? That allows the team to pull down an example that has confirmed to have the issue present and will allow us to triage more quickly. Thanks! |
@dmartinjs + @rwaskiewicz apologies for the late reply. I have a repro case in https://github.com/Vertexvis/vertex-web-sdk. To repro, clone the repo and update the version of Stencil (docs are working prior to update). After running a build and doing a diff of the changed files, you'll see that the CSS Custom Properties sections in each of the component readme's are now gone.
I also tried with a new Stencil project and was not able to repro. Appears there might be something specific with this project that's causing CSS to not be documented. |
@danbucholtz I had the error in the past few weeks, I found that they was an error in one of my declaration in a CSS file how caused deletion of all the declarations in readme files. |
I did a little bit more digging. Since version v2.7.0, running
I've pushed up a branch with here that simplifies the CSS. If you run |
👋 I'm going to mark this to be ingested into our backlog to take a closer look. There's something afoot here, but I'm not sure what just yet. The double build seems to be at the root of things, but I'm not sure why that's running 2x |
Tested this again with v2.12.1 and am unable to repro. |
👋 Although we closed this issue out, with the help of the Ionic Framework team, we were able to reproduce this successfully. A fix has been implemented (#3374), and is a part of the v2.16.0 release that has gone out this afternoon. Thanks again for reporting this! |
Stencil version:
I'm submitting a:
[x] bug report
[ ] feature request
[ ] support request => Please do not submit support requests here, use one of these channels: https://stencil-worldwide.herokuapp.com/ or https://forum.ionicframework.com/
Current behavior:
I'm using the
docs-readme
output target. Starting with Stencil v2.7.0, CSS variables are no longer being documented in the generatedreadme.md
files.Expected behavior:
CSS variables that have documentation should be documented in the generated
readme.md
files.Steps to reproduce:
Document a CSS variable like this:
Related code:
// insert any relevant code here
Other information:
The text was updated successfully, but these errors were encountered: