aboutsummaryrefslogtreecommitdiffstats
path: root/packages/react-docs/README.md
diff options
context:
space:
mode:
authorFabio Berger <me@fabioberger.com>2018-03-09 15:39:38 +0800
committerFabio Berger <me@fabioberger.com>2018-03-09 15:39:38 +0800
commit9699ee4eff8a6594bd862883cac35de80dfbcf56 (patch)
tree01c5a092bd0180101dcc012e3d21320d9addb073 /packages/react-docs/README.md
parentda277f5b2743c666a9a66e4fadf6678edd44fd69 (diff)
parent0eeaac1f2b5095441f7cd04bc948515d600d1f3a (diff)
downloaddexon-sol-tools-9699ee4eff8a6594bd862883cac35de80dfbcf56.tar
dexon-sol-tools-9699ee4eff8a6594bd862883cac35de80dfbcf56.tar.gz
dexon-sol-tools-9699ee4eff8a6594bd862883cac35de80dfbcf56.tar.bz2
dexon-sol-tools-9699ee4eff8a6594bd862883cac35de80dfbcf56.tar.lz
dexon-sol-tools-9699ee4eff8a6594bd862883cac35de80dfbcf56.tar.xz
dexon-sol-tools-9699ee4eff8a6594bd862883cac35de80dfbcf56.tar.zst
dexon-sol-tools-9699ee4eff8a6594bd862883cac35de80dfbcf56.zip
Merge branch 'development' into addPackagePublishConfig
* development: (94 commits) Update CHANGELOG Add solc 0.4.20 and 0.4.21 Prettier sra-report README Add new packages to top level README Updated @0xproject/utils in top level package.json Publish Updated CHANGELOGs Detail tests in the README Add support for ropsten and rinkeby Fix yarn.lock Update list of packages and organize them alphabetically Fix prettier issues Add support for going back to previous hashes via the browser back button to wiki Scroll to previous hashed elements when user clicks back button Add back strict null checks to react-shared package and fix issues remove ability to have implicit dependencies and add missing deps update license remove no-implicit-this Add example & screenshot to npmignore Remove `;` to be nice to windows users ...
Diffstat (limited to 'packages/react-docs/README.md')
-rw-r--r--packages/react-docs/README.md90
1 files changed, 90 insertions, 0 deletions
diff --git a/packages/react-docs/README.md b/packages/react-docs/README.md
new file mode 100644
index 000000000..3909e41c5
--- /dev/null
+++ b/packages/react-docs/README.md
@@ -0,0 +1,90 @@
+## @0xproject/react-docs
+
+A full-page React component for rendering beautiful documentation for Solidity and Typescript code generated with [TypeDoc](http://typedoc.org/) or [Doxity](https://github.com/0xproject/doxity).
+
+<div style="text-align: center;">
+<img src="./screenshot.png" style="padding-bottom: 20px; padding-top: 20px;" width="80%" />
+<div>react-docs generating 0x's smart contract docs</div>
+</div>
+
+#### Features
+
+* Mobile optimized
+* Reads Javadoc-style comments in your code to generate class/method/argument/return/type comments.
+* Syntax highlighting support for TypeScript & Solidity
+* Type declaration linking
+* Type declaration popovers to avoid clicking through to the definition
+* Section/method/type anchors for easily pointing others to a specific part of your docs.
+* Version picker
+* Customizable sidebar header
+* Supports custom markdown sections so you can easily add an intro or installation instructions.
+
+## Installation
+
+```bash
+yarn add @0xproject/react-docs
+```
+
+## Usage
+
+View the [live example](http://react-docs-example.s3-website-us-east-1.amazonaws.com/) that renders the [@0xproject/web3-wrapper](https://github.com/0xProject/0x-monorepo/tree/development/packages/web3-wrapper) Typescript package. It's source code is in the [example directory](./example).
+
+This package exposes both a single `Documentation` react component that will render a docs page, as well as all of it's sub-components in case someone wants to build their own layout.
+
+Currently this package still has some external dependencies outside of the `Documentation` component, so please start your project off by copying the `example` directory and modifying from there.
+
+## Future improvements
+
+Feel free to contribute to these improvements!
+
+* Allow user to pass in styling for all major elements similar to [Material-UI](http://www.material-ui.com/).
+* Allow user to define an alternative font and have it change everywhere.
+* Add source links to Solidity docs (currently unsupported by Doxity).
+
+## 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](../../CONTRIBUTING.md) before getting started.
+
+### Install Dependencies
+
+If you don't have yarn workspaces enabled (Yarn < v1.0) - enable them:
+
+```bash
+yarn config set workspaces-experimental true
+```
+
+Then install dependencies
+
+```bash
+yarn install
+```
+
+### Build
+
+```bash
+yarn build
+```
+
+### Lint
+
+```bash
+yarn lint
+```
+
+### Run Example
+
+```bash
+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](https://github.com/aws/aws-cli) and configure it with your AWS credentials.
+
+```bash
+yarn deploy_example
+```