-
Notifications
You must be signed in to change notification settings - Fork 789
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
bug: readme overview duplicates markdown content #3762
Labels
Bug: Validated
This PR or Issue is verified to be a bug within Stencil
Comments
rwaskiewicz
changed the title
bug: readme docs messed up
bug: readme overview duplicates markdown content
Oct 25, 2022
Hey @jeripeierSBB 👋 Sorry about that! I was able to confirm that this is indeed a bug that I introduced in #3635. I'm going to take a look at this later today |
rwaskiewicz
added
the
Bug: Validated
This PR or Issue is verified to be a bug within Stencil
label
Oct 25, 2022
14 tasks
rwaskiewicz
added
the
Awaiting Reply
This PR or Issue needs a reply from the original reporter.
label
Oct 25, 2022
@rwaskiewicz You are very fast, thanks a lot! v2.19.1-0 works as expected in our repo, so for us it seems fixed. |
ionitron-bot
bot
removed
the
Awaiting Reply
This PR or Issue needs a reply from the original reporter.
label
Oct 26, 2022
The fix for this has been officially released under v2.19.1. I'm going to close this issue as a result. Thanks again! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Prerequisites
Stencil Version
2.19.0
Current Behavior
Until now we documented our components in the readme file before the
<!-- Auto Generated Below -->
.so possible our readme could look like following:
Since the 2.19.0 update, stencil automatically generates the following:
So the sum up, the part until the first title is copied to overview while the other parts remaining only before the auto generated part.
Expected Behavior
No duplication of written lines in readme before auto generated section.
Steps to Reproduce
Write some lines and sections before auto generated code and run build.
Code Reproduction URL
.
Additional Information
As a possible workaround, we can move all the markdown docs into jsdocs of the component. But it's not convenient to write markdown inside a jsdoc block.
Most probably related to: #3635
The text was updated successfully, but these errors were encountered: