2013-08-17 11:55:18 +02:00
# Notes
2017-01-06 14:44:27 +01:00
<!-- The following paragraph should be kept synchronized with the description in appinfo/info.xml -->
2023-02-28 19:44:47 +01:00
The Notes app is a distraction free notes taking app for [Nextcloud ](https://www.nextcloud.com/ ). It provides categories for better organization and supports formatting using [Markdown ](https://en.wikipedia.org/wiki/Markdown ) syntax. Notes are saved as files in your Nextcloud, so you can view and edit them with every Nextcloud client. Furthermore, a separate [REST API ](https://github.com/nextcloud/notes/blob/master/docs/api/README.md ) allows for an easy integration into apps ([Android](https://github.com/nextcloud/notes-android), [iOS ](https://github.com/nextcloud/notes-ios ), and 3rd-party apps like the [console ](https://git.danielmoch.com/nncli/about ) and [many more ](https://github.com/nextcloud/notes/wiki#3rd-party-clients ) which allow convenient access to your Nextcloud notes). Further features include marking notes as favorites.
2014-04-12 01:19:33 +02:00
2018-08-02 21:40:16 +02:00
![Screenshot of Nextcloud Notes ](https://raw.githubusercontent.com/nextcloud/screenshots/master/apps/Notes/notes.png )
2016-08-17 11:24:49 +02:00
2014-04-12 01:19:33 +02:00
2018-11-17 15:55:21 +01:00
## :rocket: 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.
2014-04-12 01:19:33 +02:00
2019-06-08 07:56:52 +02:00
Nextcloud will notify you about possible updates. Please have a look at [CHANGELOG.md ](CHANGELOG.md ) for details about changes.
2019-04-17 16:32:28 +02:00
2016-01-30 15:45:40 +01:00
2016-12-30 09:28:53 +01:00
## :exclamation: Bugs
2014-04-12 01:19:33 +02:00
Before reporting bugs:
* get the newest version of the Notes app
2018-11-17 15:55:21 +01:00
* please consider also installing the [latest development version ](https://github.com/nextcloud/notes/archive/master.zip )
* [check if they have already been reported ](https://github.com/nextcloud/notes/issues )
## :busts_in_silhouette: Maintainers
- [Kristof Hamann ](https://github.com/korelstar )
2020-02-19 21:35:19 +01:00
- [Hendrik Leppelsack ](https://github.com/Henni ) (formerly)
- [Lukas Reschke ](https://github.com/LukasReschke ) (formerly)
2014-04-12 01:19:33 +02:00
2019-05-22 21:40:03 +02:00
## :warning: Developer Info
2018-11-17 15:55:21 +01:00
2020-02-06 22:17:24 +01:00
[![Lint ](https://github.com/nextcloud/notes/workflows/Lint/badge.svg?branch=master&event=push )](https://github.com/nextcloud/notes/actions?query=workflow%3ALint+event%3Apush+branch%3Amaster)
2020-05-05 21:51:28 +02:00
[![Test ](https://github.com/nextcloud/notes/workflows/Test/badge.svg?branch=master&event=push )](https://github.com/nextcloud/notes/actions?query=workflow%3ATest+event%3Apush+branch%3Amaster)
2018-11-17 15:55:21 +01:00
2020-05-05 21:51:28 +02:00
### Building the app
2018-11-17 15:55:21 +01:00
2019-05-22 21:40:03 +02:00
1. Clone this into your `apps` folder of your Nextcloud
2. In a terminal, run the command `make dev-setup` to install the dependencies
2019-12-27 22:20:31 +01:00
3. Then to build the Javascript run `make build-js` or `make watch-js` to
rebuild it when you make changes
2019-05-22 21:40:03 +02:00
4. Enable the app through the app management of your Nextcloud
2018-11-17 15:55:21 +01:00
2020-05-05 21:51:28 +02:00
### REST API for third-party apps
2017-02-05 10:32:52 +01:00
2020-05-05 21:51:28 +02:00
The notes app provides a JSON-API for third-party apps. Please have a look at our ** [API documentation ](docs/api/README.md )**.
2023-01-31 12:41:25 +01:00
### Admin configuration
It is possible to specify different defaults for the notes settings of new users using `occ` commands like these:
```
occ config:app:set notes noteMode --value="preview"
occ config:app:set notes fileSuffix --value=".md"
occ config:app:set notes defaultFolder --value="Shared notes"
```
| Setting | Property name | Default | Other available option(s) |
|---------|---------------|---------|---------------------------|
2023-02-04 14:39:55 +01:00
| Display mode for notes | noteMode | edit | preview |
2023-01-31 12:41:25 +01:00
| File extension for new notes | fileSuffix | .txt | .md |
| Folder to store your notes | defaultFolder | Notes | _Custom_ |