Skip to content

Commit 130fdd1

Browse files
committed
Merge branch 'next' of https://github.com/DHTMLX/docs-richtext into next
2 parents 95c40a7 + b3272aa commit 130fdd1

File tree

466 files changed

+31367
-670
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

466 files changed

+31367
-670
lines changed

.github/workflows/main.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ name: Deploy To Site
66
on:
77
# Triggers the workflow on push or pull request events but only for the master branch
88
push:
9-
branches: [master]
9+
branches: [master, next, text]
1010

1111
# A workflow run is made up of one or more jobs that can run sequentially or in parallel
1212
jobs:

.gitignore

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,3 +20,7 @@ yarn-debug.log*
2020
yarn-error.log*
2121

2222
\.idea/
23+
gptit.toml
24+
.yarnrc.yml
25+
prompts
26+
.yarn/install-state.gz

docs/api/config/default-styles.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,20 @@
11
---
22
sidebar_label: defaultStyles
33
title: defaultStyles Config
4-
description: You can learn about the defaultStyles config in the documentation of the DHTMLX JavaScript RichText library. Browse developer guides and API reference, try out code examples and live demos, and download a free 30-day evaluation version of DHTMLX RichText.
4+
description: Explore the defaultStyles configuration in the DHTMLX JavaScript RichText library documentation. Find developer guides, API references, try code samples and live demos, and download a free 30-day trial of DHTMLX RichText.
55
---
66

77
# defaultStyles
88

99
### Description
1010

11-
@short: Optional. Specifies default style values for specific block types
11+
@short: Optional. Defines default style settings for specific block types.
1212

1313
### Usage
1414

