mirror of
https://github.com/yannbertrand/macos-defaults
synced 2024-12-14 21:52:33 +00:00
| .. | ||
| __mocks__ | ||
| __snapshots__ | ||
| templates | ||
| build.js | ||
| netlify.toml | ||
| package.json | ||
| readme.md | ||
| write-categories.js | ||
| write-categories.test.js | ||
| write-config.js | ||
| write-config.test.js | ||
| write-homepage.js | ||
| write-homepage.test.js | ||
| write-pages.js | ||
| write-pages.test.js | ||
| yarn.lock | ||
VuePress Build
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