MarkDown-renderer (Nextcloud app)

Render a folder README (README.md, Readme.md, readme.md, etc.) directly at the top of the Nextcloud Files view — similar to GitLab.

Screenshot

Features

• Renders Markdown inside the Files list header
• Supports common README filename variants (case-insensitive)
• Read-only task list checkboxes
• Auto-refresh on save, rename, or delete (Nextcloud event bus)
• Lightweight bundle using highlight.js core and selected languages
• UI styling aligned with Nextcloud design

---

Compatibility

• Supported range: Nextcloud 26-34
• Verified on Nextcloud 26
• Verified during development on Nextcloud 34
• Nextcloud 27-32 are expected to work because they use the same @nextcloud/files 3.x generation, but were not individually verified
• Uses the Files app header API with a legacy registration fallback for the older header registration path

---

Installation (custom_apps)

Clone into your Nextcloud custom_apps directory:

git clone https://github.com/Konstiu/MarkDown-renderer.git markdownreadme

Enable the app in Nextcloud (Settings → Apps), then build assets:

npm ci
npm run build

---

Development

npm run watch

---

Nextcloud 34+ Note

Starting with Nextcloud 34, the text app (v8.0.0) includes built-in README rendering. Both apps can display a README at the same time. Running both markdownreadme and text may show two README panels side by side.

To avoid this, disable one of them:

• Use markdownreadme if you want a lightweight inline viewer in the file list header (read-only, non-editable)
• Rely on text if you want a full viewer + editor for READMEs in Nextcloud's native UI

---

License

This project is licensed under the AGPL-3.0 License.

---