1515
~~~jsx {}
1616
defaultStyles?: {
17-
"*"?: { // affects all blocks, allowing you to set common properties for all of these blocks
17+
"*"?: { // applies to all blocks, letting you set common properties for all of them
1818
"font-family"?: string; // "Roboto"| "Arial" | "Georgia" | "Tahoma" | "Times New Roman" | "Verdana"
1919
"font-size"?: string; // "12px" | "14px" | "16px" | "18px" | "20px" | "24px" | "28px" | "32px" | "36px"
2020
color?: string;
@@ -72,7 +72,7 @@ defaultStyles?: {
7272
~~~
7373

7474
:::important
75-
The `defaultStyles` property DOES NOT set the actual CSS to the affected blocks. CSS styles have to be applied separately:
75+
The `defaultStyles` property doesn't actually apply CSS styles to the blocks. To see the styles take effect, you need to add the corresponding CSS separately:
7676

7777
```jsx title="index.js"
7878
new richtext.Richtext("#root", {
@@ -98,7 +98,7 @@ new richtext.Richtext("#root", {
9898
</style>
9999
```
100100

101-
In this example, all `h2` blocks are assigned to the `"Roboto"` font-family with a font-size of 28px with both the foreground and the background colors changed as well. Css styles assigned to `h2` blocks as well.
101+
In this example, every `h2` block is set to use the `"Roboto"` font-family with a font size of 28px, along with changes to the text and background colors. The CSS styles for `h2` blocks are also applied accordingly.
102102
:::
103103

104104
### Default config
@@ -137,7 +137,7 @@ new richtext.Richtext("#root", {
137137
});
138138
~~~
139139

140-
**Change log:** The property was updated in v2.0
140+
**Change log:** This property was updated in version 2.0
141141

142142
**Related articles:** [Configuration](guides/configuration.md)
143143

docs/api/config/fullscreen-mode.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
---
22
sidebar_label: fullscreenMode
33
title: fullscreenMode Config
4-
description: You can learn about the fullscreenMode config in the documentation of the DHTMLX JavaScript RichText library. Browse developer guides and API reference, try out code examples and live demos, and download a free 30-day evaluation version of DHTMLX RichText.
4+
description: Explore the fullscreenMode config in the DHTMLX JavaScript RichText library documentation. Check out developer guides, API references, try code examples and live demos, and download a free 30-day trial of DHTMLX RichText.
55
---
66

77
# fullscreenMode
88

99
### Description
1010

11-
@short: Optional. Enables the RichText fullscreen mode
11+
@short: Optional. Turns on the RichText fullscreen mode
1212

1313
### Usage
1414

@@ -32,7 +32,7 @@ new richtext.Richtext("#root", {
3232
});
3333
~~~
3434

35-
**Change log:** The property was added in v2.0
35+
**Change log:** This property was introduced in v2.0
3636

3737
**Related articles:** [Configuration](guides/configuration.md)
3838

docs/api/config/image-upload-url.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ description: You can learn about the imageUploadUrl config in the documentation
88

99
### Description
1010

11-
@short: Optional. Specifies the URL which will be used for image upload
11+
@short: Optional. Defines the URL that will be used to upload images
1212

1313
### Usage
1414

@@ -26,7 +26,7 @@ new richtext.Richtext("#root", {
2626
});
2727
~~~
2828

29-
**Change log:** The property was added in v2.0
29+
**Change log:** This property was introduced in version 2.0
3030

3131
**Related articles:** [Configuration](guides/configuration.md)
3232

docs/api/config/layout-mode.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,22 @@
11
---
22
sidebar_label: layoutMode
33
title: layoutMode Config
4-
description: You can learn about the layoutMode config in the documentation of the DHTMLX JavaScript RichText library. Browse developer guides and API reference, try out code examples and live demos, and download a free 30-day evaluation version of DHTMLX RichText.
4+
description: Explore the layoutMode configuration in the DHTMLX JavaScript RichText library documentation. Check out developer guides, API references, code samples, live demos, and download a free 30-day trial of DHTMLX RichText.
55
---
66

77
# layoutMode
88

99
### Description
1010

11-
@short: Optional. Specifies the layout mode for the main editor area
11+
@short: Optional. Defines the layout style for the main editor area.
1212

1313
### Usage
1414

1515
~~~jsx {}
1616
layoutMode: "classic" | "document";
1717
~~~
1818

19-
The `"classic"` mode represents the edit area that fits the entire page. The `"document"` mode closely represent the real document sizes (sizes used: A4, A5, A6, A7).
19+
The `"classic"` mode makes the editing area span the entire page. The `"document"` mode simulates actual document sizes, using formats like A4, A5, A6, and A7.
2020

2121
### Default config
2222

@@ -29,12 +29,12 @@ layoutMode: "classic";
2929
~~~jsx {3}
3030
// initialize RichText
3131
new richtext.Richtext("#root", {
32-
layoutMode: "document" // initializes RichText with "document" mode by default
32+
layoutMode: "document" // sets RichText to use "document" mode by default
3333
// other configuration properties
3434
});
3535
~~~
3636

37-
**Change log:** The property was added in v2.0 instead of the removed `mode` property
37+
**Change log:** This property was introduced in v2.0, replacing the older `mode` property.
3838

3939
**Related articles:** [Configuration](guides/configuration.md)
4040

docs/api/config/locale.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
11
---
22
sidebar_label: locale
33
title: locale Config
4-
description: You can learn about the locale config in the documentation of the DHTMLX JavaScript RichText library. Browse developer guides and API reference, try out code examples and live demos, and download a free 30-day evaluation version of DHTMLX RichText.
4+
description: Explore the locale config in the DHTMLX JavaScript RichText library documentation. Check out developer guides, API references, try code samples and live demos, and download a free 30-day trial of DHTMLX RichText.
55
---
66

77
# locale
88

99
### Description
1010

11-
@short: Optional. An object that includes localization labels of RichText
11+
@short: Optional. An object containing localization labels for RichText
1212

1313
:::info
14-
The **locale** object needs to include all labels of RichText with the corresponding translations.
14+
The **locale** object should have all the RichText labels along with their respective translations.
1515
:::
1616

1717
### Usage
@@ -22,25 +22,25 @@ locale?: object;
2222

2323
### Default config
2424

25-
By default, RichText uses the **English** locale. You can set it to the custom locale as well.
25+
By default, RichText comes with the **English** locale. You also have the option to set a custom locale.
2626

2727
:::tip
28-
To change the current locale dynamically, you can use the [**setLocale()**](api/methods/set-locale.md) method of RichText
28+
To switch the locale on the fly, use the [**setLocale()**](api/methods/set-locale.md) method of RichText
2929
:::
3030

3131
### Example
3232

3333
~~~jsx {3}
3434
// initialize RichText
3535
const editor = new richtext.RichText("#root", {
36-
locale: richtext.locales.cn // the Chineese locale will be set initially
37-
// locale: richtext.locales.en // the English locale will be set initially
38-
// locale: richtext.locales.de // the Germany locale will be set initially
36+
locale: richtext.locales.cn // the Chinese locale is set initially
37+
// locale: richtext.locales.en // the English locale is set initially
38+
// locale: richtext.locales.de // the German locale is set initially
3939
// other configuration properties
4040
});
4141
~~~
4242

43-
**Change log:** The property was added in v2.0
43+
**Change log:** This property was introduced in v2.0
4444

4545
**Related articles:** [Localization](guides/localization.md)
4646

docs/api/config/menubar.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ description: You can learn about the menubar config in the documentation of the
88

99
### Description
1010

11-
@short: Optional. Enables the top menubar of RichText
11+
@short: Optional. Turns on the top menubar in RichText.
1212

1313
### Usage
1414

@@ -26,7 +26,7 @@ new richtext.Richtext("#root", {
2626
});
2727
~~~
2828

29-
**Change log:** The property was added in v2.0
29+
**Change log:** This property was introduced in v2.0
3030

3131
**Related articles:** [Configuration](guides/configuration.md)
3232

0 commit comments

Comments
 (0)