Skip to content

Commit

Permalink
copy vitepress example from vercel/vercel (#1041)
Browse files Browse the repository at this point in the history
  • Loading branch information
erikareads authored Jan 13, 2025
1 parent 8fb5a40 commit 4693b62
Show file tree
Hide file tree
Showing 5 changed files with 71 additions and 0 deletions.
2 changes: 2 additions & 0 deletions framework-boilerplates/vitepress/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
.vercel
node_modules
49 changes: 49 additions & 0 deletions framework-boilerplates/vitepress/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
# VitePress

This directory is a brief example of a [VitePress](https://vitepress.vuejs.org/) site that can be deployed to Vercel with zero-configuration.

## Setup

Install the dependencies

```bash
$ yarn install
```

## Deploy Your Own

[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https://github.com/vercel/examples/tree/main/framework-boilerplates/vitepress&template=vitepress)

_Live Example: https://vitepress-starter-template.vercel.app_

## Setup

Install the dependencies:

```bash
$ yarn install
```

### Development

Start the development server

```bash
$ yarn dev
```

### Build the project

Build for production

```bash
$ yarn build
```

### Deploy

Deploy your VitePress application to Vercel

```bash
$ vercel
```
3 changes: 3 additions & 0 deletions framework-boilerplates/vitepress/docs/about.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# About

Lorem ipsum
3 changes: 3 additions & 0 deletions framework-boilerplates/vitepress/docs/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Hello VitePress

Lorem ipsum
14 changes: 14 additions & 0 deletions framework-boilerplates/vitepress/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
{
"name": "vitepress-template",
"version": "1.0.0",
"main": "index.js",
"license": "MIT",
"devDependencies": {
"vitepress": "1.1.3"
},
"scripts": {
"dev": "vitepress dev docs",
"build": "vitepress build docs",
"serve": "vitepress serve docs"
}
}

0 comments on commit 4693b62

Please sign in to comment.