mirror of
https://github.com/yannbertrand/macos-defaults
synced 2024-12-16 14:42:32 +00:00
6d58d1a3ed
To avoid paying for more builds!
Also
✏️ Fix start locally command in README for Docusaurus
|
||
---|---|---|
.. | ||
__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 |
docsify Build
My opinion
docsify was the easiest to setup as it's pretty much the same markdown as VuePress.
😄 Good
- Really easy to setup & deploy
- index.html direct access
- Provides 3 other themes than the Vue default one
😕 Bad
- Requires JavaScript
- Internationalization is not documented and tough to setup
- The full text search is pretty bad
- The docsify-cli is really basic
😫 Ugly
- The pure theme
How does it work?
Here is the built website architecture:
index.html
- A basic HTML file that will build the pages dynamically from the others files using the docsify JS library
_sidebar.md
- The sidebar configuration which is really easy to setup
readme.md
- The main page content
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.
It is deployed as is on Netlify!
I also added some plugins (JS libs in the index.html file):
- prismjs prism-bash for language highliting
- docsify search to get a full text search
- docsify zoom-image to add Medium zoom on images
- docsify copy-to-clipboard to... Copy code
Try locally
🏗 Install
yarn install
🚀 Usage
This will build the defaults.yml file and run a docsify server on http://localhost:3000/. Sources of the website are available in the docs
folder.
yarn start
🚧 Run unit tests
yarn test