Skip to content

Commit cac8b83

Browse files
authored
feat: update guide (#24)
* feat: support jsonl file * chore: update pnpm-lock * chore: format files * chore: add pyproject rules * feat: update guide * feat: update guide
1 parent 7bf055c commit cac8b83

File tree

4 files changed

+29
-68
lines changed

4 files changed

+29
-68
lines changed

packages/secretnote/src/components/sh-viewer/index.less

-37
This file was deleted.

packages/secretnote/src/components/sh-viewer/index.tsx

+14-15
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,25 @@
1-
import './index.less';
1+
import hljs from 'highlight.js';
2+
import { useEffect } from 'react';
3+
4+
import 'highlight.js/styles/a11y-dark.css';
25

36
interface IProps {
4-
code: string[];
7+
code: string;
58
className?: string;
69
style?: React.CSSProperties;
710
}
811

9-
const ShViewer = (props: IProps) => {
10-
const { code, className, style } = props;
12+
const ShViewer = ({ code }: IProps) => {
13+
useEffect(() => {
14+
hljs.highlightAll();
15+
}, []);
1116

1217
return (
13-
<div className={`${className || ''} language-sh`} style={style}>
14-
<pre>
15-
<code>
16-
{code.map((line, index) => (
17-
<span className="line" key={index}>
18-
<span className="caret">&gt;</span> <span className="code">{line}</span>
19-
</span>
20-
))}
21-
</code>
22-
</pre>
23-
</div>
18+
<pre style={{ background: '#2b2b2b', padding: '12px 0', borderRadius: 8 }}>
19+
<code className="language-bash" style={{ padding: '0 1em' }}>
20+
{code}
21+
</code>
22+
</pre>
2423
);
2524
};
2625

packages/secretnote/src/modules/welcome/index.less

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
}
1313

1414
.process {
15-
width: 720px;
15+
width: 800px;
1616
height: 100%;
1717

1818
.header {

packages/secretnote/src/modules/welcome/view.tsx

+14-15
Original file line numberDiff line numberDiff line change
@@ -30,23 +30,22 @@ interface DescriptionProps {
3030
const PrepareNodeDes = (props: DescriptionProps) => {
3131
return (
3232
<div className="step">
33-
<div className="text">最简单的方式就是使用 docker image 启动两个计算节点。</div>
34-
<ShViewer code={['docker run -it secretflow/secretnote']} />
3533
<div className="text">
36-
启动成功后,我们可以打开地址
37-
<a
38-
className="link"
39-
href="http://127.0.0.1:8090"
40-
target="_blank"
41-
rel="noreferrer"
42-
>
43-
127.0.0.1:8090
44-
</a>
45-
访问 secretnote
46-
页面并在右上角节点管理区域将两个节点添加进来。(两个节点地址默认为 127.0.0.1:8090
47-
和 127.0.0.1:8092)。
34+
最简单的方式就是使用 docker image 启动两个计算节点。分别在两台机器上启动容器:
35+
</div>
36+
<ShViewer
37+
code={`# alice 机器\ndocker run -it -p 8888:8888 -e "SELF_PARTY=alice" secretflow/secretnote:unstable-amd64`}
38+
/>
39+
<ShViewer
40+
code={`# bob 机器\ndocker run -it -p 8888:8888 -e "SELF_PARTY=bob" secretflow/secretnote:unstable-amd64`}
41+
/>
42+
<div className="text">
43+
启动成功后,可以通过访问任意一台机器的 Web
44+
页面(例如:http://ip-alice:8888)访问
45+
SecretNote,并在右上角节点管理区域将两个节点添加进来(两个节点地址为
46+
http://ip-alice:8888 和 http://ip-bob:8888)。
4847
</div>
49-
<img src={addNodeImgUrl} alt="add node" style={{ margin: 0 }} />
48+
<img src={addNodeImgUrl} alt="add node" style={{ width: 450, margin: 0 }} />
5049
{!props.finished && (
5150
<Button type="link" onClick={() => props.done(0)}>
5251
完成

0 commit comments

Comments
 (0)