nextcloud-notes/README.md

Notes

The Notes app is a distraction free notes taking app for Nextcloud. It provides categories for better organization and supports formatting using Markdown syntax. Notes are saved as files in your Nextcloud, so you can view and edit them with every Nextcloud client. Furthermore, a separate RESTful API allows for an easy integration into third-party apps (currently, there are notes apps for Android, iOS and the console which allow convenient access to your Nextcloud notes). Further features include marking notes as favorites.

🚀 Installation

In your Nextcloud, simply navigate to »Apps«, choose the category »Office«, find the Notes app and enable it. Then open the Notes app from the app menu.

Nextcloud will notify you about possible updates. Please have a look at CHANGELOG.md for details about changes.

❗ Bugs

Before reporting bugs:

• get the newest version of the Notes app
• please consider also installing the latest development version
• check if they have already been reported

👥 Maintainers

• Kristof Hamann
• Hendrik Leppelsack (formerly)
• Lukas Reschke (formerly)

⚠️ Developer Info

Building the app

1. Clone this into your apps folder of your Nextcloud
2. In a terminal, run the command make dev-setup to install the dependencies
3. Then to build the Javascript run make build-js or make watch-js to rebuild it when you make changes
4. Enable the app through the app management of your Nextcloud

Third-party apps

The notes app provides a JSON-API for third-party apps. You can find the documentation in the wiki.