README.md


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
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83

Nextcloud Markdown Editor
=================

Extends Nextcloud text editing with a live preview for markdown files

![Markdown Editor](screenshots/editor.png)

Usage
---

Starting with Nextcloud 17, the **[Text](github.com/nextcloud/text/)** app replaced the **[Plain text editor](https://apps.nextcloud.com/apps/files_texteditor)** app. In order to use ***Markdown Editor***, you must install and enable both it and **[Plain text editor](https://apps.nextcloud.com/apps/files_texteditor)**.

To use ***Markdown Editor***, simply open any file with an `.md` or `.markdown` extension.

Behaviors
---

![dots](https://user-images.githubusercontent.com/37463152/109408156-52e2c200-794c-11eb-93e4-e99ff97f8ae9.png)


### SCENARIO ONE

_WITH **MARKDOWN EDITOR**, **PLAIN TEXT EDITOR**, AND **TEXT** APPS ALL ENABLED:_

The **[Text](github.com/nextcloud/text/)** app will still, by default, open `.txt`, `.md`, and `.markdown` files. However, you can override that behavior by clicking the three-dot dropdown menu for any `.txt`, `.md`, or `.markdown` file and choosing “Edit in plain text editor.” Using this method, ***Markdown Editor*** will open `.md`, and `.markdown` files while ***Plain text editor*** will open `.txt` files.

### SCENARIO TWO

_WITH **MARKDOWN EDITOR** AND **PLAIN TEXT EDITOR** ENABLED, BUT **TEXT** DISABLED:_

***Markdown Editor*** will open `.md`, and `.markdown` files while ***Plain text editor*** will open `.txt` files. It’s unnecessary to use the three-dot dropdown menu to invoke either.

>_Be aware: Disabling the **Text** app will also disable (but not delete) any **Rich Workspace** notes you may have created. These are the styled notes that appear above and before file lists. Re-enabling **Text** makes them visible again._


Features
---

### Embed images and videos stored on your Nextcloud

![Embed Images](screenshots/embed.png)

![Embed Videos](screenshots/videos.png)

### Use LaTeX to add math to your documents

![LaTeX math](screenshots/math.png)

### Keep track of tasks with checkbox lists

![Checkbox lists](screenshots/checkboxes.png)

### Syntax highlighting for your code

![Syntax highlighting](screenshots/syntax.png)

### Create graph using [mermaid.js](https://github.com/knsv/mermaid)

![Mermaid.js graphs](screenshots/graph.png)

### Fully rendered previews in the sidebar
 
![Sidebar previews](screenshots/preview.png)

Requirements
---

This app requires the [Plain text editor](https://apps.nextcloud.com/apps/files_texteditor) app to be installed on Nextcloud 10 or higher.

Installation
---

- Get ***Markdown Editor*** from the [Nextcloud app store](https://apps.nextcloud.com/apps/files_markdown)
or download the latest release from [github](https://github.com/icewind1991/files_markdown/releases).

- If you’re installing from git, build the project by running `make` in Nextcloud’s app directory.

Development
---

***Markdown Editor*** is written in [typescript](https://www.typescriptlang.org/). It requires [nodejs](https://nodejs.org/en/) and [npm](https://www.npmjs.com/) to build.

For development you can automatically build the project every time the source changes by running `make watch`.