From fdaa9456fe6a628a5f15a903562ec3f83d048ca5 Mon Sep 17 00:00:00 2001 From: wzc520pyfm <1528857653@qq.com> Date: Sat, 3 Aug 2024 18:59:02 +0800 Subject: [PATCH 1/2] docs: add shortcut guide close #547 --- docs/getting-started/features.md | 8 +++++--- docs/guide/vite-plugin.md | 2 ++ 2 files changed, 7 insertions(+), 3 deletions(-) diff --git a/docs/getting-started/features.md b/docs/getting-started/features.md index 7e85c9bcd..af7a521bf 100644 --- a/docs/getting-started/features.md +++ b/docs/getting-started/features.md @@ -1,6 +1,8 @@ # Features -Discover all the features of the Vue DevTools +Discover all the features of the Vue DevTools. + +You can open or close Vue DevTools with `Shift+Alt+D` or `Shift+Option+D` shortcut. ## Overview @@ -52,7 +54,7 @@ Graph tab shows the relationship between modules. ## Settings -Settings tab provides some options to customize the DevTools. +Settings tab provides some options to customize the DevTools. Here you can manage the Tab bar, enable or disable some features, and hide Vue Devtools. ![settings](/features/settings.svg) @@ -64,7 +66,7 @@ Inspect expose the [vite-plugin-inspect](https://github.com/antfu/vite-plugin-in ## Inspector -Inspector expose the [vite-plugin-vue-inspector](https://github.com/webfansplz/vite-plugin-vue-inspector) integration, you can inspect your app's DOM tree and see which component is rendering it. Finding the place to make changes are much easier. +Inspector expose the [vite-plugin-vue-inspector](https://github.com/webfansplz/vite-plugin-vue-inspector) integration, you can inspect your app's DOM tree and see which component is rendering it. Finding the place to make changes are much easier. You can active it with `Ctrl+Shift` or `Cmd+Shift` shortcut. When activated, you can use `Esc` shortcut to exit. You can customize shortcut by [`Options.componentInspector.toggleComboKey`](/guide/vite-plugin#options) ![inspector](/features/inspector.svg) diff --git a/docs/guide/vite-plugin.md b/docs/guide/vite-plugin.md index 0f62ebc0f..2480a79c9 100644 --- a/docs/guide/vite-plugin.md +++ b/docs/guide/vite-plugin.md @@ -59,6 +59,8 @@ interface VitePluginVueDevToolsOptions { /** * Enable vue component inspector * + * The VitePluginInspectorOptions you can see https://github.com/webfansplz/vite-plugin-vue-inspector?tab=readme-ov-file#options + * * @default true */ componentInspector?: boolean | VitePluginInspectorOptions From 2928cd1061d7f37e4ffb6571082441dab75707e8 Mon Sep 17 00:00:00 2001 From: wzc520pyfm <1528857653@qq.com> Date: Sat, 31 Aug 2024 14:42:49 +0800 Subject: [PATCH 2/2] docs: update toggle shortcut description --- docs/getting-started/features.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/getting-started/features.md b/docs/getting-started/features.md index af7a521bf..9ca75ddbf 100644 --- a/docs/getting-started/features.md +++ b/docs/getting-started/features.md @@ -2,7 +2,7 @@ Discover all the features of the Vue DevTools. -You can open or close Vue DevTools with `Shift+Alt+D` or `Shift+Option+D` shortcut. +If you are using Vite plugin, you can open or close Vue DevTools with `Shift+Alt+D` or `Shift+Option+D` shortcut. ## Overview