@0xproject/react-docs-example
An example documentation page built using react-docs rendering the @0xproject/web3-wrapper Typescript package. This is a great starter project for hosting your own Solidity or Typescript documentation page.
Usage
This package is intended as a boilerplate for creating and hosting your own documentation page. Easiest way to get started is to fork the 0x-monorepo and start modifying react-docs-example.
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
Start the dev server
yarn dev
Deploy Example to S3 bucket
You will need to adapt the deploy_example command in the package.json to point to an S3 bucket you've created. Make sure the bucket is publicly accessible to everyone.
You will also need to install the aws-cli and configure it with your AWS credentials.
yarn deploy_example
Build
yarn build
Lint
yarn lint
Contributing
We strongly encourage the community to help us make improvements. To report bugs within this package, please create an issue in this repository.
Please read our contribution guidelines before getting started.