Merge branch 'master' of https://github.com/fyears/remotely-save

README.md

@@ -46,6 +46,8 @@ This is yet another unofficial sync plugin for Obsidian. If you like it or find
 - **You should protect your `data.json` file.** The file contains sensitive information.
   - It's strongly advised **NOT** to share your `data.json` file to anyone.
   - It's usually **NOT** a good idea to check the file into version control. By default, the plugin tries to create a `.gitignore` file inside the plugin directory if it doesn't exist, for ignoring `data.json` in the `git` version control. If you know exactly what it means and want to remove the setting, please modify the `.gitignore` file or set it to be empty.
+- **Obsidian API on Mobile has performance issues syncing large files (>= 50 MB).**
+  - Setting the "Skip Large Files" option can help resolve issues related to syncing large files.
 
 ## Questions, Suggestions, Or Bugs
 
@@ -161,7 +163,7 @@ PRO (paid) feature "sync with Azure Blob Storage" allows users to to sync with A
 
 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 any-size non-markdown files.
 
 See documents [here](./docs/pro/README.md)
 
@@ -176,11 +178,19 @@ See documents [here](./docs/pro/README.md)
 - 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
+## Config Folder / Files and Bookmarks
+
+By default, the plugin doesn't sync config folder / files of obsidian (normally `.obsidian` folder) because it's one of the hidden files. 
+
+However, in the latest version, you can enable syncing config folder in settings. Please be aware that it's an experimental feature. Notably some config files' modified times are changed everytime when Obsidian is opened, and this destroys the assumptions of the plugin, so some information may not be synced properly.
+
+Moreover, the bookmarks of Obsidian are actually stored in `.obsidian/bookmarks.json` file. You can also set syncing this file (instead of the whole config folder) in settings. The plugin will keep the latest modified one across devices.
+
+## 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.
 
-In the latest version, you can change the settings to allow syncing `_` files or folders, as well as `.obsidian` special config folder (but not any other `.` files or folders).
+In the latest version, you can change the settings to allow syncing `_` files or folders, as well as `.obsidian` special config folder as described above (but not any other `.` files or folders).
 
 ## PRO Features
 

docs/how_to_debug/README.md

@@ -6,12 +6,18 @@ Ideally, users do not need to debug anything. But if something bad happened, we
 
 See [here](./export_sync_plans.md).
 
-## Advanced: Check Console Output Directly
+## Medium: Desktop: Check Console Output Directly
 
 ...of desktop and Android.
 
 See [here](./check_console_output.md).
 
+## Medium: Mobile: Use `Obsidian vConsole` to Check Console Ouput Directly
+
+...of mobile (iOS and Android).
+
+See [here](./check_vconsole_output.md).
+
 ## Advanced: Use `Logstravaganza` to export logs
 
 This method works for desktop and mobile devices (iOS, Android), especially useful for iOS.

docs/how_to_debug/check_console_output.md

@@ -18,6 +18,8 @@ Go to the plugin settings, scroll down to the section "Debug" -> "alter console
 
 - If you are using Android
 
-  You need to [enable USB debugging](https://developer.android.com/studio/debug/dev-options#enable) on your Android, then connect your Android to a computer using USB, then open the **desktop** Chrome browser and go to the special web page <chrome://inspect>. You shall be able to see the "inspect" link inside the special page, then click the link to open the console. After debugging, remember to turn off USB debugging.
+  If you want to check the console **with the help of desktop Chrome**, you need to [enable USB debugging](https://developer.android.com/studio/debug/dev-options#enable) on your Android, then connect your Android to a computer using USB, then open the **desktop** Chrome browser and go to the special web page <chrome://inspect>. You shall be able to see the "inspect" link inside the special page, then click the link to open the console. After debugging, remember to turn off USB debugging.
+
+  If you want to check the console **directly on the mobile device**, check out [this doc](./check_vconsole_output.md).
 
 Trigger the sync manually (by clicking the icon on the ribbon sidebar). Something (hopefully) helpful should show up in the console. You could understand what happened and what goes wrong more explictly by checking the output.

docs/how_to_debug/check_vconsole_output.md

@@ -0,0 +1,21 @@
+# Check "Obsidian vConsole" Output
+
+It's quite hard to debug on mobile. But fortunately you can use another plugin to rescue!
+
+This applies to both iOS (iPhone / iPad) and Android.
+
+## Disable Auto Sync Firstly
+
+You should disable auto sync to avoid any unexpected running.
+
+## Set The Output Level To Debug
+
+Go to the plugin settings, scroll down to the section "Debug" -> "alter console log level", and change it from "info" to "debug".
+
+## Use "Obsidian vConsole"
+
+1. Install the third-party plugin ["Obsidian vConsole"](https://github.com/zhouhua/obsidian-vconsole).
+2. Enable "Obsidian vConsole". You shall see a green button in the right buttom corner of the interface of your mobile Obsidian. You can drag this green button to where you like.
+3. Sync! And quickly click the vConsole green button, you will see the console logs in its panel! Moreover, you can check browser network and Storage (LocalStorage) in the panel! 
+4. You can copy (by clicking the small "disk" icon beside each line of the log) or take a screenshot of the logs, and report bugs in Remotely Save GitHub. You can click "Hide" in the panel to hide the panel.
+5. If you don't need to debug any more, you can disable Obsidian vConsole plugin, then the green button should disappear.