Mirrors/macos-defaults
2
0
Fork 0
mirror of https://github.com/yannbertrand/macos-defaults synced 2024-12-14 21:52:33 +00:00
Code Issues Projects Releases Packages Wiki Activity
macos-defaults/build/vuepress
History
Yann Bertrand 114ab9b479
♻️ Split build into smaller functions
2020-09-26 20:24:54 +02:00
..
__mocks__ 👷 Add a VuePress build Action 2020-09-20 11:18:39 +02:00
__snapshots__ ♻️ Split build into smaller functions 2020-09-26 20:24:54 +02:00
templates 🌐 Add config internationalization support 2020-09-26 20:24:54 +02:00
build.js ♻️ Split build into smaller functions 2020-09-26 20:24:54 +02:00
netlify.toml 🌐 Add config internationalization support 2020-09-26 20:24:54 +02:00
package.json 🔒 Pin node-forge@0.10.0 2020-09-20 20:10:18 +02:00
readme.md 📝 Add internationalization infos 2020-09-26 20:24:54 +02:00
write-categories.js ♻️ Split build into smaller functions 2020-09-26 20:24:54 +02:00
write-categories.test.js ♻️ Split build into smaller functions 2020-09-26 20:24:54 +02:00
write-config.js 🌐 Add config internationalization support 2020-09-26 20:24:54 +02:00
write-config.test.js 🌐 Add config internationalization support 2020-09-26 20:24:54 +02:00
write-homepage.js ♻️ Split build into smaller functions 2020-09-26 20:24:54 +02:00
write-homepage.test.js ♻️ Split build into smaller functions 2020-09-26 20:24:54 +02:00
write-pages.js ♻️ Split build into smaller functions 2020-09-26 20:24:54 +02:00
write-pages.test.js ♻️ Split build into smaller functions 2020-09-26 20:24:54 +02:00
yarn.lock 🔒 Pin node-forge@0.10.0 2020-09-20 20:10:18 +02:00

readme.md

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 (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.

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