aboutsummaryrefslogtreecommitdiffstats
path: root/packages
diff options
context:
space:
mode:
authorFabio Berger <me@fabioberger.com>2017-11-29 05:42:37 +0800
committerFabio Berger <me@fabioberger.com>2017-11-29 05:42:37 +0800
commit166c741beb569ea5245a47203edaef4c9232b8d4 (patch)
tree084fd8425117a0fe03b8c8feda33ccfa264ee6f1 /packages
parent629a0fa3a562a9df00eeeb5ce5b1bad853008ac3 (diff)
downloaddexon-sol-tools-166c741beb569ea5245a47203edaef4c9232b8d4.tar.gz
dexon-sol-tools-166c741beb569ea5245a47203edaef4c9232b8d4.tar.zst
dexon-sol-tools-166c741beb569ea5245a47203edaef4c9232b8d4.zip
Add connect docs
Diffstat (limited to 'packages')
-rw-r--r--packages/website/ts/containers/connect_documentation.tsx97
-rw-r--r--packages/website/ts/index.tsx7
-rw-r--r--packages/website/ts/types.ts1
3 files changed, 105 insertions, 0 deletions
diff --git a/packages/website/ts/containers/connect_documentation.tsx b/packages/website/ts/containers/connect_documentation.tsx
new file mode 100644
index 000000000..f6ae53a30
--- /dev/null
+++ b/packages/website/ts/containers/connect_documentation.tsx
@@ -0,0 +1,97 @@
+import BigNumber from 'bignumber.js';
+import * as _ from 'lodash';
+import * as React from 'react';
+import {connect} from 'react-redux';
+import {Dispatch, Store as ReduxStore} from 'redux';
+import {Blockchain} from 'ts/blockchain';
+import {DocsInfo} from 'ts/pages/documentation/docs_info';
+import {
+ Documentation as DocumentationComponent,
+ DocumentationAllProps,
+} from 'ts/pages/documentation/documentation';
+import {Dispatcher} from 'ts/redux/dispatcher';
+import {State} from 'ts/redux/reducer';
+import {DocsInfoConfig, WebsitePaths} from 'ts/types';
+import {typeDocUtils} from 'ts/utils/typedoc_utils';
+
+/* tslint:disable:no-var-requires */
+const IntroMarkdown = require('md/docs/connect/introduction');
+const InstallationMarkdown = require('md/docs/connect/installation');
+/* tslint:enable:no-var-requires */
+
+const connectDocSections = {
+ introduction: 'introduction',
+ installation: 'installation',
+ httpClient: 'httpClient',
+ types: 'types',
+};
+
+const docsInfoConfig: DocsInfoConfig = {
+ packageName: '0x Connect',
+ subPackageName: 'connect',
+ packageUrl: 'https://github.com/0xProject/0x.js',
+ websitePath: WebsitePaths.Connect,
+ docsJsonRoot: 'https://s3.amazonaws.com/connect-docs-jsons',
+ menu: {
+ introduction: [
+ connectDocSections.introduction,
+ ],
+ install: [
+ connectDocSections.installation,
+ ],
+ httpClient: [
+ connectDocSections.httpClient,
+ ],
+ types: [
+ connectDocSections.types,
+ ],
+ },
+ sectionNameToMarkdown: {
+ [connectDocSections.introduction]: IntroMarkdown,
+ [connectDocSections.installation]: InstallationMarkdown,
+ },
+ // Note: This needs to be kept in sync with the types exported in index.ts. Unfortunately there is
+ // currently no way to extract the re-exported types from index.ts via TypeDoc :(
+ publicTypes: [
+ 'Client',
+ 'FeesRequest',
+ 'FeesResponse',
+ 'OrderbookRequest',
+ 'OrderbookResponse',
+ 'OrdersRequest',
+ 'TokenPairsItem',
+ 'TokenPairsRequest',
+ ],
+ sectionNameToModulePath: {
+ [connectDocSections.httpClient]: ['"src/http_client"'],
+ [connectDocSections.types]: ['"src/types"'],
+ },
+ menuSubsectionToVersionWhenIntroduced: {},
+ sections: connectDocSections,
+ visibleConstructors: [connectDocSections.httpClient],
+ convertToDocAgnosticFormatFn: typeDocUtils.convertToDocAgnosticFormat.bind(typeDocUtils),
+};
+const docsInfo = new DocsInfo(docsInfoConfig);
+
+interface ConnectedState {
+ docsVersion: string;
+ availableDocVersions: string[];
+ docsInfo: DocsInfo;
+}
+
+interface ConnectedDispatch {
+ dispatcher: Dispatcher;
+}
+
+const mapStateToProps = (state: State, ownProps: DocumentationAllProps): ConnectedState => ({
+ docsVersion: state.docsVersion,
+ availableDocVersions: state.availableDocVersions,
+ docsInfo,
+});
+
+const mapDispatchToProps = (dispatch: Dispatch<State>): ConnectedDispatch => ({
+ dispatcher: new Dispatcher(dispatch),
+});
+
+export const Documentation: React.ComponentClass<DocumentationAllProps> =
+ connect(mapStateToProps, mapDispatchToProps)(DocumentationComponent);
diff --git a/packages/website/ts/index.tsx b/packages/website/ts/index.tsx
index 8b6d4d956..283eb8125 100644
--- a/packages/website/ts/index.tsx
+++ b/packages/website/ts/index.tsx
@@ -87,6 +87,12 @@ const LazySmartContractsDocumentation = createLazyComponent(
/* webpackChunkName: "smartContractDocs" */'ts/containers/smart_contracts_documentation',
),
);
+const LazyConnectDocumentation = createLazyComponent(
+ 'Documentation',
+ async () => System.import<any>(
+ /* webpackChunkName: "connectDocs" */'ts/containers/connect_documentation',
+ ),
+);
const docs = class Documentation extends
React.Component<any, any> {
@@ -112,6 +118,7 @@ render(
<Route path={`${WebsitePaths.About}`} component={About as any} />
<Route path={`${WebsitePaths.Wiki}`} component={Wiki as any} />
<Route path={`${WebsitePaths.ZeroExJs}/:version?`} component={LazyZeroExJSDocumentation} />
+ <Route path={`${WebsitePaths.Connect}/:version?`} component={LazyConnectDocumentation} />
<Route
path={`${WebsitePaths.SmartContracts}/:version?`}
component={LazySmartContractsDocumentation}
diff --git a/packages/website/ts/types.ts b/packages/website/ts/types.ts
index ca38cecc8..96eae938d 100644
--- a/packages/website/ts/types.ts
+++ b/packages/website/ts/types.ts
@@ -662,6 +662,7 @@ export enum WebsitePaths {
About = '/about',
Whitepaper = '/pdfs/0x_white_paper.pdf',
SmartContracts = '/docs/contracts',
+ Connect = '/docs/connect',
}
export interface DocsMenu {