macos-defaults/build
2023-08-17 11:42:19 +02:00
..
__mocks__ 🔥 Keep the production build folder only 2022-08-18 11:08:08 +02:00
__snapshots__ Fix tests snapshots 2022-10-14 16:32:20 +02:00
media Set prettier to v2.8.8 2023-07-06 21:45:39 +02:00
templates 🐛 Use local Netlify logo to improve Lighthouse score 2022-10-14 16:14:54 +02:00
.node-version ⬆️ Upgrade all non-major dependencies 2023-08-09 22:23:19 +02:00
build.js 🔥 Keep the production build folder only 2022-08-18 11:08:08 +02:00
handlebars-helpers.js 🔍 Lowercase pages URLs 2022-08-19 16:10:36 +02:00
netlify.toml 💚 Keep build failure is lighthouse thresholds are not met" 2023-07-24 21:38:03 +02:00
package.json ⬆️ Upgrade vuepress to v1.9.10 2023-08-17 11:42:19 +02:00
readme.md 🔥 Keep the production build folder only 2022-08-18 11:08:08 +02:00
write-categories.js 🔥 Keep the production build folder only 2022-08-18 11:08:08 +02:00
write-categories.test.js Set prettier to v2.8.8 2023-07-06 21:45:39 +02:00
write-config.js 🐛 Use local Netlify logo to improve Lighthouse score 2022-10-14 16:14:54 +02:00
write-config.test.js 🐛 Use local Netlify logo to improve Lighthouse score 2022-10-14 16:14:54 +02:00
write-homepage.js 🔥 Keep the production build folder only 2022-08-18 11:08:08 +02:00
write-homepage.test.js 🔥 Keep the production build folder only 2022-08-18 11:08:08 +02:00
write-pages.js Set prettier to v2.8.8 2023-07-06 21:45:39 +02:00
write-pages.test.js Set prettier to v2.8.8 2023-07-06 21:45:39 +02:00
yarn.lock ⬆️ Upgrade vuepress to v1.9.10 2023-08-17 11:42:19 +02:00

Production Build

macos-defaults.com build status

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.

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