Prerequisites
Stencil Version
4.12.3
Current Behavior
When using docs-readme with the dir property in stencil.config.js, all my component readme.md files keep getting overwritten, including the text above the <!-- Auto Generated Below --> comment. According to this documentation https://stenciljs.com/docs/docs-readme#custom-markdown-content, I understand that text placed above the comment should be preserved.
type: 'docs-readme',
dir: "output"
I just noticed this as I'm creating this issue: If I have a readme.md with the <!-- Auto Generated Below --> comment and some text above it in the default output folder, this content above it is preserved.
Is this the intended feature? If so, I think it might just need a little tweak in the documentation.
Expected Behavior
Even when using the dir property to customize the output directory the content above <!-- Auto Generated Below --> should be preserved when generating another readme.md on build time.
System Info
System: node 20.11.0
Platform: linux (5.15.133.1-microsoft-standard-WSL2)
CPU Model: AMD Ryzen 7 5800H with Radeon Graphics (16 cpus)
Compiler: /home/rafael/Projetos/stenciljs-custom-dir/node_modules/@stencil/core/compiler/stencil.js
Build: 1708455660
Stencil: 4.12.3 🐍
TypeScript: 5.3.3
Rollup: 2.56.3
Parse5: 7.1.2
jQuery: 4.0.0-pre
Terser: 5.27.1
Steps to Reproduce
I created a repo to reproduce it. Just install the dependencies and run build.
https://github.com/oliveirarafa/stenciljs-custom-dir
-
Without 'dir' (default output directory)
Regenerating the readme.md keeps all the changes before the comment.
-
With 'dir' (custom output directory)
All the content before or after the comment is cleared.
Note: just noticed that placing a readme.md in the default folder with the comment and a text before it makes this text persistent. In my opinion it makes more a little mor difficult to maintain because ir splits my docs in 2 but it works.
Code Reproduction URL
https://github.com/oliveirarafa/stenciljs-custom-dir
Additional Information
No response
Prerequisites
Stencil Version
4.12.3
Current Behavior
When using docs-readme with the
dirproperty in stencil.config.js, all my component readme.md files keep getting overwritten, including the text above the<!-- Auto Generated Below -->comment. According to this documentation https://stenciljs.com/docs/docs-readme#custom-markdown-content, I understand that text placed above the comment should be preserved.I just noticed this as I'm creating this issue: If I have a
readme.mdwith the<!-- Auto Generated Below -->comment and some text above it in the default output folder, this content above it is preserved.Is this the intended feature? If so, I think it might just need a little tweak in the documentation.
Expected Behavior
Even when using the
dirproperty to customize the output directory the content above<!-- Auto Generated Below -->should be preserved when generating anotherreadme.mdon build time.System Info
System: node 20.11.0 Platform: linux (5.15.133.1-microsoft-standard-WSL2) CPU Model: AMD Ryzen 7 5800H with Radeon Graphics (16 cpus) Compiler: /home/rafael/Projetos/stenciljs-custom-dir/node_modules/@stencil/core/compiler/stencil.js Build: 1708455660 Stencil: 4.12.3 🐍 TypeScript: 5.3.3 Rollup: 2.56.3 Parse5: 7.1.2 jQuery: 4.0.0-pre Terser: 5.27.1Steps to Reproduce
I created a repo to reproduce it. Just install the dependencies and run build.
https://github.com/oliveirarafa/stenciljs-custom-dir
Without 'dir' (default output directory)
Regenerating the readme.md keeps all the changes before the comment.
With 'dir' (custom output directory)
All the content before or after the comment is cleared.
Note: just noticed that placing a readme.md in the default folder with the comment and a text before it makes this text persistent. In my opinion it makes more a little mor difficult to maintain because ir splits my docs in 2 but it works.
Code Reproduction URL
https://github.com/oliveirarafa/stenciljs-custom-dir
Additional Information
No response