Skip to content
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

if there is already a readme in code folder, don't override it #9

Closed
DophinL opened this issue Jan 30, 2019 · 4 comments
Closed

if there is already a readme in code folder, don't override it #9

DophinL opened this issue Jan 30, 2019 · 4 comments

Comments

@DophinL
Copy link

DophinL commented Jan 30, 2019

in generate code folder, and want to maintain the readme there, instead of vuepress-jsdoc each time to copy readme there.
so can you add a feature to detect: if there is already a readme in code folder, don't override it

thanks!

@ph1p
Copy link
Owner

ph1p commented Jan 30, 2019

You can set --readme=./path/md_file.md or add a README.md to you source folder, but I can also add your feature request.

If there is a readme.md inside the destination folder, overwrite everything else except this file

@DophinL
Copy link
Author

DophinL commented Jan 30, 2019

yes, I use this feature now, but I don't want to run vuepress-jsdoc each time when change the doc.

consider this scene: I just start to use vuepress, I need to change readme.md all the time to check whether meet my need, I just directly modify readme on docs folder.And when I need to run vuepress-jsdoc, it will override that readme.

Without this feature it still works, but some kind of inconvenient.

Please consider this thanks:D

@ph1p
Copy link
Owner

ph1p commented Jan 30, 2019

Oh yeah you're right... Didn't think about this case. I will implement it as fast as I can ;)

ph1p added a commit that referenced this issue Jan 31, 2019
Add some colors
Add an example image
Replace rimraf with del

#9
@ph1p
Copy link
Owner

ph1p commented Jan 31, 2019

Added @DophinL Now the README.md is no longer overwritten. Unless you're specifying it via the additional parameter --rmPattern=./documentation/code/README.md.

@ph1p ph1p closed this as completed Jan 31, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants