Skip to content

Commit

Permalink
doc(doc): update doc
Browse files Browse the repository at this point in the history
  • Loading branch information
chongqiangchen committed Apr 20, 2023
1 parent 237fff4 commit 1768009
Show file tree
Hide file tree
Showing 3 changed files with 27 additions and 1 deletion.
25 changes: 24 additions & 1 deletion apps/doc/docs/expansion/docusaurus-plugins/guide.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ contract Storage {
```
````

### 展示结果
5. 你将看到

```solidity solive height=500px
/**
Expand Down Expand Up @@ -141,3 +141,26 @@ contract Storage {
}
}
```

### 极简模式

在部分场景下可能只需要展示代码块,而不需要编辑器,你可以使用极简模式(这将关闭语法校验,部署,编译,文件导航功能):

````md
```solidity solive simple=true height=160px
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.4;
contract HelloWeb3{
string public _string = "Hello Web3!";
}
```
````

```solidity solive simple=true height=160px
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.4;
contract HelloWeb3{
string public _string = "Hello Web3!";
}
```
1 change: 1 addition & 0 deletions apps/doc/docs/expansion/docusaurus-plugins/props.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ hide_title: true
| --- | --- | --- | --- |
| width | string | 90% | 容器宽度 |
| height | string | 500px | 容器高度 |
| simple | boolean | false | 是否极简模式 |
| consoleOpen | boolean | true | 是否显示控制台 |
| consoleTriggerControl | boolean | false | 是否显示控制台触发按钮 |
| consoleDefaultVisible | boolean | false | 控制台默认是否可见 |
Expand Down
2 changes: 2 additions & 0 deletions apps/doc/docs/solive-props.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ hide_title: true
| modelInfos | 文件信息 | array | [] ||
| height | 高度 | string | - ||
| rounded | 窗口弧度 | string | 12px | - |
| disableValidation | 是否禁用校验 | boolean | false | - |
| monacoEditorOptions | monaco编辑器配置 | (参考 [IStandaloneEditorConstructionOptions](https://microsoft.github.io/monaco-editor/typedoc/interfaces/editor.IStandaloneEditorConstructionOptions.html)) | - | - |
| fileNav | 顶部文件导航 | TFileNav | (参考 [TFileNav](/docs/solive-props#tfilenav)) | - |
| console | 日志块 | TConsole | (参考 [TConsole](/docs/solive-props#tconsole)) | - |
| deploy | 部署块 | TDeploy | (参考 [TDeploy](/docs/solive-props#tdeploy)) | - |
Expand Down

0 comments on commit 1768009

Please sign in to comment.