Skip to content

Commit

Permalink
Add more documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
pbek committed Mar 11, 2020
1 parent db00c0f commit dbfff6a
Show file tree
Hide file tree
Showing 5 changed files with 50 additions and 1 deletion.
2 changes: 1 addition & 1 deletion docs/README.md
Expand Up @@ -14,7 +14,7 @@ Then you can open <http://0.0.0.0:8000> to see the documentation with live-reloa

## Quick links

- [MkDocs Material Components - Cheat Sheet](https://yakworks.github.io/mkdocs-material-components/cheat-sheet/)
- [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/getting-started/)

## Tooling

Expand Down
Binary file added docs/content/assets/img/qownnotesapi.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
5 changes: 5 additions & 0 deletions docs/content/getting-started/concept.md
Expand Up @@ -34,6 +34,11 @@
- Of course other software, like **Dropbox**, **Syncthing**, **Seafile** or BitTorrent Sync can be used
too to sync your note files

??? info "QOwnNotesAPI Nextcloud app"
- [**QOwnNotesAPI**](https://github.com/pbek/qownnotesapi) can handle the **access** to **trashed notes**
and **note versions** for you
- Please visit [QOwnNotesAPI Nextcloud App](qownnotesapi.md) for more information

??? info "Nextcloud Notes server app"
- Use [**Nextcloud Notes**](https://github.com/nextcloud/notes) to edit your notes in the **web**

Expand Down
31 changes: 31 additions & 0 deletions docs/content/getting-started/qownnotesapi.md
@@ -0,0 +1,31 @@
QOwnNotesAPI Nextcloud App
==========================

![qownnotesapi](../assets/img/qownnotesapi.png)

[**QOwnNotesAPI**](https://github.com/pbek/qownnotesapi) can handle the **access** to **trashed notes**
and **note versions** for you.

!!!info
You can enable QOwnNotesAPI directly in your **Nextcloud** or **ownCloud** instance by searching for `qownnotes`
in your server's **Apps page** at `https://<your-cloud-domain>/settings/apps`.

- [Nextcloud Apps page](https://apps.nextcloud.com/apps/qownnotesapi)
- [ownCloud Apps page](https://marketplace.owncloud.com/apps/qownnotesapi)

Note sharing is done via the API provided by Nextcloud / ownCloud. Tasks are accessed directly via CalDAV.

!!!tip
Use your **Nextcloud** / **ownCloud** **sync client** to **sync your notes**, your notes are simple markdown files.
There is no need to invent the wheel twice. And there are also people who are using different services to sync
their note files (like Dropbox, Syncthing or Resilio Sync).

## What QOwnNotesAPI does

- Accessing your trashed notes
- Accessing your note versions

## What QOwnNotesAPI doesn't do

- Syncing your notes (please use your ownCloud / Nextcloud sync client)
- Sharing notes (that is done directly via the ownCloud / Nextcloud API)
13 changes: 13 additions & 0 deletions docs/mkdocs.yml
Expand Up @@ -30,6 +30,18 @@ theme:
prev: 'Previous'
next: 'Next'

extra:
social:
- type: 'github'
link: 'https://github.com/pbek/QOwnNotes'
- type: 'telegram'
link: 'https://t.me/QOwnNotes'
- type: 'twitter'
link: 'https://twitter.com/QOwnNotes'
- type: 'facebook'
link: 'https://www.facebook.com/QOwnNotes/'
disqus: 'qownnotes-docs'

copyright: "Copyright &copy; 2014-2020 Patrizio Bekerle"

google_analytics:
Expand Down Expand Up @@ -78,6 +90,7 @@ nav:
- 'Concept': 'getting-started/concept.md'
- 'Install QOwnNotes': 'getting-started/install-qownnotes.md'
- 'Browser extension': 'getting-started/browser-extension.md'
- 'QOwnNotesAPI': 'getting-started/qownnotesapi.md'
- 'CLI parameters': 'getting-started/cli-parameters.md'
- 'Shortcuts': 'getting-started/shortcuts.md'
- 'Editor':
Expand Down

0 comments on commit dbfff6a

Please sign in to comment.