feat(cli): support custom srcDir
#4270
Open
+22
−3
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Hello 👋,
This PR introduces a new scaffolding parameter to ask the developer where Markdown files should be stored. This is related to the
srcDir
parameter in thevitepress.config.js
file.For blogs, portfolios, and marketing sites, or any sites that use VitePress as the main project (without a
docs
folder), having asrc
folder is more intuitive and I think a better architecture than having every Markdown files at the root of the project. The file.vitepress/config.{js,ts}
can stay at the root of the project.The architecture of the project will look like this:
Linked Issues
Additional Context
I'm building a tutorial on how to create a blog with VitePress and Vue.js from scratch. I used a lot VitePress for documentation, and it was fine. But for blogs, portfolios, and marketing sites, as mentioned in the VitePress documentation, I think the CLI needs some adjustments to make it easier to use and less documentation's oriented.
Tip
The author of this PR can publish a preview release by commenting
/publish
below.