Skip to content

Commit 9c64b4d

Browse files
committed
format readme
1 parent 9d77409 commit 9c64b4d

File tree

1 file changed

+21
-10
lines changed

1 file changed

+21
-10
lines changed

README.md

Lines changed: 21 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# ONLYOFFICE plugin for Discourse
22

3-
Welcome to the official repository for the **ONLYOFFICE plugin for Discourse**! It brings the power of [ONLYOFFICE Docs](https://www.onlyoffice.com/docs) right to your [Discourse](https://www.discourse.org/) enabling work with office files in topics and replies.
3+
Welcome to the official repository for the **ONLYOFFICE plugin for Discourse**!
4+
It brings the power of [ONLYOFFICE Docs](https://www.onlyoffice.com/docs) right to your [Discourse](https://www.discourse.org/) enabling work with office files in topics and replies.
45

56
## Features ✨
67

@@ -26,44 +27,54 @@ You have two main choices for the ONLYOFFICE Document Server:
2627
* **Community Edition (Free)**: Ideal for small teams and personal use.
2728
* The **recommended** installation method is [Docker](https://github.com/onlyoffice/Docker-DocumentServer).
2829
* To install it on Debian, Ubuntu, or other derivatives, click [here](https://helpcenter.onlyoffice.com/docs/installation/docs-community-install-ubuntu.aspx).
29-
* **Enterprise Edition**: Provides scalability for larger organizations. To install, click [here](https://helpcenter.onlyoffice.com/docs/installation/enterprise).
30+
* **Enterprise Edition**: Provides scalability for larger organizations.
31+
To install, click [here](https://helpcenter.onlyoffice.com/docs/installation/enterprise).
3032

3133
Community Edition vs Enterprise Edition comparison can be found [here](#onlyoffice-docs-editions).
3234

3335
## Plugin configuration ⚙️
3436

35-
Navigate to the **Admin** section in the left panel. On the page that opens, locate the **Plugins** section in the left panel and click on **Installed plugins**. From the list, find **ONLYOFFICE Discourse** and click **Settings**.
37+
Navigate to the **Admin** section in the left panel.
38+
On the page that opens, locate the **Plugins** section in the left panel and click on **Installed plugins**.
39+
From the list, find **ONLYOFFICE Discourse** and click **Settings**.
3640

3741
Enter the following details:
3842

3943
- **ONLYOFFICE Docs address**: The URL of your Docs instance (cloud or on-premises).
40-
- **ONLYOFFICE Docs secret key**: Enables secure token-based access to documents. [Learn more](https://api.onlyoffice.com/docs/docs-api/additional-api/signature/)
44+
- **ONLYOFFICE Docs secret key**: Enables secure token-based access to documents.
45+
[Learn more](https://api.onlyoffice.com/docs/docs-api/additional-api/signature/)
4146
- **JWT Header**: If you have custom header naming in your Docs setup, enter it here.
4247

43-
To ensure the ONLYOFFICE plugin functions properly, enable the **Auto authorize extensions** setting. By default, Discourse limits the list of allowed attachment formats. Enabling this setting automatically expands the list of authorized extensions in Discourse, allowing users to attach and open files in the editor via the ONLYOFFICE plugin.
48+
To ensure the ONLYOFFICE plugin functions properly, enable the **Auto authorize extensions** setting.
49+
By default, Discourse limits the list of allowed attachment formats.
50+
Enabling this setting automatically expands the list of authorized extensions in Discourse, allowing users to attach and open files in the editor via the ONLYOFFICE plugin.
4451

45-
## Plugin usage
52+
## Plugin usage
4653

4754
### Creating and editing files ✍️
4855

4956
When adding a topic or comment, you can create a file (DOCX, XLSX, PPTX, or PDF) by clicking the ONLYOFFICE icon and selecting the desired format.
5057

51-
The created file is automatically attached to the topic or reply. Once published, the file appears in the post, and clicking its name opens a pop-up with the following actions:
58+
The created file is automatically attached to the topic or reply.
59+
Once published, the file appears in the post, and clicking its name opens a pop-up with the following actions:
5260

53-
- **Edit with ONLYOFFICE:** Open the file in ONLYOFFICE editors for seamless editing. The file creator is granted editing rights by default.
61+
- **Edit with ONLYOFFICE:** Open the file in ONLYOFFICE editors for seamless editing.
62+
The file creator is granted editing rights by default.
5463
- **Download:** Save the file directly to your device.
5564
- **Manage Permissions:** Adjust access rights for the file.
5665
- **Convert:** Convert the file into a different format of your choice.
5766

5867
### File conversion 🔄
5968

60-
Save your file in the format of your choice. Simply click the **Convert** button, select the desired format from the list, and the file will be downloaded directly to your device.
69+
Save your file in the format of your choice.
70+
Simply click the **Convert** button, select the desired format from the list, and the file will be downloaded directly to your device.
6171

6272
### Managing file access permissions 🔐
6373

6474
By default, only the file owner (the post author) has editing rights, while other users can view the file.
6575

66-
To grant editing permissions to another user, click **Manage Permissions**, enter the username in the search bar, and click **Add Permissions**. Users with granted access will appear in the **Current Permissions** section within the same window.
76+
To grant editing permissions to another user, click **Manage Permissions**, enter the username in the search bar, and click **Add Permissions**.
77+
Users with granted access will appear in the **Current Permissions** section within the same window.
6778

6879
## ONLYOFFICE Docs editions
6980

0 commit comments

Comments
 (0)