Skip to content

Commit

Permalink
style(solive-doc): format mdx style
Browse files Browse the repository at this point in the history
  • Loading branch information
@chongqiangchen
chongqiangchen committed May 27, 2023
1 parent 480b9f0 commit cf6772e
Show file tree
Hide file tree
Showing 2 changed files with 40 additions and 40 deletions.
24 changes: 12 additions & 12 deletions apps/doc/docs/extension/docusaurus-plugins/props.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,15 @@ hide_title: true

> Note: properties may change the default values and new properties will be added in the future.
| Property | Type | Default Value | Description |
| --- | --- | --- | --- |
| width | string | 90% | Container width |
| height | string | 500px | Container height |
| simple | boolean | false | Is it minimal mode? |
| consoleOpen | boolean | true | Display console? |
| consoleTriggerControl | boolean | false | Show console trigger button? |
| consoleDefaultVisible | boolean | false | Is console visible by default? |
| deployOpen | boolean | true | Display deploy module? |
| deployDefaultVisible | boolean | false | Is deploy module visible by default? |
| fileNavOpen | boolean | true | Display file navigation bar? |
| fileNavDefaultVisible | boolean | false | Is file navigation bar visible by default? |
| Property | Type | Default Value | Description |
|-----------------------|---------|---------------|--------------------------------------------|
| width | string | 90% | Container width |
| height | string | 500px | Container height |
| simple | boolean | false | Is it minimal mode? |
| consoleOpen | boolean | true | Display console? |
| consoleTriggerControl | boolean | false | Show console trigger button? |
| consoleDefaultVisible | boolean | false | Is console visible by default? |
| deployOpen | boolean | true | Display deploy module? |
| deployDefaultVisible | boolean | false | Is deploy module visible by default? |
| fileNavOpen | boolean | true | Display file navigation bar? |
| fileNavDefaultVisible | boolean | false | Is file navigation bar visible by default? |
56 changes: 28 additions & 28 deletions apps/doc/docs/solive-props.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,46 +8,46 @@ hide_title: true

## Property Table

| Property Name | Description | Type | Default Value | Required |
| ------------- | ----------- | ---- | ------------- | -------- |
| id | Unique form identifier | string | - | ✅ |
| modelInfos | File information | array | [] | ✅ |
| height | Height | string | - | ✅ |
| rounded | Window corner radius | string | 12px | - |
| disableValidation | Whether to disable validation | boolean | false | - |
| monacoEditorOptions | Monaco editor configuration | (Refer to [IStandaloneEditorConstructionOptions](https://microsoft.github.io/monaco-editor/typedoc/interfaces/editor.IStandaloneEditorConstructionOptions.html)) | - | - |
| fileNav | Top file navigation | TFileNav | (Refer to [TFileNav](/docs/SoLive-props#tfilenav)) | - |
| console | Log block | TConsole | (Refer to [TConsole](/docs/SoLive-props#tconsole)) | - |
| deploy | Deployment block | TDeploy | (Refer to [TDeploy](/docs/SoLive-props#tdeploy)) | - |
| Property Name | Description | Type | Default Value | Required |
|---------------------|-------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------|----------|
| id | Unique form identifier | string | - | ✅ |
| modelInfos | File information | array | [] | ✅ |
| height | Height | string | - | ✅ |
| rounded | Window corner radius | string | 12px | - |
| disableValidation | Whether to disable validation | boolean | false | - |
| monacoEditorOptions | Monaco editor configuration | (Refer to [IStandaloneEditorConstructionOptions](https://microsoft.github.io/monaco-editor/typedoc/interfaces/editor.IStandaloneEditorConstructionOptions.html)) | - | - |
| fileNav | Top file navigation | TFileNav | (Refer to [TFileNav](/docs/solive-props#tfilenav)) | - |
| console | Log block | TConsole | (Refer to [TConsole](/docs/solive-props#tconsole)) | - |
| deploy | Deployment block | TDeploy | (Refer to [TDeploy](/docs/solive-props#tdeploy)) | - |

## TFileNav

Top file navigation property table

| Property Name | Description | Type | Default Value | Required |
| ------------- | ----------- | ---- | ------------- | -------- |
| open | Whether to enable the feature | boolean | true | - |
| Property Name | Description | Type | Default Value | Required |
|---------------|-------------------------------|---------|---------------|----------|
| open | Whether to enable the feature | boolean | true | - |

## TConsole

Log block property table

| Property Name | Description | Type | Default Value | Required |
| ------------- | ----------- | ---- | ------------- | -------- |
| defaultVisible | Default visibility | boolean | true | - |
| defaultHeight | Default height | string | "30%" | - |
| minHeight | Minimum height | number | 78 | - |
| triggerControl | Whether to enable control | boolean | true | - |
| open | Whether to enable the feature | boolean | true | - |
| Property Name | Description | Type | Default Value | Required |
|----------------|-------------------------------|---------|---------------|----------|
| defaultVisible | Default visibility | boolean | true | - |
| defaultHeight | Default height | string | "30%" | - |
| minHeight | Minimum height | number | 78 | - |
| triggerControl | Whether to enable control | boolean | true | - |
| open | Whether to enable the feature | boolean | true | - |

## TDeploy

Deployment block property table

| Property Name | Description | Type | Default Value | Required |
| ------------- | ----------- | ---- | ------------- | -------- |
| defaultVisible | Default visibility | boolean | true | - |
| defaultWidth | Default width | string | "200px" | - |
| minWidth | Minimum width | number | 140 | - |
| maxWidth | Maximum width | number | 240 | - |
| open | Whether to enable the feature | boolean | true | - |
| Property Name | Description | Type | Default Value | Required |
|----------------|-------------------------------|---------|---------------|----------|
| defaultVisible | Default visibility | boolean | true | - |
| defaultWidth | Default width | string | "200px" | - |
| minWidth | Minimum width | number | 140 | - |
| maxWidth | Maximum width | number | 240 | - |
| open | Whether to enable the feature | boolean | true | - |

0 comments on commit cf6772e

Please sign in to comment.