blob: 6d016ecb5041e45edff7afc828e4655ee11c4509 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
|
# Nextcloud Text
[![Drone (self-hosted) with branch](https://img.shields.io/drone/build/nextcloud/text/master?server=https%3A%2F%2Fdrone.nextcloud.com)](https://drone.nextcloud.com/nextcloud/text)
[![Start contributing](https://img.shields.io/github/issues/nextcloud/text/good%20first%20issue?color=7057ff&label=Contribute)](https://github.com/nextcloud/text/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3A%22good+first+issue%22)
**π Collaborative document editing!**
![](img/screenshots/screenshot1.png)
## Features
- **πSimple Focused writing:** No distractions, only the formatting you need.
- **π Work together:** Share and collaborate with friends and colleagues, no matter if they use Nextcloud or not!
- **πΎ Open format:** Files are saved as [Markdown](https://en.wikipedia.org/wiki/Markdown), so you can edit them from any other text app too.
- **β Strong foundation:** We use [π tiptap](https://tiptap.scrumpy.io) which is based on [π¦ ProseMirror](https://prosemirror.net) β huge thanks to them!
Nextcloud Text is the default text editor since Nextcloud 17. To start editing just open an existing markdown or plaintext file or create a new one.
## Configuration
The rich workspaces in the file list can be disabled either by the users in the files app settings or globally by the admin with the following occ command:
```bash
occ config:app:set text workspace_available --value=0
```
## π Development setup
Currently this app requires the master branch of the [Viewer app](https://github.com/nextcloud/viewer).
1. β Clone this app into the `apps` folder of your Nextcloud: `git clone https://github.com/nextcloud/text.git`
2. π©βπ» In the folder of the app, run the command `make` to install dependencies and build the Javascript.
3. β
Enable the app through the app management of your Nextcloud
4. π Partytime! Help fix [some issues](https://github.com/nextcloud/text/issues) and [review pull requests](https://github.com/nextcloud/text/pulls) π
### π§ Advanced development stuff
To build the Javascript whenever you make changes, instead of the full `make` you can also run `npm run build`. Or run `npm run watch` to rebuild on every file save.
|