2020-09-20 09:15:36 +00:00
# VuePress Build
2020-11-27 12:45:16 +00:00
2020-09-20 09:15:36 +00:00
## My opinion
2020-11-27 12:45:16 +00:00
2020-09-20 09:15:36 +00:00
VuePress was really easy to setup.
### 😄 Good
2020-11-27 12:45:16 +00:00
2020-09-20 09:15:36 +00:00
- Really easy to setup & deploy
- Default theme is nice
- It's possible to use Vue components
- Development mode is pleasant
### 😕 Bad
2020-11-27 12:45:16 +00:00
2020-09-20 09:15:36 +00:00
- Documentation is not super easy
- Lack of other official themes
### 😫 Ugly
2020-11-27 12:45:16 +00:00
2020-09-20 09:15:36 +00:00
- 🤷♂️
## How does it work?
2020-11-27 12:45:16 +00:00
2020-09-20 09:15:36 +00:00
Here is the built website architecture:
2020-11-27 12:45:16 +00:00
2020-09-20 09:15:36 +00:00
- [`.vuepress/config.yml` ](./templates/.vuepress/config.yml.handlebars )
2020-11-27 12:45:16 +00:00
- Contains the whole VuePress configuration from title to sidebar config
2020-09-20 09:15:36 +00:00
- `readme.md`
2020-11-27 12:45:16 +00:00
- The main page content
2020-09-20 09:15:36 +00:00
2020-09-12 23:39:09 +00:00
All the other pages (including translations) are markdown files that are carefully put under their folder (e.g. `screenshot/disable-shadow.md` ). Assets are stored at the same level.
2020-09-20 09:15:36 +00:00
There is a second build phase where VuePress generates the static website.
I also added the [@vuepress/medium-zoom ](https://v1.vuepress.vuejs.org/plugin/official/plugin-medium-zoom.html ) plugin to add Medium zoom on images.
## Try locally
2020-11-27 12:45:16 +00:00
2020-09-20 09:15:36 +00:00
### 🏗 Install
```sh
yarn install
```
### 🚀 Usage
This will build the [defaults.yml file ](../../defaults.yml ) and run a VuePress server on http://localhost:8080/. Sources of the website are available in the `docs` folder.
```sh
yarn start
```
### 🚧 Run unit tests
```sh
yarn test
```
