Commit 7e28c54d authored by Sam Beckham's avatar Sam Beckham
Browse files

Update README.md

parent c42e5c54
![Gitlab ❤️ VuePress](https://samdbeckham.gitlab.io/vuepress-gl-pages/hero.png)
# VuePress GitLab pages template
This repo contains all the starter files for running VuePress on GitLab pages.
If you want to read more on VuePress, [check out their website](https://vuepress.vuejs.org/).
\ No newline at end of file
If you want to read more on VuePress, [check out their website](https://vuepress.vuejs.org/).
## Running locally
This project uses [yarn](), you'll need to install this globally before you can get started.
```
npm install -g yarn
```
Then you need to install the project dependencies:
```
yarn install
```
Now you're ready to go.
To run the local dev server just use the following command:
```
yarn start
```
## Building the site
[.gitlab-ci.yml](./.gitlab-ci.yml) takes care of the deployment to GitLab pages.
If you want to preview a build locally, you can run:
```
yarn build
```
This will build all your files into a `./public` directory.
\ No newline at end of file
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment