Mirrors/macos-defaults
2
0
Fork 0
mirror of https://github.com/yannbertrand/macos-defaults synced 2024-11-14 23:57:07 +00:00
Code Issues Projects Releases Packages Wiki Activity
macos-defaults/build/vuepress
History
Yann Bertrand 41fee77db8 📝 Add deprecation notices for Docsify, Docusaurus & VuePress builds
2022-08-17 11:07:32 +02:00
..
__mocks__ 🚨 Run Prettier 2020-11-27 14:39:16 +01:00
__snapshots__ 💄 Add Netlify image width & height 2020-11-07 12:16:05 +01:00
templates 💄 Add Netlify image width & height 2020-11-07 12:16:05 +01:00
build.js 🚨 Run Prettier 2020-11-27 14:39:16 +01:00
netlify.toml 🌐 Add config internationalization support 2020-09-26 20:24:54 +02:00
package.json ⬆️ Upgrade jest to v27.4.7 2022-01-09 09:58:55 +01:00
readme.md 📝 Add deprecation notices for Docsify, Docusaurus & VuePress builds 2022-08-17 11:07:32 +02:00
write-categories.js 🚨 Run Prettier 2020-11-27 14:39:16 +01:00
write-categories.test.js 🚨 Run Prettier 2020-11-27 14:39:16 +01:00
write-config.js ⬆️ Upgrade prettier to v2.5.1 (#186) 2021-12-20 15:16:35 +01:00
write-config.test.js 🚨 Run Prettier 2020-11-27 14:39:16 +01:00
write-homepage.js 🚨 Run Prettier 2020-11-27 14:39:16 +01:00
write-homepage.test.js 🚨 Run Prettier 2020-11-27 14:39:16 +01:00
write-pages.js 🚨 Run Prettier 2020-11-27 14:39:16 +01:00
write-pages.test.js 🚨 Run Prettier 2020-11-27 14:39:16 +01:00
yarn.lock ⬆️ Upgrade jest to v27.4.7 2022-01-09 09:58:55 +01:00

readme.md

VuePress Build

⚠️ VuePress build is not maintained anymore. Please note we were using VuePress@1.9.1 at the time.

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