Skip to content

Commit 557e470

Browse files
committed
Merge pull request react-bootstrap#919 from react-bootstrap/markdown-prop-docs
Add markdown support for prop comments
2 parents 3131bc3 + 86f5936 commit 557e470

File tree

3 files changed

+8
-1
lines changed

3 files changed

+8
-1
lines changed

docs/generate-metadata.js

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,11 @@ import metadata from 'react-component-metadata';
22
import glob from 'glob';
33
import fsp from 'fs-promise';
44
import promisify from '../tools/promisify';
5+
import marked from 'marked';
6+
7+
marked.setOptions({
8+
xhtml: true
9+
});
510

611
let globp = promisify(glob);
712

@@ -23,6 +28,7 @@ let isLiteral = str => str.trim()[0] === '"' || str.trim()[0] === "'";
2328
function parseDoclets(obj){
2429
obj.doclets = metadata.parseDoclets(obj.desc || '');
2530
obj.desc = cleanDoclets(obj.desc || '');
31+
obj.descHtml = marked(obj.desc || '');
2632
}
2733

2834
/**

docs/src/PropTable.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ const PropTable = React.createClass({
7070
<div>{this.getType(prop)}</div>
7171
</td>
7272
<td>{prop.defaultValue}</td>
73-
<td>{prop.desc}</td>
73+
<td dangerouslySetInnerHTML={{__html: prop.descHtml }}></td>
7474
</tr>
7575
);
7676
});

package.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -86,6 +86,7 @@
8686
"less": "^2.4.0",
8787
"less-loader": "^2.1.0",
8888
"lodash": "^3.5.0",
89+
"marked": "^0.3.3",
8990
"mocha": "^2.2.1",
9091
"mt-changelog": "^0.5.2",
9192
"node-libs-browser": "^0.5.2",

0 commit comments

Comments
 (0)