Skip to content
This repository was archived by the owner on Sep 3, 2024. It is now read-only.

Commit 82679ee

Browse files
render documentation with markdown
1 parent 52dfb9c commit 82679ee

File tree

8 files changed

+68
-12
lines changed

8 files changed

+68
-12
lines changed

package.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@
2626
"react": "16.5.2",
2727
"react-dom": "16.5.2",
2828
"react-inspector": "2.3.0",
29+
"react-remarkable": "1.1.3",
2930
"react-schema-form": "0.5.0",
3031
"react-scripts": "2.0.5",
3132
"react-tap-event-plugin": "3.0.2",

src/SqlStreamStoreBrowser.js

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,8 @@ const initialNavigation = ({ authorization }) =>
4949
const formActions = {
5050
[rels.append]: actions.post,
5151
[rels.metadata]: actions.post,
52-
[rels.delete]: actions.delete,
52+
[rels.deleteStream]: actions.delete,
53+
[rels.deleteMessage]: actions.delete,
5354
};
5455

5556
const Hero = () => (

src/components/HyperMediaControls/HelpButton.js

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
11
import React, { PureComponent } from 'react';
22
import { Button, Drawer, withStyles } from '@material-ui/core';
3+
import Remarkable from 'react-remarkable';
34
import uriTemplate from 'uri-template';
45
import { Help } from '../Icons';
56
import { withAuthorization } from '../AuthorizationProvider';
67
import { http } from '../../utils';
8+
import Typography from '@material-ui/core/es/Typography/Typography';
79

810
const getCurie = (rel, curies) => {
911
const [prefix, rest] = rel.split(':', 2);
@@ -20,11 +22,12 @@ const getCurie = (rel, curies) => {
2022
}))[0] || { href: rel };
2123
};
2224

