From eb052be06b02e33d9a0a2fc4646898414104c755 Mon Sep 17 00:00:00 2001 From: Kseniya Fedoruk Date: Fri, 23 Jan 2026 12:17:56 +0300 Subject: [PATCH] Update Readme.md --- Readme.md | 65 ++++++++++++++++++++++++++++++++++++++++--------------- 1 file changed, 48 insertions(+), 17 deletions(-) diff --git a/Readme.md b/Readme.md index 0d582614bd..c1acbe36da 100644 --- a/Readme.md +++ b/Readme.md @@ -1,28 +1,59 @@ +[![License](https://img.shields.io/badge/License-GNU%20AGPL%20V3-green.svg?style=flat)](https://www.gnu.org/licenses/agpl-3.0.en.html) -[![License](https://img.shields.io/badge/License-GNU%20AGPL%20V3-green.svg?style=flat)](https://www.gnu.org/licenses/agpl-3.0.en.html) +# 🧩 ONLYOFFICE JavaScript SDK (SDKJS) -## Sdkjs +SDKJS is the official JavaScript Software Development Kit (SDK) for ONLYOFFICE’s document editing components. -JavaScript SDK which is a part of [ONLYOFFICE Document Server][2] and [ONLYOFFICE Desktop Editors][4]. Contains API for all the included components client-side interaction and implementation of [Office JavaScript APIs][5]. +It is integrated into: -## Project Information +- [ONLYOFFICE Docs (Document Server)][2] +- [ONLYOFFICE Desktop Editors][4] -Official website: [http://www.onlyoffice.com](http://onlyoffice.com "http://www.onlyoffice.com") +JavaScript SDK provides the necessary **client-side APIs** for integrating and customizing the ONLYOFFICE editors. It also includes an **implementation layer** for the [Office JavaScript APIs][5], enabling advanced document manipulation and integration operations. -Code repository: [https://github.com/ONLYOFFICE/sdkjs](https://github.com/ONLYOFFICE/sdkjs "https://github.com/ONLYOFFICE/sdkjs") +## 🌐 Project Resources -SaaS version: [https://www.onlyoffice.com/cloud-office.aspx](https://www.onlyoffice.com/cloud-office.aspx "https://www.onlyoffice.com/cloud-office.aspx") +- **Official website:** [ONLYOFFICE Homepage](https://www.onlyoffice.com?utm_source=github&utm_medium=cpc&utm_campaign=GitHubSdkjs) +- **Source repository:** [SDKJS on GitHub](https://github.com/ONLYOFFICE/sdkjs) +- **ONLYOFFICE Docs:** [Suite overview](https://www.onlyoffice.com/docs?utm_source=github&utm_medium=cpc&utm_campaign=GitHubSdkjs) -## User Feedback and Support +📖 **Developer documentation:** [ONLYOFFICE API Documentation](https://api.onlyoffice.com?utm_source=github&utm_medium=cpc&utm_campaign=GitHubSdkjs) — The essential +reference guide for working with ONLYOFFICE APIs and integration modules. -If you have any problems with or questions about [ONLYOFFICE Document Server][2], please visit our official forum to find answers to your questions: [forum.onlyoffice.com][1] or you can ask and answer ONLYOFFICE development questions on [Stack Overflow][3]. +## 📁 Repository Structure Overview - [1]: https://forum.onlyoffice.com - [2]: https://github.com/ONLYOFFICE/DocumentServer - [3]: http://stackoverflow.com/questions/tagged/onlyoffice - [4]: https://github.com/ONLYOFFICE/DesktopEditors - [5]: https://github.com/ONLYOFFICE/office-js-api - -## License +The directory layout below helps developers quickly navigate and understand SDKJS directory purposes. -Sdkjs is released under an GNU AGPL v3.0 license. See the LICENSE file for more information. +| Folder | Description | +| :-------- | :------------------------------------------------------------------------- | +| `.github` | Contains GitHub workflows and issue/pr templates for CI/CD automation. | +| `build` | Scripts and configuration files used to build SDKJS bundles. | +| `cell` | Core functionality and UI logic for spreadsheet editor. | +| `common` | Shared modules, utilities, and core logic used across all editor types. | +| `configs` | Configuration files and constants used for environment and runtime setup. | +| `pdf` | Modules and UI components for viewing and annotating PDF files. | +| `slide` | Logic and rendering components for presentation editor. | +| `tests` | Automated test suites and configs for validating SDKJS behavior. | +| `tools` | Helper utilities, build scripts, and developer tools. | +| `vendor` | Third-party libraries and external dependencies used by SDKJS. | +| `visio` | Modules related to drawing and diagram editing (Visio-like functionality). | +| `word` | Core logic and UI components for text document editor. | + +## 💬 User Feedback and Support + +We welcome community participation, technical insights, and feedback. For questions, integration issues, or troubleshooting related to [ONLYOFFICE Document Server][2], please explore these resources: + +- **Report issues:** [GitHub Issues](https://github.com/ONLYOFFICE/DocumentServer/issues) +- **Forum:** [ONLYOFFICE Community][1] +- **Feedback platform:** [feedback.onlyoffice.com](https://feedback.onlyoffice.com/forums/966080-your-voice-matters) +- **Developer Q&A:** [Stack Overflow][3] + +[1]: https://community.onlyoffice.com/ +[2]: https://github.com/ONLYOFFICE/DocumentServer +[3]: https://stackoverflow.com/questions/tagged/onlyoffice +[4]: https://github.com/ONLYOFFICE/DesktopEditors +[5]: https://github.com/ONLYOFFICE/office-js-api + +## 📜 License + +**SDKJS** is licensed under the **GNU Affero General Public License (AGPL) v3.0**. For full details, refer to the [LICENSE](https://github.com/ONLYOFFICE/sdkjs/blob/master/LICENSE.txt) file. \ No newline at end of file