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

Update README.md

Browse Source 
fix Requirements and Installation
This commit is contained in:
Alexander Trofimov
2024-08-30 08:31:45 +03:00
committed by GitHub
parent c29ac1549f
commit 1ad87383e3
1 changed files with 12 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@ -3,14 +3,20 @@
This guide explains how to generate documentation for Onlyoffice Builder/Plugins API using the provided Python scripts: `generate_docs_json.py`, `generate_docs_plugins_json.py`, `generate_docs_md.py`. These scripts are used to create JSON and Markdown documentation for the `apiBuilder.js` files from the word, cell, and slide editors.
## Prerequisites
## Requirements
1. **Node.js and npm**: Ensure you have Node.js and npm installed on your machine. You can download them from [Node.js official website](https://nodejs.org/).
```bash
Node.js v20 and above
Python v3.10 and above
```
2. **jsdoc**: The scripts use `jsdoc` to generate documentation. Install it using npm:
```bash
npm install
```
## Installation
```bash
git clone https://github.com/ONLYOFFICE/build_tools.git
cd build_tools/scripts/sdkjs_common/jsdoc
npm install
```
## Scripts Overview