wbu-design-system

WhereBy.Design

Hey there 👋. This is the Vue-based design system we use to produce Letterhead's interface. It's not super complex and it's kind of fun.

Our internal documentation practices could be a lot better and we are working on them. Thank you for your patience :).

Contributing

See CONTRIBUTING.md.

Commands

Run npm install to install on your machine. Run npm start to run on localhost.

How to deploy our documentation to Github Pages

• First, you need to regenerate the docs: npm run build:docs, then commit the updated files.
• Then, you need to split the dist/docs folder only into a gh-pages branch. If you already have a gh-pages branch, be sure to delete that first. git branch -D gh-pages. Then, split: git subtree split --prefix dist/docs -b gh-pages
• Force push the gh-pages branch: git push -f origin gh-pages:gh-pages

And there ya go : ).