polish doc
This commit is contained in:
parent
7f446b810c
commit
57493f57cf
21
README.md
21
README.md
@ -22,7 +22,7 @@ This is yet another unofficial sync plugin for Obsidian. If you like it or find
|
|||||||
- OneDrive for personal
|
- OneDrive for personal
|
||||||
- Webdav (NextCloud / InfiniCloud / Synology webdav server / ...)
|
- Webdav (NextCloud / InfiniCloud / Synology webdav server / ...)
|
||||||
- Webdis
|
- Webdis
|
||||||
- Google Drive (PRO feature)
|
- Google Drive (GDrive) (PRO feature)
|
||||||
- Box (PRO feature)
|
- Box (PRO feature)
|
||||||
- pCloud (PRO feature)
|
- pCloud (PRO feature)
|
||||||
- Yandex Disk (PRO feature)
|
- Yandex Disk (PRO feature)
|
||||||
@ -34,7 +34,7 @@ This is yet another unofficial sync plugin for Obsidian. If you like it or find
|
|||||||
- **[Minimal Intrusive](./docs/minimal_intrusive_design.md).**
|
- **[Minimal Intrusive](./docs/minimal_intrusive_design.md).**
|
||||||
- **Skip Large files** and **skip paths** by custom regex conditions!
|
- **Skip Large files** and **skip paths** by custom regex conditions!
|
||||||
- **[Sync Algorithm](./docs/sync_algorithm/v3/intro.md) is provided for discussion.**
|
- **[Sync Algorithm](./docs/sync_algorithm/v3/intro.md) is provided for discussion.**
|
||||||
- **[Basic Conflict Detection And Handling](./docs/sync_algorithm/v3/intro.md)** for free version. **[Advanced Conflict Handling](./pro/README.md)** for PRO version.
|
- **[Basic Conflict Detection And Handling](./docs/sync_algorithm/v3/intro.md)** for free version. **[Advanced Smart Conflict Handling](./pro/README.md)** for PRO version.
|
||||||
- Source Available. See [License](./LICENSE) for details.
|
- Source Available. See [License](./LICENSE) for details.
|
||||||
|
|
||||||
## Limitations
|
## Limitations
|
||||||
@ -127,7 +127,7 @@ Additionally, the plugin author may occasionally visit Obsidian official forum a
|
|||||||
- Mostly experimental.
|
- Mostly experimental.
|
||||||
- You have to setup and protect your web server by yourself.
|
- You have to setup and protect your web server by yourself.
|
||||||
|
|
||||||
### Google Drive (PRO feature)
|
### Google Drive (GDrive) (PRO feature)
|
||||||
|
|
||||||
PRO (paid) feature "sync with Google Drive" allows users to to sync with Google Drive. Tutorials and limitations are documented [here](./docs/remote_services/googledrive/README.md).
|
PRO (paid) feature "sync with Google Drive" allows users to to sync with Google Drive. Tutorials and limitations are documented [here](./docs/remote_services/googledrive/README.md).
|
||||||
|
|
||||||
@ -143,16 +143,29 @@ PRO (paid) feature "sync with pCloud" allows users to to sync with pCloud (using
|
|||||||
|
|
||||||
PRO (paid) feature "sync with Yandex Disk" allows users to to sync with Yandex Disk (using its native API instead of webdav). Tutorials and limitations are documented [here](./docs/remote_services/yandexdisk/README.md).
|
PRO (paid) feature "sync with Yandex Disk" allows users to to sync with Yandex Disk (using its native API instead of webdav). Tutorials and limitations are documented [here](./docs/remote_services/yandexdisk/README.md).
|
||||||
|
|
||||||
### Yandex Disk (PRO feature)
|
### Koofr (PRO feature)
|
||||||
|
|
||||||
PRO (paid) feature "sync with Koofr" allows users to to sync with Koofr (using its native API instead of webdav). Tutorials and limitations are documented [here](./docs/remote_services/koofr/README.md).
|
PRO (paid) feature "sync with Koofr" allows users to to sync with Koofr (using its native API instead of webdav). Tutorials and limitations are documented [here](./docs/remote_services/koofr/README.md).
|
||||||
|
|
||||||
|
## Smart Conflict (PRO feature)
|
||||||
|
|
||||||
|
Basic (free) version can detect conflicts, but users have to choose to keep newer version or larger version of the files.
|
||||||
|
|
||||||
|
PRO (paid) feature "Smart Conflict" gives users one more option: merge small markdown files, or duplicate large markdown files or non-markdown files.
|
||||||
|
|
||||||
|
See documents [here](./docs/pro/README.md)
|
||||||
|
|
||||||
## Scheduled Auto Sync
|
## Scheduled Auto Sync
|
||||||
|
|
||||||
- You can configure auto syncing every N minutes in settings.
|
- You can configure auto syncing every N minutes in settings.
|
||||||
- In auto sync mode, if any error occurs, the plugin would **fail silently**.
|
- In auto sync mode, if any error occurs, the plugin would **fail silently**.
|
||||||
- Auto sync only works when Obsidian is being opened. It's **technically impossible** to auto sync while Obsidian is in background, because the plugin just works in the browser environment provided by Obsidian.
|
- Auto sync only works when Obsidian is being opened. It's **technically impossible** to auto sync while Obsidian is in background, because the plugin just works in the browser environment provided by Obsidian.
|
||||||
|
|
||||||
|
## Sync On Save
|
||||||
|
|
||||||
|
- You can configure sync on save in settings.
|
||||||
|
- In sync on save mode, if any error occurs, the plugin would **fail silently**.
|
||||||
|
|
||||||
## How To Deal With Hidden Files Or Folders
|
## How To Deal With Hidden Files Or Folders
|
||||||
|
|
||||||
**By default, all files or folder starting with `.` (dot) or `_` (underscore) are treated as hidden files, and would NOT be synced.** It's useful if you have some files just staying locally. But this strategy also means that themes / other plugins / settings of this plugin would neither be synced.
|
**By default, all files or folder starting with `.` (dot) or `_` (underscore) are treated as hidden files, and would NOT be synced.** It's useful if you have some files just staying locally. But this strategy also means that themes / other plugins / settings of this plugin would neither be synced.
|
||||||
|
|||||||
@ -1,4 +1,4 @@
|
|||||||
# Google Drive (PRO)
|
# Google Drive (GDrive) (PRO)
|
||||||
|
|
||||||
# Intro
|
# Intro
|
||||||
|
|
||||||
|
|||||||
@ -6,18 +6,34 @@ Remotely Save has some "pro features", which users have to pay for using them.
|
|||||||
|
|
||||||
## Sign Up / Sign In And Connect
|
## Sign Up / Sign In And Connect
|
||||||
|
|
||||||
See the tutorial about your PRO account [here](../docs/pro/README.md).
|
See the tutorial about your PRO account [here](.../docs/pro/README.md).
|
||||||
|
|
||||||
## Smart Conflict
|
## Smart Conflict (PRO feature)
|
||||||
|
|
||||||
Basic (free) version can detect conflicts, but users have to choose to keep newer version or larger version of the files.
|
Basic (free) version can detect conflicts, but users have to choose to keep newer version or larger version of the files.
|
||||||
|
|
||||||
PRO (paid) feature "Smart Conflict" gives users one more option: merge small markdown files, or duplicate large markdown files or non-markdown files.
|
PRO (paid) feature "Smart Conflict" gives users one more option: merge small markdown files, or duplicate large markdown files or non-markdown files.
|
||||||
|
|
||||||
## Sync With Google Drive
|
## Google Drive (GDrive) (PRO feature)
|
||||||
|
|
||||||
PRO (paid) feature "sync with Google Drive" allows users to to sync with Google Drive. Tutorials and limitations are documented [here](../docs/remote_services/googledrive/README.md).
|
PRO (paid) feature "sync with Google Drive" allows users to to sync with Google Drive. Tutorials and limitations are documented [here](../docs/remote_services/googledrive/README.md).
|
||||||
|
|
||||||
|
## Box (PRO feature)
|
||||||
|
|
||||||
|
PRO (paid) feature "sync with Box" allows users to to sync with Box. Tutorials and limitations are documented [here](../docs/remote_services/box/README.md).
|
||||||
|
|
||||||
|
## pCloud (PRO feature)
|
||||||
|
|
||||||
|
PRO (paid) feature "sync with pCloud" allows users to to sync with pCloud (using its native API instead of webdav). Tutorials and limitations are documented [here](../docs/remote_services/pcloud/README.md).
|
||||||
|
|
||||||
|
## Yandex Disk (PRO feature)
|
||||||
|
|
||||||
|
PRO (paid) feature "sync with Yandex Disk" allows users to to sync with Yandex Disk (using its native API instead of webdav). Tutorials and limitations are documented [here](../docs/remote_services/yandexdisk/README.md).
|
||||||
|
|
||||||
|
## Koofr (PRO feature)
|
||||||
|
|
||||||
|
PRO (paid) feature "sync with Koofr" allows users to to sync with Koofr (using its native API instead of webdav). Tutorials and limitations are documented [here](../docs/remote_services/koofr/README.md).
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
The codes or files or subfolders inside the current folder (`pro` in the repo), are released under "source available" license: "PolyForm Strict License 1.0.0".
|
The codes or files or subfolders inside the current folder (`pro` in the repo), are released under "source available" license: "PolyForm Strict License 1.0.0".
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user