Skip to content

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

Open
@bertday

Description

@bertday

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!

Metadata

Metadata

Assignees

No one assigned

    Labels

    docsImprovements or additions to documentationstale

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions