# Vuepress
# Installation
# Global Installation
# install globally
yarn global add vuepress # OR npm install -g vuepress
# create a markdown file
echo '# Hello VuePress' > README.md
# start writing
vuepress dev
# build
vuepress build
# Inside an Existing Project
# install as a local dependency
yarn add -D vuepress # OR npm install -D vuepress
# create a docs directory
mkdir docs
# create a markdown file
echo '# Hello VuePress' > docs/README.md
Warning
It is currently recommended to use Yarn (opens new window) instead of npm when installing VuePress into an existing project that has webpack 3.x as a dependency. Npm fails to generate the correct dependency tree in this case.
Then, add some scripts to package.json:
{
"scripts": {
"docs:dev": "vuepress dev docs",
"docs:build": "vuepress build docs"
}
}
You can now start writing with:
yarn docs:dev # OR npm run docs:dev
To generate static assets, run:
yarn docs:build # Or npm run docs:build
By default the built files will be in .vuepress/dist, which can be configured via the dest field in .vuepress/config.js.
The built files can be deployed to any static file server.
See Deployment Guide (opens new window) for guides on deploying to popular services.