Mirrors/macos-defaults
2
0
Fork 0
mirror of https://github.com/yannbertrand/macos-defaults synced 2024-12-15 22:22:31 +00:00
Code Issues Projects Releases Packages Wiki Activity
macos-defaults/build/vuepress/readme.md
Yann Bertrand 551a2158f5
👷 Add a VuePress build Action 
Co-authored-by: Franck Abgrall <abgrallkefran@gmail.com>
2020-09-20 11:18:39 +02:00

1.3 KiB
Raw Blame History

VuePress Build

VuePress build status

My opinion

VuePress was really easy to setup.

😄 Good

  • Really easy to setup & deploy
  • Default theme is nice
  • It's possible to use Vue components
  • Development mode is pleasant

😕 Bad

  • Documentation is not super easy
  • Lack of other official themes

😫 Ugly

  • 🤷‍♂️

How does it work?

Here is the built website architecture:

  • .vuepress/config.yml
    • Contains the whole VuePress configuration from title to sidebar config
  • readme.md
    • The main page content

All the other pages are markdown files that are carefully put under their folder (e.g. screenshot/disable-shadow.md). Assets are stored at the same level.

There is a second build phase where VuePress generates the static website.

I also added the @vuepress/medium-zoom plugin to add Medium zoom on images.

Try locally

🏗 Install

yarn install

🚀 Usage

This will build the defaults.yml file and run a VuePress server on http://localhost:8080/. Sources of the website are available in the docs folder.

yarn start

🚧 Run unit tests

yarn test