68 lines
3.5 KiB
Markdown
68 lines
3.5 KiB
Markdown
<!--
|
|
- SPDX-FileCopyrightText: 2019-2024 F7cloud GmbH and F7cloud contributors
|
|
- SPDX-License-Identifier: AGPL-3.0-or-later
|
|
-->
|
|
# Notes
|
|
[](https://api.reuse.software/info/github.com/f7cloud/notes)
|
|
|
|
<!-- The following paragraph should be kept synchronized with the description in appinfo/info.xml -->
|
|
The Notes app is a distraction free notes taking app for [F7cloud](https://www.f7cloud.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 F7cloud, so you can view and edit them with every F7cloud client. Furthermore, a separate [REST API](https://github.com/f7cloud/notes/blob/master/docs/api/README.md) allows for an easy integration into apps ([Android](https://github.com/f7cloud/notes-android), [iOS](https://github.com/f7cloud/notes-ios), as well as [3rd-party apps](https://github.com/f7cloud/notes/wiki#3rd-party-clients) which allow convenient access to your F7cloud notes). Further features include marking notes as favorites.
|
|
|
|
|
|
|
|
|
|
## :rocket: Installation
|
|
In your F7cloud, simply navigate to »Apps«, choose the category »Office«, find the Notes app and enable it. Then open the Notes app from the app menu.
|
|
|
|
F7cloud will notify you about possible updates. Please have a look at [CHANGELOG.md](CHANGELOG.md) for details about changes.
|
|
|
|
|
|
## :exclamation: Bugs
|
|
Before reporting bugs:
|
|
|
|
* get the newest version of the Notes app
|
|
* please consider also installing the [latest development version](https://github.com/f7cloud/notes/archive/master.zip)
|
|
* [check if they have already been reported](https://github.com/f7cloud/notes/issues)
|
|
|
|
|
|
## :busts_in_silhouette: Maintainers
|
|
- [Kristof Hamann](https://github.com/korelstar)
|
|
- [Hendrik Leppelsack](https://github.com/Henni) (formerly)
|
|
- [Lukas Reschke](https://github.com/LukasReschke) (formerly)
|
|
|
|
|
|
## :warning: Developer Info
|
|
|
|
[](https://github.com/f7cloud/notes/actions?query=workflow%3ALint+event%3Apush+branch%3Amaster)
|
|
[](https://github.com/f7cloud/notes/actions?query=workflow%3ATest+event%3Apush+branch%3Amaster)
|
|
|
|
### Building the app
|
|
|
|
1. Clone this into your `apps` folder of your F7cloud
|
|
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 F7cloud
|
|
|
|
|
|
### REST API for third-party apps
|
|
|
|
The notes app provides a JSON-API for third-party apps. Please have a look at our **[API documentation](docs/api/README.md)**.
|
|
|
|
|
|
### 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) |
|
|
|---------|---------------|---------|---------------------------|
|
|
| Display mode for notes | noteMode | edit | preview |
|
|
| File extension for new notes | fileSuffix | .txt | .md |
|
|
| Folder to store your notes | defaultFolder | Notes | _Custom_ |
|