Add MD sections to contract-wrappers docs

This commit is contained in:
Fabio Berger
2018-08-02 21:09:38 +02:00
parent 90ead59d34
commit c7a5b8c776
3 changed files with 33 additions and 4 deletions

View File

@@ -0,0 +1,11 @@
**Install**
```bash
npm install @0xproject/contract-wrappers --save
```
**Import**
```javascript
import { ContractWrappers } from '@0xproject/contract-wrappers';
```

View File

@@ -0,0 +1,3 @@
<b>**NOTE:** Release candidate versions are meant to work with V2 of 0x protocol. To interact with V1, select a 0.X version.</b>
Welcome to the [Contract-wrappers](https://github.com/0xProject/0x-monorepo/tree/development/packages/contract-wrappers) documentation! Contract-wrappers is a library for interacting with the Ethereum smart contracts that make up the 0x protocol. With it, you can easily send transactions and make calls to the 0x smart contracts as well as any token adhering to the token standards supported by the protocol (currently ERC20 & ERC721).

View File

@@ -9,16 +9,31 @@ import { DocPackages } from 'ts/types';
import { constants } from 'ts/utils/constants';
import { Translate } from 'ts/utils/translate';
// TODO: Add MD sections
const markdownSections = {};
/* tslint:disable:no-var-requires */
const IntroMarkdown = require('md/docs/contract_wrappers/introduction');
const InstallMarkdown = require('md/docs/contract_wrappers/installation');
/* tslint:enable:no-var-requires */
const markdownSections = {
introduction: 'introduction',
installation: 'installation',
};
const docsInfoConfig: DocsInfoConfig = {
id: DocPackages.ContractWrappers,
type: SupportedDocJson.TypeDoc,
displayName: 'Contract Wrappers',
packageUrl: 'https://github.com/0xProject/0x-monorepo',
markdownMenu: {},
sectionNameToMarkdownByVersion: {},
markdownMenu: {
introduction: [markdownSections.introduction],
install: [markdownSections.installation],
},
sectionNameToMarkdownByVersion: {
'0.0.1': {
[markdownSections.introduction]: IntroMarkdown,
[markdownSections.installation]: InstallMarkdown,
},
},
markdownSections,
typeConfigs: {
typeNameToPrefix: {},