vitepress-cli

A lightweight CLI for VitePress project.

Usage no npm install needed!

<script type="module">
  import vitepressCli from 'https://cdn.skypack.dev/vitepress-cli';
</script>

README

VitePress-CLI

A lightweight CLI for VitePress project.

Build Status Version MIT npm

English | 简体中文

Installation

$ npm i vitepress-cli -g

Usage

Run the following command line to create the project:

$ vitepress-cli init myproject

Parameter

init <PROJECT_NAME>

Create the VitePress project:

$ vitepress-cli init myproject

upgrade

Check the new version is available or not:

$ vitepress-cli upgrade

template

You can download or upgrade the template from mirror:

$ vitepress-cli template

mirror <TEMPLATE_MIRROR>

You can also set the template mirror like this:

$ vitepress-cli mirror https://zpfz.vercel.app/template/vitepress/

NOTE
You can customize the template mirror link by youself, but the template file name must be template.zip, and the mirror link should be / ending.
For example, the full link to your custom template mirror is https://example.com/mirror/template.zip, the mirror link that vitepress-cli can recognize should be https://example.com/mirror/.

You can download the VitePress template from vitepress-cli/tpl.