cygy/ovh-ui-kit-documentation

Documentation for the OVH UI Kit

OVH UI Documentation

This is a showcase application for our UI-Kit.

Quick start

$ git clone https://github.com/ovh-ux/ovh-ui-kit-documentation.git
$ cd ovh-ui-kit-documentation
$ yarn install
$ yarn start

Develop

Hot reload

Once you have yarn start-ed the project, you can edit anything with an automatic browser refresh as a result.

ovh-documentation-toolkit

This documentation uses the ovh-documentation-toolkit to display the components status, manage the active theme, etc... If you have to update the code of this project, you can simply clone and link it with the ovh-ui-kit-documentation.

$ git clone https://github.com/ovh-ux/ovh-documentation-toolkit.git
$ cd ovh-documentation-toolkit
$ yarn link
$ cd path/to/ovh-ui-kit-documentation
$ yarn link ovh-documentation-toolkit

Now, each modification on ovh-documentation-toolkit will benefit from hot-reloading.

Contribute

Please refer to CONTRIBUTING.