aboutsummaryrefslogtreecommitdiffstats
path: root/packages/react-docs/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'packages/react-docs/README.md')
-rw-r--r--packages/react-docs/README.md96
1 files changed, 0 insertions, 96 deletions
diff --git a/packages/react-docs/README.md b/packages/react-docs/README.md
deleted file mode 100644
index 7b1f4f80a..000000000
--- a/packages/react-docs/README.md
+++ /dev/null
@@ -1,96 +0,0 @@
-## @0x/react-docs
-
-#### WARNING: Alpha software. Expect things to break when trying to use.
-
-A full-page React component for rendering beautiful documentation for Solidity and Typescript code generated with [TypeDoc](http://typedoc.org/) or [sol-doc](https://github.com/0xProject/0x-monorepo/tree/development/packages/sol-doc).
-
-<div style="text-align: center;">
-<img src="https://s3.eu-west-2.amazonaws.com/0x-wiki-images/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 @0x/react-docs
-```
-
-## Usage
-
-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 [react-docs-example](https://github.com/0xProject/0x-monorepo/tree/development/packages/react-docs-example) directory and modifying it there. If you need changes in the [react-docs](https://github.com/0xProject/0x-monorepo/tree/development/packages/react-docs) package, fork the 0x monorepo, make the required changes and submit a PR. Until we merge it, you can have your project depend on your own custom fork.
-
-If your project is in [TypeScript](https://www.typescriptlang.org/), add the following to your `tsconfig.json`:
-
-```json
-"compilerOptions": {
- "typeRoots": ["node_modules/@0x/typescript-typings/types", "node_modules/@types"],
-}
-```
-
-## 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 solc, which underlies sol-doc).
-
-## Contributing
-
-We welcome improvements and fixes from the wider community! 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
-
-To build this package and all other monorepo packages that it depends on, run the following from the monorepo root directory:
-
-```bash
-PKG=@0x/react-docs yarn build
-```
-
-Or continuously rebuild on change:
-
-```bash
-PKG=@0x/react-docs yarn watch
-```
-
-### Clean
-
-```bash
-yarn clean
-```
-
-### Lint
-
-```bash
-yarn lint
-```