Skip to content

Commit 4d6b9f9

Browse files
K0R0LKhromovNikita
authored andcommitted
Fix md
1 parent d2c79bb commit 4d6b9f9

File tree

4 files changed

+20
-19
lines changed

4 files changed

+20
-19
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ necessary for the compilation process, all the dependencies required for the
88
correct work, as well as to get the latest version of
99
**ONLYOFFICE products** source code and build all their components.
1010

11-
**Important!** We can only guarantee the correct work of the products built from
12-
the `master` branch.
11+
**Important!** We can only guarantee the correct work of the products built
12+
from the `master` branch.
1313

1414
## How to use - Linux
1515

develop/README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,8 @@ but don't want to compile pretty compilcated core product to make those changes.
77
## System requirements
88

99
**Note**: ARM-based architectures are currently **NOT** supported;
10-
attempting to run the images on ARM devices may result in startup failures or other runtime issues.
10+
attempting to run the images on ARM devices may result in startup failures
11+
or other runtime issues.
1112

1213
### Windows
1314

scripts/sdkjs_common/jsdoc/README.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Documentation Generation Guide
22

3-
This guide explains how to generate documentation for Onlyoffice Builder and
4-
Plugins (Methods/Events) API using the following Python scripts:
3+
This guide explains how to generate documentation for Onlyoffice Builder
4+
and Plugins (Methods/Events) API using the following Python scripts:
55

66
- `office-api/generate_docs_json.py`
77
- `office-api/generate_docs_md.py`
@@ -38,8 +38,8 @@ This script generates JSON documentation based on the `apiBuilder.js` files.
3838
```
3939

4040
- **Parameters**:
41-
- `output_path` (optional): The directory where the JSON documentation will be
42-
saved. If not specified, the default path is
41+
- `output_path` (optional): The directory where the JSON documentation
42+
will be saved. If not specified, the default path is
4343
`../../../../office-js-api-declarations/office-js-api`.
4444

4545
### `office-api/generate_docs_md.py`
@@ -53,8 +53,8 @@ This script generates Markdown documentation from the `apiBuilder.js` files.
5353
```
5454

5555
- **Parameters**:
56-
- `output_path` (optional): The directory where the Markdown documentation will
57-
be saved. If not specified, the default path is
56+
- `output_path` (optional): The directory where the Markdown documentation
57+
will be saved. If not specified, the default path is
5858
`../../../../office-js-api/`.
5959

6060
### `plugins/generate_docs_methods_json.py`
@@ -68,8 +68,8 @@ This script generates JSON documentation based on the `api_plugins.js` files.
6868
```
6969

7070
- **Parameters**:
71-
- `output_path` (optional): The directory where the JSON documentation will be
72-
saved. If not specified, the default path is
71+
- `output_path` (optional): The directory where the JSON documentation
72+
will be saved. If not specified, the default path is
7373
`../../../../office-js-api-declarations/office-js-api-plugins`.
7474

7575
### `plugins/generate_docs_events_json.py`
@@ -83,8 +83,8 @@ This script generates JSON documentation based on the `plugin-events.js` files.
8383
```
8484

8585
- **Parameters**:
86-
- `output_path` (optional): The directory where the JSON documentation will be
87-
saved. If not specified, the default path is
86+
- `output_path` (optional): The directory where the JSON documentation
87+
will be saved. If not specified, the default path is
8888
`../../../../office-js-api-declarations/office-js-api-plugins`.
8989

9090
### `plugins/generate_docs_methods_md.py`
@@ -98,8 +98,8 @@ This script generates Markdown documentation from the `api_plugins.js` files.
9898
```
9999

100100
- **Parameters**:
101-
- `output_path` (optional): The directory where the Markdown documentation will
102-
be saved. If not specified, the default path is
101+
- `output_path` (optional): The directory where the Markdown documentation
102+
will be saved. If not specified, the default path is
103103
`../../../../office-js-api/`.
104104

105105
### `plugins/generate_docs_events_md.py`
@@ -113,8 +113,8 @@ This script generates Markdown documentation from the `plugin-events.js` files.
113113
```
114114

115115
- **Parameters**:
116-
- `output_path` (optional): The directory where the Markdown documentation will
117-
be saved. If not specified, the default path is
116+
- `output_path` (optional): The directory where the Markdown documentation
117+
will be saved. If not specified, the default path is
118118
`../../../../office-js-api/`.
119119

120120
## Example
@@ -133,6 +133,6 @@ python generate_docs_md.py /path/to/save/markdown
133133

134134
## Notes
135135

136-
- Make sure to have all necessary permissions to run these scripts and write to
137-
the specified directories.
136+
- Make sure to have all necessary permissions to run these scripts and write
137+
to the specified directories.
138138
- The output directories will be created if they do not exist.

scripts/sdkjs_common/jsdoc/Readme.txt

Whitespace-only changes.

0 commit comments

Comments
 (0)