protocol/packages/react-docs/README.md

@0xproject/react-docs

A full-page React component for rendering beautiful documentation generated with TypeDoc or Doxity.

Installation

yarn add @0xproject/react-docs

Contributing

We strongly encourage that the community help us make improvements and determine the future direction of the protocol. To report bugs within this package, please create an issue in this repository.

Please read our contribution guidelines before getting started.

Install Dependencies

If you don't have yarn workspaces enabled (Yarn < v1.0) - enable them:

yarn config set workspaces-experimental true

Then install dependencies

yarn install

Build

yarn build

Lint

yarn lint

Run Tests

yarn test