23-
const Documentation = withStyles({
25+
const Documentation = withStyles(theme => ({
2426
drawerPaper: {
25-
width: 480,
27+
width: '45%',
28+
padding: theme.spacing.unit * 2,
2629
},
27-
})(({ open, children, onClose, classes }) => (
30+
}))(({ open, children, onClose, classes }) => (
2831
<Drawer
2932
open={open}
3033
onClose={onClose}
@@ -33,7 +36,15 @@ const Documentation = withStyles({
3336
paper: classes.drawerPaper,
3437
}}
3538
>
36-
{children}
39+
<Typography>
40+
<Remarkable
41+
options={{
42+
typographer: true,
43+
}}
44+
>
45+
{children}
46+
</Remarkable>
47+
</Typography>
3748
</Drawer>
3849
));
3950

src/components/RelIcon.js

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,8 @@ const fontIconByRel = {
2525
[rels.feed]: RssFeed,
2626
[rels.append]: Publish,
2727
[rels.metadata]: Settings,
28-
[rels.delete]: DeleteForever,
28+
[rels.deleteStream]: DeleteForever,
29+
[rels.deleteMessage]: DeleteForever,
2930
[rels.find]: Search,
3031
[rels.browse]: List,
3132
[rels.curies]: Help,

src/stream-store/rels.js

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,8 @@ const rels = {
1010
metadata: 'streamStore:metadata',
1111
index: 'streamStore:index',
1212
append: 'streamStore:append',
13-
delete: 'streamStore:delete',
13+
deleteStream: 'streamStore:delete-stream',
14+
deleteMessage: 'streamStore:delete-message',
1415
find: 'streamStore:find',
1516
browse: 'streamStore:feed-browser',
1617
};

src/stream-store/store.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ const forms$ = body$.map(({ _embedded }) =>
1515
.filter(
1616
rel =>
1717
_embedded[rel].$schema &&
18-
_embedded[rel].$schema.endsWith('hyper-schema#'),
18+
_embedded[rel].$schema.endsWith('schema#'),
1919
)
2020
.reduce((akk, rel) => ({ ...akk, [rel]: _embedded[rel] }), {}),
2121
);

src/utils/http.js

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,13 @@
11
import mediaTypes from './mediaTypes';
22

3-
const tryParseJson = body => {
3+
const isJson = mediaType =>
4+
mediaType === mediaTypes.json || (mediaType || '').endsWith('+json');
5+
6+
const getBody = async (response, headers) => {
7+
const body = await response.text();
8+
if (!isJson(headers['content-type'])) {
9+
return body;
10+
}
411
try {
512
return JSON.parse(body);
613
} catch (e) {
@@ -18,11 +25,13 @@ const getHeaders = headers =>
1825
);
1926

2027
const mapResponse = async response => {
21-
const { ok, status, statusText, url, headers } = response;
28+
const { ok, status, statusText, url } = response;
29+
30+
const headers = getHeaders(response.headers);
2231

2332
return {
24-
body: tryParseJson(await response.text()),
25-
headers: getHeaders(headers),
33+
body: await getBody(response, headers),
34+
headers,
2635
ok,
2736
status,
2837
statusText,

yarn.lock

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1130,6 +1130,13 @@ argparse@^1.0.7:
11301130
dependencies:
11311131
sprintf-js "~1.0.2"
11321132

1133+
argparse@~0.1.15:
1134+
version "0.1.16"
1135+
resolved "https://registry.yarnpkg.com/argparse/-/argparse-0.1.16.tgz#cfd01e0fbba3d6caed049fbd758d40f65196f57c"
1136+
dependencies:
1137+
underscore "~1.7.0"
1138+
underscore.string "~2.4.0"
1139+
11331140
aria-query@^3.0.0:
11341141
version "3.0.0"
11351142
resolved "https://registry.yarnpkg.com/aria-query/-/aria-query-3.0.0.tgz#65b3fcc1ca1155a8c9ae64d6eee297f15d5133cc"
@@ -1272,6 +1279,10 @@ atob@^2.1.1:
12721279
version "2.1.1"
12731280
resolved "https://registry.yarnpkg.com/atob/-/atob-2.1.1.tgz#ae2d5a729477f289d60dd7f96a6314a22dd6c22a"
12741281

1282+
autolinker@~0.15.0:
1283+
version "0.15.3"
1284+
resolved "https://registry.yarnpkg.com/autolinker/-/autolinker-0.15.3.tgz#342417d8f2f3461b14cf09088d5edf8791dc9832"
1285+
12751286
autoprefixer@^9.1.5:
12761287
version "9.2.0"
12771288
resolved "https://registry.yarnpkg.com/autoprefixer/-/autoprefixer-9.2.0.tgz#e46f893882b19a160370e7bcd3ec6bbeaace4d10"
@@ -7156,6 +7167,12 @@ react-lifecycles-compat@^3.0.2, react-lifecycles-compat@^3.0.4:
71567167
version "3.0.4"
71577168
resolved "https://registry.yarnpkg.com/react-lifecycles-compat/-/react-lifecycles-compat-3.0.4.tgz#4f1a273afdfc8f3488a8c516bfda78f872352362"
71587169

7170+
react-remarkable@1.1.3:
7171+
version "1.1.3"
7172+
resolved "https://registry.yarnpkg.com/react-remarkable/-/react-remarkable-1.1.3.tgz#6ef3861812d806fbf747cc1d1e151ee3172130a6"
7173+
dependencies:
7174+
remarkable "^1.x"
7175+
71597176
react-schema-form@0.5.0:
71607177
version "0.5.0"
71617178
resolved "https://registry.yarnpkg.com/react-schema-form/-/react-schema-form-0.5.0.tgz#77b4865d2f1c25f00e166f940ca376bfbfacfb6c"
@@ -7453,6 +7470,13 @@ relateurl@0.2.x:
74537470
version "0.2.7"
74547471
resolved "https://registry.yarnpkg.com/relateurl/-/relateurl-0.2.7.tgz#54dbf377e51440aca90a4cd274600d3ff2d888a9"
74557472

7473+
remarkable@^1.x:
7474+
version "1.7.1"
7475+
resolved "https://registry.yarnpkg.com/remarkable/-/remarkable-1.7.1.tgz#aaca4972100b66a642a63a1021ca4bac1be3bff6"
7476+
dependencies:
7477+
argparse "~0.1.15"
7478+
autolinker "~0.15.0"
7479+
74567480
remove-trailing-separator@^1.0.1:
74577481
version "1.1.0"
74587482
resolved "https://registry.yarnpkg.com/remove-trailing-separator/-/remove-trailing-separator-1.1.0.tgz#c24bce2a283adad5bc3f58e0d48249b92379d8ef"
@@ -8548,10 +8572,18 @@ uglifyjs-webpack-plugin@^1.2.4:
85488572
webpack-sources "^1.1.0"
85498573
worker-farm "^1.5.2"
85508574

8575+
underscore.string@~2.4.0:
8576+
version "2.4.0"
8577+
resolved "http://registry.npmjs.org/underscore.string/-/underscore.string-2.4.0.tgz#8cdd8fbac4e2d2ea1e7e2e8097c42f442280f85b"
8578+
85518579
underscore@^1.8.3:
85528580
version "1.9.1"
85538581
resolved "https://registry.yarnpkg.com/underscore/-/underscore-1.9.1.tgz#06dce34a0e68a7babc29b365b8e74b8925203961"
85548582

8583+
underscore@~1.7.0:
8584+
version "1.7.0"
8585+
resolved "https://registry.yarnpkg.com/underscore/-/underscore-1.7.0.tgz#6bbaf0877500d36be34ecaa584e0db9fef035209"
8586+
85558587
unicode-canonical-property-names-ecmascript@^1.0.4:
85568588
version "1.0.4"
85578589
resolved "https://registry.yarnpkg.com/unicode-canonical-property-names-ecmascript/-/unicode-canonical-property-names-ecmascript-1.0.4.tgz#2619800c4c825800efdd8343af7dd9933cbe2818"

0 commit comments

Comments
 (0)