README.md

Toolbox - Documentation

⚠️ Deprecated in favor of Storybox ⚠️

This is the complete Toolbox documentation repository based on Gitbook.

Installation

$ yarn install 

During doc writing

$ yarn start

During homepage development

Because it's not Gitbook nativ, the custom homepage will replace the empty README.md -> _book/index.html. So, if you are working only on it, you can start a Browser Sync server using :

$ yarn serve

During styles development

$ yarn styles

To build the doc

$ yarn build

To deploy the doc on the dedicated gh-pages

$ yarn deploy