1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
|
/*
* SonarQube
* Copyright (C) 2009-2019 SonarSource SA
* mailto:info AT sonarsource DOT com
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 3 of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this program; if not, write to the Free Software Foundation,
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
import * as React from 'react';
import * as classNames from 'classnames';
import remark from 'remark';
import reactRenderer from 'remark-react';
import slug from 'remark-slug';
import remarkCustomBlocks from 'remark-custom-blocks';
import DocLink from './DocLink';
import DocImg from './DocImg';
import DocToc from './DocToc';
import DocTooltipLink from './DocTooltipLink';
import DocCollapsibleBlock from './DocCollapsibleBlock';
import { separateFrontMatter, filterContent } from '../../helpers/markdown';
import { scrollToElement } from '../../helpers/scrolling';
interface Props {
childProps?: T.Dict<string>;
className?: string;
content: string | undefined;
displayH1?: boolean;
isTooltip?: boolean;
stickyToc?: boolean;
}
export default class DocMarkdownBlock extends React.PureComponent<Props> {
node: HTMLElement | null = null;
handleAnchorClick = (href: string, event: React.MouseEvent<HTMLAnchorElement>) => {
if (this.node) {
const element = this.node.querySelector(href);
if (element) {
event.preventDefault();
scrollToElement(element, { bottomOffset: window.innerHeight - 80 });
if (history.pushState) {
history.pushState(null, '', href);
}
}
}
};
render() {
const { childProps, content, className, displayH1, stickyToc, isTooltip } = this.props;
const parsed = separateFrontMatter(content || '');
const filteredContent = filterContent(parsed.content);
const md = remark();
// TODO find a way to replace these custom blocks with real Alert components
md.use(remarkCustomBlocks, {
danger: { classes: 'alert alert-danger' },
warning: { classes: 'alert alert-warning' },
info: { classes: 'alert alert-info' },
success: { classes: 'alert alert-success' },
collapse: { classes: 'collapse' }
})
.use(reactRenderer, {
remarkReactComponents: {
div: Block,
// use custom link to render documentation anchors
a: isTooltip
? withChildProps(DocTooltipLink, childProps)
: withChildProps(DocLink, { onAnchorClick: this.handleAnchorClick }),
// use custom img tag to render documentation images
img: DocImg
},
toHast: {},
sanitize: false
})
.use(slug);
return (
<div
className={classNames('markdown', className, { 'has-toc': stickyToc })}
ref={ref => (this.node = ref)}>
<div className="markdown-content">
{displayH1 && <h1 className="documentation-title">{parsed.frontmatter.title}</h1>}
{md.processSync(filteredContent).contents}
</div>
{stickyToc && <DocToc content={filteredContent} onAnchorClick={this.handleAnchorClick} />}
</div>
);
}
}
function withChildProps<P>(
WrappedComponent: React.ComponentType<P & { customProps?: T.Dict<any> }>,
childProps?: T.Dict<any>
) {
return function withChildProps(props: P) {
return <WrappedComponent customProps={childProps} {...props} />;
};
}
function Block(props: React.HtmlHTMLAttributes<HTMLDivElement>) {
if (props.className) {
if (props.className.includes('collapse')) {
return <DocCollapsibleBlock>{props.children}</DocCollapsibleBlock>;
} else {
return <div className={classNames('cut-margins', props.className)}>{props.children}</div>;
}
} else {
return props.children;
}
}
|
