Skip to content

Commit ff3b557

Browse files
committed
loading markdown into dashboard!
1 parent e26b797 commit ff3b557

5 files changed

Lines changed: 468 additions & 19 deletions

File tree

package.json

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -141,6 +141,8 @@
141141
"redux-logger": "^3.0.6",
142142
"redux-saga": "^0.15.3",
143143
"redux-saga-debounce-effect": "https://github.com/madewithlove/redux-saga-debounce-effect.git#v0.2.2",
144+
"remark": "^8.0.0",
145+
"remark-react": "^4.0.0",
144146
"reselect": "^3.0.1",
145147
"rxjs": "^5.0.2",
146148
"slowparse": "^1.1.4",

src/components/Dashboard.jsx

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
import React from 'react';
22
import PropTypes from 'prop-types';
3+
import remark from 'remark';
4+
import remarkReact from 'remark-react';
35
import {t} from 'i18next';
46
import classnames from 'classnames';
57
import config from '../config';
@@ -75,7 +77,8 @@ class Dashboard extends React.Component {
7577
}
7678

7779
render() {
78-
if (!this.props.isOpen) {
80+
const {readme, isOpen} = this.props;
81+
if (!isOpen) {
7982
return null;
8083
}
8184

@@ -89,6 +92,9 @@ class Dashboard extends React.Component {
8992
return (
9093
<div className={sidebarClassnames}>
9194
{this._renderMenu()}
95+
<div className="dashboard__readme">
96+
{remark().use(remarkReact).processSync(readme).contents}
97+
</div>
9298
<div className="dashboard__spacer" />
9399
{this._renderLinks()}
94100
</div>
@@ -101,6 +107,7 @@ Dashboard.propTypes = {
101107
gistExportInProgress: PropTypes.bool.isRequired,
102108
isExperimental: PropTypes.bool.isRequired,
103109
isOpen: PropTypes.bool.isRequired,
110+
readme: PropTypes.string.isRequired,
104111
onExportGist: PropTypes.func.isRequired,
105112
onExportRepo: PropTypes.func.isRequired,
106113
};

src/containers/Dashboard.js

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,13 @@ import {
1313
} from '../selectors';
1414

1515
function mapStateToProps(state) {
16+
const project = getCurrentProject(state);
1617
return {
17-
currentProject: getCurrentProject(state),
1818
currentUser: getCurrentUser(state),
1919
gistExportInProgress: isGistExportInProgress(state),
2020
isExperimental: isExperimental(state),
2121
isOpen: isDashboardOpen(state),
22+
readme: project ? project.readme : '',
2223
};
2324
}
2425

src/css/application.css

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -370,6 +370,10 @@ body {
370370
font-weight: bold;
371371
}
372372

373+
.dashboard__readme {
374+
overflow: scroll;
375+
}
376+
373377
.dashboard__spacer {
374378
flex: 1 0 auto;
375379
}

0 commit comments

Comments
 (0)