The guides are created with VuePress and are written in Markdown.
The actual guides sourcefiles live in the /guides
folder.
Run
yarn install
to install VuePress.
To run a local preview server, run
yarn guides:preview
The server will be available at http://localhost:8080.
Build the guides html files with:
yarn guides:build
Deployment is done automatically via netlify whenever a change is merged into the master branch.
- Fork it
- Create a branch (
git checkout -b my-new-guide
) - Commit your changes (
git commit -am 'Add new guide for elements'
) - Push to the branch (
git push origin my-new-guide
) - Create new Pull Request