feature/add_united_entry_doc (#2298)

* add macos detailed build documentation

* feature/add_united_entry_doc

en_us/docs/Users/United Entry.md

@@ -0,0 +1,75 @@
+# United Entry
+
+VNote supports not only `search` in the left navigation bar, but also quick search in the `United Entry` in a command only way.
+
+Use an `Entry command` + `Search criteria` can quickly search notes folder or notes and files.
+
+## Activation
+
+By default, the shortcut key `Ctrl+G, G` is used to activate it. After triggering, you can see the following interface:
+
+You can also change the `"UnitedEntry": "Ctrl+G, G"` in the configuration file to replace it with the shortcut you are used to.
+
+![](vx_images/440002199826920.png)
+
+When entering the corresponding `Entry command`, the unified entrance will be automatically filtered, and the effect is as follows:
+
+![](vx_images/290853408616012.png)
+
+After entering a command, adding a `Space` will trigger a two-paragraph display, usually for detailed help.
+
+
+![](vx_images/469734231941763.png)
+
+![](vx_images/21594495890167.png)
+
+## Command Introduction
+
+VNote provides the following `Entry command` to complete the quick query.
+
+| Entry Command |                     Description                      |
+| ------------- | ---------------------------------------------------- |
+| a             | Search for files by content in all notebooks         |
+| c             | Search for files by tag in current notebook          |
+| d             | Search for files by content in current notebook      |
+| e             | Search for folders/files by name in current notebook |
+| f             | Search for files by content in current folder        |
+| find          | Search for files in notebook                         |
+| g             | Search for files by content in buffers               |
+| help          | help                                                 |
+| q             | Search for folders/files by name in all notebooks    |
+| r             | Search for folders/files by name in current folder   |
+| t             | Search for files by name in buffers                  |
+| v             | Search for files by tag in current folder            |
+| w             | Search for notebooks by name in all notebooks        |
+| z             | Search for files by tag in all notebooks             |
+
+## Example
+
+Find all folders/files containing `02` in all notebooks:
+
+![](vx_images/403493324576809.png)
+
+Find the file containing `task` in the current buffer:
+
+![](vx_images/229624223123287.png)
+
+Search all notebooks for notes containing the keyword `interface`:
+
+![](vx_images/78884071937631.png)
+
+Search all tags for notes that belong to the keyword `java` tag:
+
+![](vx_images/123313881807817.png)
+
+## Location
+
+<mark>WARNING! This varies by operating system.</mark>
+
+### macos
+
+When the search result is found, you need to press the `Tab` key, move the cursor position to the search result bar below, and then press `Enter` to locate the corresponding target.
+
+### windows
+
+After the search in win, it will stay in the first place in the result bar by default. You can directly press `Enter` to locate the first place. You can also move and reposition.

en_us/docs/Users/vx.json

@@ -1,141 +1,151 @@
-{
-    "created_time": "2018-11-24T11:06:19Z",
-    "files": [
-        {
-            "attachment_folder": "",
-            "created_time": "2018-11-24T11:05:58Z",
-            "id": "5",
-            "modified_time": "2021-07-11T08:59:08Z",
-            "name": "Welcome.md",
-            "signature": "115802545470579",
-            "tags": [
-            ]
-        },
-        {
-            "attachment_folder": "",
-            "created_time": "2018-11-24T12:08:25Z",
-            "id": "6",
-            "modified_time": "2021-07-11T09:02:39Z",
-            "name": "Why VNote.md",
-            "signature": "105073717165171",
-            "tags": [
-            ]
-        },
-        {
-            "attachment_folder": "",
-            "created_time": "2018-11-24T12:09:23Z",
-            "id": "7",
-            "modified_time": "2021-07-12T12:41:51Z",
-            "name": "Get Started.md",
-            "signature": "24504425659507",
-            "tags": [
-            ]
-        },
-        {
-            "attachment_folder": "",
-            "created_time": "2018-11-24T12:22:16Z",
-            "id": "15",
-            "modified_time": "2021-07-13T12:08:47Z",
-            "name": "Frequently Asked Questions.md",
-            "signature": "20733444373619",
-            "tags": [
-            ]
-        },
-        {
-            "attachment_folder": "",
-            "created_time": "2022-04-09T01:41:06Z",
-            "id": "55",
-            "modified_time": "2022-04-09T01:56:04Z",
-            "name": "Data Migration.md",
-            "signature": "177743127602",
-            "tags": [
-            ]
-        },
-        {
-            "attachment_folder": "",
-            "created_time": "2018-11-24T12:13:02Z",
-            "id": "8",
-            "modified_time": "2021-07-12T12:50:26Z",
-            "name": "Notes Management.md",
-            "signature": "120883491781747",
-            "tags": [
-            ]
-        },
-        {
-            "attachment_folder": "",
-            "created_time": "2021-07-12T00:48:35Z",
-            "id": "9",
-            "modified_time": "2021-07-12T01:40:43Z",
-            "name": "Configuration.md",
-            "signature": "99992770854003",
-            "tags": [
-            ]
-        },
-        {
-            "attachment_folder": "",
-            "created_time": "2018-11-24T12:15:19Z",
-            "id": "10",
-            "modified_time": "2021-07-11T09:41:37Z",
-            "name": "Snippet.md",
-            "signature": "72273051925619",
-            "tags": [
-            ]
-        },
-        {
-            "attachment_folder": "",
-            "created_time": "2018-11-24T12:17:11Z",
-            "id": "11",
-            "modified_time": "2021-07-11T09:44:41Z",
-            "name": "Template.md",
-            "signature": "42783806471283",
-            "tags": [
-            ]
-        },
-        {
-            "attachment_folder": "",
-            "created_time": "2018-11-24T12:18:17Z",
-            "id": "12",
-            "modified_time": "2022-08-12T13:11:39Z",
-            "name": "Themes and Styles.md",
-            "signature": "2110466178163",
-            "tags": [
-            ]
-        },
-        {
-            "attachment_folder": "",
-            "created_time": "2021-08-14T00:40:43Z",
-            "id": "13",
-            "modified_time": "2021-08-14T01:11:21Z",
-            "name": "Image Host.md",
-            "signature": "12865064287347",
-            "tags": [
-            ]
-        },
-        {
-            "attachment_folder": "",
-            "created_time": "2021-08-29T03:24:23Z",
-            "id": "14",
-            "modified_time": "2021-08-29T03:44:20Z",
-            "name": "Export.md",
-            "signature": "51292136684659",
-            "tags": [
-            ]
-        },
-        {
-            "attachment_folder": "",
-            "created_time": "2021-12-23T07:29:06Z",
-            "id": "49",
-            "modified_time": "2021-12-27T04:00:43Z",
-            "name": "Task.md",
-            "signature": "177733903682",
-            "tags": [
-            ]
-        }
-    ],
-    "folders": [
-    ],
-    "id": "4",
-    "modified_time": "2021-05-12T12:13:25Z",
-    "signature": "23349079456883",
-    "version": 3
-}
+{
+    "created_time": "2018-11-24T11:06:19Z",
+    "files": [
+        {
+            "attachment_folder": "",
+            "created_time": "2018-11-24T11:05:58Z",
+            "id": "5",
+            "modified_time": "2021-07-11T08:59:08Z",
+            "name": "Welcome.md",
+            "signature": "115802545470579",
+            "tags": [
+            ]
+        },
+        {
+            "attachment_folder": "",
+            "created_time": "2018-11-24T12:08:25Z",
+            "id": "6",
+            "modified_time": "2021-07-11T09:02:39Z",
+            "name": "Why VNote.md",
+            "signature": "105073717165171",
+            "tags": [
+            ]
+        },
+        {
+            "attachment_folder": "",
+            "created_time": "2018-11-24T12:09:23Z",
+            "id": "7",
+            "modified_time": "2021-07-12T12:41:51Z",
+            "name": "Get Started.md",
+            "signature": "24504425659507",
+            "tags": [
+            ]
+        },
+        {
+            "attachment_folder": "",
+            "created_time": "2018-11-24T12:22:16Z",
+            "id": "15",
+            "modified_time": "2021-07-13T12:08:47Z",
+            "name": "Frequently Asked Questions.md",
+            "signature": "20733444373619",
+            "tags": [
+            ]
+        },
+        {
+            "attachment_folder": "",
+            "created_time": "2022-04-09T01:41:06Z",
+            "id": "55",
+            "modified_time": "2022-04-09T01:56:04Z",
+            "name": "Data Migration.md",
+            "signature": "177743127602",
+            "tags": [
+            ]
+        },
+        {
+            "attachment_folder": "",
+            "created_time": "2018-11-24T12:13:02Z",
+            "id": "8",
+            "modified_time": "2021-07-12T12:50:26Z",
+            "name": "Notes Management.md",
+            "signature": "120883491781747",
+            "tags": [
+            ]
+        },
+        {
+            "attachment_folder": "",
+            "created_time": "2021-07-12T00:48:35Z",
+            "id": "9",
+            "modified_time": "2021-07-12T01:40:43Z",
+            "name": "Configuration.md",
+            "signature": "99992770854003",
+            "tags": [
+            ]
+        },
+        {
+            "attachment_folder": "",
+            "created_time": "2018-11-24T12:15:19Z",
+            "id": "10",
+            "modified_time": "2021-07-11T09:41:37Z",
+            "name": "Snippet.md",
+            "signature": "72273051925619",
+            "tags": [
+            ]
+        },
+        {
+            "attachment_folder": "",
+            "created_time": "2018-11-24T12:17:11Z",
+            "id": "11",
+            "modified_time": "2021-07-11T09:44:41Z",
+            "name": "Template.md",
+            "signature": "42783806471283",
+            "tags": [
+            ]
+        },
+        {
+            "attachment_folder": "",
+            "created_time": "2018-11-24T12:18:17Z",
+            "id": "12",
+            "modified_time": "2022-08-12T13:11:39Z",
+            "name": "Themes and Styles.md",
+            "signature": "2110466178163",
+            "tags": [
+            ]
+        },
+        {
+            "attachment_folder": "",
+            "created_time": "2021-08-14T00:40:43Z",
+            "id": "13",
+            "modified_time": "2021-08-14T01:11:21Z",
+            "name": "Image Host.md",
+            "signature": "12865064287347",
+            "tags": [
+            ]
+        },
+        {
+            "attachment_folder": "",
+            "created_time": "2021-08-29T03:24:23Z",
+            "id": "14",
+            "modified_time": "2021-08-29T03:44:20Z",
+            "name": "Export.md",
+            "signature": "51292136684659",
+            "tags": [
+            ]
+        },
+        {
+            "attachment_folder": "",
+            "created_time": "2021-12-23T07:29:06Z",
+            "id": "49",
+            "modified_time": "2021-12-27T04:00:43Z",
+            "name": "Task.md",
+            "signature": "177733903682",
+            "tags": [
+            ]
+        },
+        {
+            "attachment_folder": "",
+            "created_time": "2022-11-26T09:17:13Z",
+            "id": "65",
+            "modified_time": "2022-11-26T09:37:43Z",
+            "name": "United Entry.md",
+            "signature": "207324035799449",
+            "tags": [
+            ]
+        }
+    ],
+    "folders": [
+    ],
+    "id": "4",
+    "modified_time": "2021-05-12T12:13:25Z",
+    "signature": "23349079456883",
+    "version": 3
+}

zh_cn/docs/用户/vx.json

@@ -1,141 +1,151 @@
-{
-    "created_time": "2018-11-24T11:09:01Z",
-    "files": [
-        {
-            "attachment_folder": "",
-            "created_time": "2018-11-24T12:26:23Z",
-            "id": "32",
-            "modified_time": "2021-07-12T12:22:14Z",
-            "name": "欢迎使用.md",
-            "signature": "8028931112051",
-            "tags": [
-            ]
-        },
-        {
-            "attachment_folder": "",
-            "created_time": "2018-11-24T12:28:54Z",
-            "id": "33",
-            "modified_time": "2021-07-12T12:35:12Z",
-            "name": "为什么需要 VNote.md",
-            "signature": "85523026033779",
-            "tags": [
-            ]
-        },
-        {
-            "attachment_folder": "",
-            "created_time": "2018-11-24T12:29:11Z",
-            "id": "34",
-            "modified_time": "2021-07-12T12:43:38Z",
-            "name": "快速上手.md",
-            "signature": "110240562822259",
-            "tags": [
-            ]
-        },
-        {
-            "attachment_folder": "",
-            "created_time": "2018-11-24T12:31:22Z",
-            "id": "42",
-            "modified_time": "2021-07-13T12:07:30Z",
-            "name": "常见问题.md",
-            "signature": "75906594258035",
-            "tags": [
-            ]
-        },
-        {
-            "attachment_folder": "",
-            "created_time": "2022-04-09T01:41:06Z",
-            "id": "57",
-            "modified_time": "2022-04-09T01:56:36Z",
-            "name": "数据迁移.md",
-            "signature": "79316810524384",
-            "tags": [
-            ]
-        },
-        {
-            "attachment_folder": "",
-            "created_time": "2018-11-24T12:29:25Z",
-            "id": "35",
-            "modified_time": "2021-07-12T12:56:05Z",
-            "name": "笔记管理.md",
-            "signature": "112954982153331",
-            "tags": [
-            ]
-        },
-        {
-            "attachment_folder": "",
-            "created_time": "2021-07-12T13:00:13Z",
-            "id": "36",
-            "modified_time": "2021-07-12T13:08:50Z",
-            "name": "配置.md",
-            "signature": "73166405123187",
-            "tags": [
-            ]
-        },
-        {
-            "attachment_folder": "",
-            "created_time": "2018-11-24T12:29:35Z",
-            "id": "37",
-            "modified_time": "2021-07-13T11:27:54Z",
-            "name": "片段.md",
-            "signature": "42496043662451",
-            "tags": [
-            ]
-        },
-        {
-            "attachment_folder": "",
-            "created_time": "2018-11-24T12:29:56Z",
-            "id": "38",
-            "modified_time": "2021-07-13T11:28:05Z",
-            "name": "模板.md",
-            "signature": "123280083532915",
-            "tags": [
-            ]
-        },
-        {
-            "attachment_folder": "",
-            "created_time": "2018-11-24T12:30:05Z",
-            "id": "39",
-            "modified_time": "2022-08-12T13:13:26Z",
-            "name": "主题和样式.md",
-            "signature": "102269103520883",
-            "tags": [
-            ]
-        },
-        {
-            "attachment_folder": "",
-            "created_time": "2021-08-14T01:05:32Z",
-            "id": "40",
-            "modified_time": "2021-08-14T01:12:23Z",
-            "name": "图床.md",
-            "signature": "134528602881139",
-            "tags": [
-            ]
-        },
-        {
-            "attachment_folder": "",
-            "created_time": "2021-08-29T03:38:55Z",
-            "id": "41",
-            "modified_time": "2021-08-29T03:48:03Z",
-            "name": "导出.md",
-            "signature": "130280880225395",
-            "tags": [
-            ]
-        },
-        {
-            "attachment_folder": "",
-            "created_time": "2021-12-24T07:55:35Z",
-            "id": "50",
-            "modified_time": "2021-12-27T04:01:14Z",
-            "name": "任务.md",
-            "signature": "177733991671",
-            "tags": [
-            ]
-        }
-    ],
-    "folders": [
-    ],
-    "id": "31",
-    "modified_time": "2021-05-12T12:13:25Z",
-    "signature": "20033364704371",
-    "version": 3
-}
+{
+    "created_time": "2018-11-24T11:09:01Z",
+    "files": [
+        {
+            "attachment_folder": "",
+            "created_time": "2018-11-24T12:26:23Z",
+            "id": "32",
+            "modified_time": "2021-07-12T12:22:14Z",
+            "name": "欢迎使用.md",
+            "signature": "8028931112051",
+            "tags": [
+            ]
+        },
+        {
+            "attachment_folder": "",
+            "created_time": "2018-11-24T12:28:54Z",
+            "id": "33",
+            "modified_time": "2021-07-12T12:35:12Z",
+            "name": "为什么需要 VNote.md",
+            "signature": "85523026033779",
+            "tags": [
+            ]
+        },
+        {
+            "attachment_folder": "",
+            "created_time": "2018-11-24T12:29:11Z",
+            "id": "34",
+            "modified_time": "2021-07-12T12:43:38Z",
+            "name": "快速上手.md",
+            "signature": "110240562822259",
+            "tags": [
+            ]
+        },
+        {
+            "attachment_folder": "",
+            "created_time": "2018-11-24T12:31:22Z",
+            "id": "42",
+            "modified_time": "2021-07-13T12:07:30Z",
+            "name": "常见问题.md",
+            "signature": "75906594258035",
+            "tags": [
+            ]
+        },
+        {
+            "attachment_folder": "",
+            "created_time": "2022-04-09T01:41:06Z",
+            "id": "57",
+            "modified_time": "2022-04-09T01:56:36Z",
+            "name": "数据迁移.md",
+            "signature": "79316810524384",
+            "tags": [
+            ]
+        },
+        {
+            "attachment_folder": "",
+            "created_time": "2018-11-24T12:29:25Z",
+            "id": "35",
+            "modified_time": "2021-07-12T12:56:05Z",
+            "name": "笔记管理.md",
+            "signature": "112954982153331",
+            "tags": [
+            ]
+        },
+        {
+            "attachment_folder": "",
+            "created_time": "2021-07-12T13:00:13Z",
+            "id": "36",
+            "modified_time": "2021-07-12T13:08:50Z",
+            "name": "配置.md",
+            "signature": "73166405123187",
+            "tags": [
+            ]
+        },
+        {
+            "attachment_folder": "",
+            "created_time": "2018-11-24T12:29:35Z",
+            "id": "37",
+            "modified_time": "2021-07-13T11:27:54Z",
+            "name": "片段.md",
+            "signature": "42496043662451",
+            "tags": [
+            ]
+        },
+        {
+            "attachment_folder": "",
+            "created_time": "2018-11-24T12:29:56Z",
+            "id": "38",
+            "modified_time": "2021-07-13T11:28:05Z",
+            "name": "模板.md",
+            "signature": "123280083532915",
+            "tags": [
+            ]
+        },
+        {
+            "attachment_folder": "",
+            "created_time": "2018-11-24T12:30:05Z",
+            "id": "39",
+            "modified_time": "2022-08-12T13:13:26Z",
+            "name": "主题和样式.md",
+            "signature": "102269103520883",
+            "tags": [
+            ]
+        },
+        {
+            "attachment_folder": "",
+            "created_time": "2021-08-14T01:05:32Z",
+            "id": "40",
+            "modified_time": "2021-08-14T01:12:23Z",
+            "name": "图床.md",
+            "signature": "134528602881139",
+            "tags": [
+            ]
+        },
+        {
+            "attachment_folder": "",
+            "created_time": "2021-08-29T03:38:55Z",
+            "id": "41",
+            "modified_time": "2021-08-29T03:48:03Z",
+            "name": "导出.md",
+            "signature": "130280880225395",
+            "tags": [
+            ]
+        },
+        {
+            "attachment_folder": "",
+            "created_time": "2021-12-24T07:55:35Z",
+            "id": "50",
+            "modified_time": "2021-12-27T04:01:14Z",
+            "name": "任务.md",
+            "signature": "177733991671",
+            "tags": [
+            ]
+        },
+        {
+            "attachment_folder": "",
+            "created_time": "2022-11-26T07:17:39Z",
+            "id": "64",
+            "modified_time": "2022-11-26T09:35:38Z",
+            "name": "统一入口.md",
+            "signature": "6857691952964550035",
+            "tags": [
+            ]
+        }
+    ],
+    "folders": [
+    ],
+    "id": "31",
+    "modified_time": "2021-05-12T12:13:25Z",
+    "signature": "20033364704371",
+    "version": 3
+}

zh_cn/docs/用户/统一入口.md

@@ -0,0 +1,77 @@
+# 统一入口
+
+VNote 支持除了在左侧导航栏使用 `搜索` 以外，还支持在 `统一入口` 中用纯命令的方式快捷搜索。
+
+简单的说就是使用一个 `入口命令` + `搜索条件` 就可以快速搜索对应笔记文件夹或笔记以及文件。
+
+## 激活方式
+
+默认使用快捷键 `Ctrl+G, G` 激活，触发后可以看到如下界面：
+
+同时也可以修改配置文件中的 `"UnitedEntry": "Ctrl+G, G"` 来更换成你习惯的快捷键。
+
+![](vx_images/324442707523497.png)
+
+输入相应的 `入口命令` 时，统一入口会进行自动筛选，效果如下：
+
+![](vx_images/204635453752275.png)
+
+输入命令后，再加一个 `空格` 会触发二段显示，一般为详细的帮助。
+
+![](vx_images/534244865549873.png)
+
+
+![](vx_images/509180599826920.png)
+
+## 命令介绍
+
+VNote 提供了一下 `入口命令` 来完成快速查询
+
+| 入口命令 |             描述             | 
+| ------ | --------------------------- |
+| a       | 在所有笔记本中按内容搜索文件       |
+| c       | 在当前笔记本中按标签搜索文件       |
+| d       | 根据当前笔记本中的内容搜索文件      |
+| e       | 在当前笔记本中按名称搜索文件夹/文件 |
+| f       | 在当前文件夹中按内容搜索文件       |
+| find    | 在笔记本中搜索文件              |
+| g       | 根据缓冲区中的内容搜索文件         |
+| help    | 统一入口的帮助信息                 |
+| q       | 在所有笔记本中按名称搜索文件夹/文件 |
+| r       | 在当前文件夹中按名称搜索文件夹/文件 |
+| t       | 在缓冲区中按名称搜索文件          |
+| v       | 在当前文件夹中按标签搜索文件       |
+| w       | 在所有笔记本中按名称搜索笔记本      |
+| z       | 在所有笔记本中按标签查找文件        |
+
+
+## 查询示例
+
+在所有笔记本中找到所有包含 `02月` 的 `文件夹/文件`：
+
+![](vx_images/99887186357039.png)
+
+在当前缓冲区找到包含 `配置` 的 `文件`：
+
+![](vx_images/473341415115465.png)
+
+在所有笔记本中搜索包含关键字 `接口` 的笔记：
+
+![](vx_images/518862398778095.png)
+
+在所有标签中搜索属于关键字 `java` 标签中的笔记：
+
+![](vx_images/194063416269397.png)
+
+
+## 定位
+
+<mark>注意！不同的操作系统触发定位的方式可能有些区别。</mark>
+
+### macos 下的定位
+
+当搜索到结果后，需要按一下 `Tab` 键，将光标的定位移动到下面的搜索结果栏中，再按 `Enter` 即可定位到对应目标。
+
+### windows 下的定位
+
+windows 下搜索完后默认是停留在结果栏的第一位中，可以直接按 `Enter` 既定位第一个。 也可以进行移动再定位。