diff --git a/docs/README.md b/docs/README.md index 60ce7b078d..7f156515eb 100644 --- a/docs/README.md +++ b/docs/README.md @@ -14,7 +14,7 @@ Then you can open 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 diff --git a/docs/content/assets/img/qownnotesapi.png b/docs/content/assets/img/qownnotesapi.png new file mode 100644 index 0000000000..a2eae2970e Binary files /dev/null and b/docs/content/assets/img/qownnotesapi.png differ diff --git a/docs/content/getting-started/concept.md b/docs/content/getting-started/concept.md index bf65586072..60cdc0048f 100644 --- a/docs/content/getting-started/concept.md +++ b/docs/content/getting-started/concept.md @@ -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** diff --git a/docs/content/getting-started/qownnotesapi.md b/docs/content/getting-started/qownnotesapi.md new file mode 100644 index 0000000000..b225284ee4 --- /dev/null +++ b/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:///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) diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index cb0449e9db..43d4661674 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -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 © 2014-2020 Patrizio Bekerle" google_analytics: @@ -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':