mirror of
https://github.com/yannbertrand/macos-defaults
synced 2024-11-14 23:57:07 +00:00
📝 Add explanations in production readme
This commit is contained in:
parent
42235c5c35
commit
83ef088046
1 changed files with 4 additions and 26 deletions
|
@ -1,32 +1,10 @@
|
|||
# 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
|
||||
- 🤷♂️
|
||||
# Production Build
|
||||
![macos-defaults.com build status](https://api.netlify.com/api/v1/badges/44ddda91-1e32-4e41-9afc-5f640b33aca7/deploy-status)
|
||||
|
||||
## How does it work?
|
||||
Here is the built website architecture:
|
||||
- [`.vuepress/config.yml`](./templates/.vuepress/config.yml.handlebars)
|
||||
* Contains the whole VuePress configuration from title to sidebar config
|
||||
- `readme.md`
|
||||
* The main page content
|
||||
It's similar to the VuePress build with a few tweaks (accent color, assets, SEO stuff...).
|
||||
|
||||
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](https://v1.vuepress.vuejs.org/plugin/official/plugin-medium-zoom.html) plugin to add Medium zoom on images.
|
||||
See [VuePress' build detail](../vuepress/readme.md) for more explanations.
|
||||
|
||||
## Try locally
|
||||
### 🏗 Install
|
||||
|
|
Loading…
Reference in a new issue