README.md 756 Bytes
Newer Older
Matthieu Le Corre's avatar
Matthieu Le Corre committed
1
2
3
Files README.md
---

Matthieu Le Corre's avatar
Matthieu Le Corre committed
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
Show README.md & HEADER.md gitlab style on your NextCloud !

![screenshot](screenshot.png)

With this app you can add a header and a footer to your nextcloud directories.
This can be use to explain the goal of a directory, describe the contains of a folder ....
It show README.md in the way gitlab does it.


# Usage 

  * Create a README.md file (case sensitive name) and fill it with apropriate Markdown content.
  * You can do the same this the HEADER.md file.
  * It's rendered using the markdown engine. Before file list fo the HEADER.md, after file list fo the README.md
  
# Requirement
  * [MarkDown editor](https://apps.nextcloud.com/apps/files_markdown) need to be installed

# Limitation
  * Doesn't show up in public share