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

[docs] "Getting Started" is a bit confusing #4549

Open
bertday opened this issue Feb 7, 2025 · 1 comment
Open

[docs] "Getting Started" is a bit confusing #4549

bertday opened this issue Feb 7, 2025 · 1 comment
Labels
docs Improvements or additions to documentation

Comments

@bertday
Copy link

bertday commented Feb 7, 2025

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!

@brc-dd
Copy link
Member

brc-dd commented Feb 15, 2025

Contributions are welcome. Few clarifications

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.

@brc-dd brc-dd added the docs Improvements or additions to documentation label Feb 15, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants