pengjunjie/build_tools
1
0
Fork 1
mirror of https://github.com/ONLYOFFICE/build_tools.git synced 2026-02-10 12:35:23 +08:00
Code Issues Packages Projects Releases Wiki Activity

Fix md

Browse Source
This commit is contained in:
Oleg Korshul
2025-07-07 22:50:04 +07:00
committed by Nikita Khromov
parent d2c79bb78d
commit 4d6b9f9463
4 changed files with 20 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@ -8,8 +8,8 @@ necessary for the compilation process, all the dependencies required for the
correct work, as well as to get the latest version of correct work, as well as to get the latest version of
**ONLYOFFICE products** source code and build all their components. **ONLYOFFICE products** source code and build all their components.
**Important!** We can only guarantee the correct work of the products built from **Important!** We can only guarantee the correct work of the products built
the `master` branch. from the `master` branch.
## How to use - Linux ## How to use - Linux

3
develop/README.md
View File

@ -7,7 +7,8 @@ but don't want to compile pretty compilcated core product to make those changes.
## System requirements ## System requirements
**Note**: ARM-based architectures are currently **NOT** supported; **Note**: ARM-based architectures are currently **NOT** supported;
attempting to run the images on ARM devices may result in startup failures or other runtime issues. attempting to run the images on ARM devices may result in startup failures
or other runtime issues.
### Windows ### Windows

32
scripts/sdkjs_common/jsdoc/README.md
View File

@ -1,7 +1,7 @@
# Documentation Generation Guide # Documentation Generation Guide
This guide explains how to generate documentation for Onlyoffice Builder and This guide explains how to generate documentation for Onlyoffice Builder
Plugins (Methods/Events) API using the following Python scripts: and Plugins (Methods/Events) API using the following Python scripts:
- `office-api/generate_docs_json.py` - `office-api/generate_docs_json.py`
- `office-api/generate_docs_md.py` - `office-api/generate_docs_md.py`
@ -38,8 +38,8 @@ This script generates JSON documentation based on the `apiBuilder.js` files.
``` ```
- **Parameters**: - **Parameters**:
- `output_path` (optional): The directory where the JSON documentation will be - `output_path` (optional): The directory where the JSON documentation
saved. If not specified, the default path is will be saved. If not specified, the default path is
`../../../../office-js-api-declarations/office-js-api`. `../../../../office-js-api-declarations/office-js-api`.
### `office-api/generate_docs_md.py` ### `office-api/generate_docs_md.py`
@ -53,8 +53,8 @@ This script generates Markdown documentation from the `apiBuilder.js` files.
``` ```
- **Parameters**: - **Parameters**:
- `output_path` (optional): The directory where the Markdown documentation will - `output_path` (optional): The directory where the Markdown documentation
be saved. If not specified, the default path is will be saved. If not specified, the default path is
`../../../../office-js-api/`. `../../../../office-js-api/`.
### `plugins/generate_docs_methods_json.py` ### `plugins/generate_docs_methods_json.py`
@ -68,8 +68,8 @@ This script generates JSON documentation based on the `api_plugins.js` files.
``` ```
- **Parameters**: - **Parameters**:
- `output_path` (optional): The directory where the JSON documentation will be - `output_path` (optional): The directory where the JSON documentation
saved. If not specified, the default path is will be saved. If not specified, the default path is
`../../../../office-js-api-declarations/office-js-api-plugins`. `../../../../office-js-api-declarations/office-js-api-plugins`.
### `plugins/generate_docs_events_json.py` ### `plugins/generate_docs_events_json.py`
@ -83,8 +83,8 @@ This script generates JSON documentation based on the `plugin-events.js` files.
``` ```
- **Parameters**: - **Parameters**:
- `output_path` (optional): The directory where the JSON documentation will be - `output_path` (optional): The directory where the JSON documentation
saved. If not specified, the default path is will be saved. If not specified, the default path is
`../../../../office-js-api-declarations/office-js-api-plugins`. `../../../../office-js-api-declarations/office-js-api-plugins`.
### `plugins/generate_docs_methods_md.py` ### `plugins/generate_docs_methods_md.py`
@ -98,8 +98,8 @@ This script generates Markdown documentation from the `api_plugins.js` files.
``` ```
- **Parameters**: - **Parameters**:
- `output_path` (optional): The directory where the Markdown documentation will - `output_path` (optional): The directory where the Markdown documentation
be saved. If not specified, the default path is will be saved. If not specified, the default path is
`../../../../office-js-api/`. `../../../../office-js-api/`.
### `plugins/generate_docs_events_md.py` ### `plugins/generate_docs_events_md.py`
@ -113,8 +113,8 @@ This script generates Markdown documentation from the `plugin-events.js` files.
``` ```
- **Parameters**: - **Parameters**:
- `output_path` (optional): The directory where the Markdown documentation will - `output_path` (optional): The directory where the Markdown documentation
be saved. If not specified, the default path is will be saved. If not specified, the default path is
`../../../../office-js-api/`. `../../../../office-js-api/`.
## Example ## Example
@ -133,6 +133,6 @@ python generate_docs_md.py /path/to/save/markdown
## Notes ## Notes
- Make sure to have all necessary permissions to run these scripts and write to - Make sure to have all necessary permissions to run these scripts and write
the specified directories. to the specified directories.
- The output directories will be created if they do not exist. - The output directories will be created if they do not exist.

0
scripts/sdkjs_common/jsdoc/Readme.txt
View File