Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
fix Requirements and Installation
  • Loading branch information
trofim24 authored Aug 30, 2024
1 parent c29ac15 commit 1ad8738
Showing 1 changed file with 12 additions and 6 deletions.
18 changes: 12 additions & 6 deletions scripts/sdkjs_common/jsdoc/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
```

## Installation

2. **jsdoc**: The scripts use `jsdoc` to generate documentation. Install it using npm:
```bash
npm install
```
```bash
git clone https://github.com/ONLYOFFICE/build_tools.git
cd build_tools/scripts/sdkjs_common/jsdoc
npm install
```

## Scripts Overview

Expand Down

0 comments on commit 1ad8738

Please sign in to comment.