Skip to content
On this page

Introduction

⏱️ Get Started in less than 10 minutes.

Requirements

  • Node.JS v16+
  • Basic Javascript Knowledge

Getting Started

To initialize a new Vitepress project simply run the following command in your terminal:

sh
$ npm init vitepress-app@latest

It will display a CLI (Command Line Interface) that asks a few questions:

sh
create-vitepress-app
? Where do you want to create your Vitepress app ?

? What language do you want to use ? › - Use arrow-keys. Return to submit.
   Typescript
    Javascript

? Do you want to enable prettier ? › no / yes

Learn more about these questions

And after that it'll initialize and get the files for your project, after it'll ask you to install your dependencies. If you choose to install them know, you won't have to later.

Once you've got everything ready and all dependencies have been installed you can run the following command to start web-app:

sh
$ npm start # or pnpm/yarn

Released under the MIT License.