From a1aba59d33dc316f976046d944250db631fa66bd Mon Sep 17 00:00:00 2001 From: Gregor Date: Tue, 30 Apr 2019 11:15:51 -0700 Subject: [PATCH] WIP --- docs/src/components/api.js | 3 ++- .../{end-point-group.js => endpoint-group.js} | 2 +- .../components/{end-point.js => endpoint.js} | 9 ++++++--- docs/src/components/index-page.js | 2 -- docs/src/components/layout.js | 18 +++++++++++++++++- docs/src/pages/api/00_introduction.md | 8 +++----- docs/src/pages/index.js | 1 + 7 files changed, 30 insertions(+), 13 deletions(-) rename docs/src/components/{end-point-group.js => endpoint-group.js} (97%) rename docs/src/components/{end-point.js => endpoint.js} (99%) diff --git a/docs/src/components/api.js b/docs/src/components/api.js index 23d5b03d..2138b1a3 100644 --- a/docs/src/components/api.js +++ b/docs/src/components/api.js @@ -1,7 +1,7 @@ import React, { Component } from "react" import apiStyles from './api.module.css' import ApiSubMenu from "../components/api-sub-menu" -import EndPointGroup from "../components/end-point-group" +import EndPointGroup from "../components/endpoint-group" export default class Api extends Component { @@ -72,6 +72,7 @@ export default class Api extends Component {
+

octokit/rest.js

{this.props.data.staticMethods.edges.map(({ node }) => { return

{node.frontmatter.title}

diff --git a/docs/src/components/end-point-group.js b/docs/src/components/endpoint-group.js similarity index 97% rename from docs/src/components/end-point-group.js rename to docs/src/components/endpoint-group.js index 904544ae..675cbb5c 100644 --- a/docs/src/components/end-point-group.js +++ b/docs/src/components/endpoint-group.js @@ -1,5 +1,5 @@ import React, { Component } from "react" -import EndPoint from "../components/end-point" +import EndPoint from "../components/endpoint" export default class EndPointGroup extends Component { constructor(props) { diff --git a/docs/src/components/end-point.js b/docs/src/components/endpoint.js similarity index 99% rename from docs/src/components/end-point.js rename to docs/src/components/endpoint.js index 75d9d4c5..e2566072 100644 --- a/docs/src/components/end-point.js +++ b/docs/src/components/endpoint.js @@ -44,7 +44,13 @@ export default class EndPoint extends Component { return (

{method.name}

+
+ +
+
+
+

Parameters

@@ -66,9 +72,6 @@ export default class EndPoint extends Component {
-
-
-
) } diff --git a/docs/src/components/index-page.js b/docs/src/components/index-page.js index 70c9cdd2..23bc0a43 100644 --- a/docs/src/components/index-page.js +++ b/docs/src/components/index-page.js @@ -41,8 +41,6 @@ export default class IndexPage extends Component { const data = this.props.data return
-

octokit/rest.js

- + + + + + + + octokit/rest.js + + + + {this.props.children} + + + ) } } diff --git a/docs/src/pages/api/00_introduction.md b/docs/src/pages/api/00_introduction.md index da60ac8d..fa446d66 100644 --- a/docs/src/pages/api/00_introduction.md +++ b/docs/src/pages/api/00_introduction.md @@ -2,9 +2,7 @@ title: "Introduction" --- -### Usage - -#### Node +### Node Install with `npm install @octokit/rest`. @@ -20,7 +18,7 @@ octokit.repos.getForOrg({ }) ``` -#### Browser +### Browser 1. Download `octokit-rest.min.js` from the latest release: https://github.com/octokit/rest.js/releases @@ -44,7 +42,7 @@ octokit.repos.getForOrg({ }) ``` -#### Client options +### Client options All available client options with default values diff --git a/docs/src/pages/index.js b/docs/src/pages/index.js index 4fb4bd1a..4dba4bb7 100644 --- a/docs/src/pages/index.js +++ b/docs/src/pages/index.js @@ -37,6 +37,7 @@ export const query = graphql` name description example + documentationUrl params { name required