You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Hello, VitePress team! Thank you for this awesome project 😄
I'm trying VP for the first time. The following part of the Getting Started page is a bit confusing to me:
VitePress can be used on its own, or be installed into an existing project. In both cases, you can install it with:
npm add -D vitepress
What's unclear?
My first reaction was: what am I adding this package to? I'm not currently in an npm-managed project. Did they mean npm add -g vitepress — maybe it's a scaffolding tool?
If the learning flow for new users is to add VP as a dev dependency to a new npm-managed project, I would recommend making those setup steps explicit (e.g. first mkdir hello-vitepress, cd hello-vitepress, npm init, and then npm add -D vitepress).
What does it mean to use VP "on its own"? What would this separate it from?
The Setup Wizard section is clear and helpful. My suggestion might be to make the Setup Wizard the recommended way to get started with VP, rather than presenting multiple learning paths (i.e. create your own project vs. let us scaffold it for you). I'd be happy to make a PR to make this a bit more more self-explanatory to newcomers!
The text was updated successfully, but these errors were encountered:
what am I adding this package to? I'm not currently in an npm-managed project.
You don't need to be in one. Running install command will create the package.json for you in you pwd. We can add explicit instructions for creating folders if they aren't inside one already.
What does it mean to use VP "on its own"?
Like create a new project just for vitepress-powered site. Most of the users are adding it existing projects. Like they already have some stuff and want to use vitepress just as a documentation tool.
Hello, VitePress team! Thank you for this awesome project 😄
I'm trying VP for the first time. The following part of the Getting Started page is a bit confusing to me:
What's unclear?
npm add -g vitepress
— maybe it's a scaffolding tool?mkdir hello-vitepress
, cdhello-vitepress
,npm init
, and thennpm add -D vitepress
).The Setup Wizard section is clear and helpful. My suggestion might be to make the Setup Wizard the recommended way to get started with VP, rather than presenting multiple learning paths (i.e. create your own project vs. let us scaffold it for you). I'd be happy to make a PR to make this a bit more more self-explanatory to newcomers!
The text was updated successfully, but these errors were encountered: