diff options
| author | F. Eugene Aumson <feuGeneA@users.noreply.github.com> | 2018-09-26 22:15:53 +0800 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2018-09-26 22:15:53 +0800 |
| commit | 30525d15f468dc084f923b280b265cb8d5fd4975 (patch) | |
| tree | 35d941998132e83e5f5b830bbe59167f404d6e42 /packages/react-docs/README.md | |
| parent | c429409ed7a77a67368850f2e736126da0d213dd (diff) | |
| parent | 2bdaa58d71fb1e62fd07e6bf1be56d841446090b (diff) | |
| download | dexon-sol-tools-30525d15f468dc084f923b280b265cb8d5fd4975.tar dexon-sol-tools-30525d15f468dc084f923b280b265cb8d5fd4975.tar.gz dexon-sol-tools-30525d15f468dc084f923b280b265cb8d5fd4975.tar.bz2 dexon-sol-tools-30525d15f468dc084f923b280b265cb8d5fd4975.tar.lz dexon-sol-tools-30525d15f468dc084f923b280b265cb8d5fd4975.tar.xz dexon-sol-tools-30525d15f468dc084f923b280b265cb8d5fd4975.tar.zst dexon-sol-tools-30525d15f468dc084f923b280b265cb8d5fd4975.zip | |
Merge pull request #1004 from feuGeneA/sol-doc
[ethereum-types, react-docs, sol-compiler, sol-doc, types, typescript-typings, website] Add new Solidity documentation generation utility
Diffstat (limited to 'packages/react-docs/README.md')
| -rw-r--r-- | packages/react-docs/README.md | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/packages/react-docs/README.md b/packages/react-docs/README.md index 5d56207de..51e949967 100644 --- a/packages/react-docs/README.md +++ b/packages/react-docs/README.md @@ -2,7 +2,7 @@ #### 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 [Doxity](https://github.com/0xproject/doxity). +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%" /> @@ -47,7 +47,7 @@ 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). +* Add source links to Solidity docs (currently unsupported by solc, which underlies sol-doc). ## Contributing |