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

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

Extends the text editor in Nextcloud with a live preview for markdown files

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

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 requires Nextcloud and the Text Editor app to be installed from Nextcloud 10 or higher.

Installation
---

- You can get the app 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, you'll need to build the project by running `make` in the app directory.


Usage
---

To use the markdown editor, simply open a file with a `.md` or `.markdown` extention.

Development
---

This app is written in typescript and requires nodejs and npm to build.

To build the project run `make` from the app directory.

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