Skip to content

Commit 9a869f7

Browse files
committed
feat: add user guide
1 parent 16d6136 commit 9a869f7

24 files changed

+1076
-2
lines changed

.vitepress/config.mts

Lines changed: 48 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,57 @@ export default defineConfig({
1616
themeConfig: {
1717
nav: [
1818
{ text: "Home", link: "/" },
19-
{ text: "Docs", link: "/docs" },
19+
{ text: "User Guide", link: "/user-guide/" },
20+
{ text: "Plugin Docs", link: "/docs" },
2021
{ text: "Tutorials", link: "/tutorials" },
2122
],
2223
sidebar: {
24+
"/user-guide/": [
25+
{
26+
text: "User Guide",
27+
items: [
28+
{ text: "Overview", link: "/user-guide/" },
29+
{
30+
text: "Command Palette",
31+
link: "/user-guide/command-palette",
32+
},
33+
{ text: "File Browser", link: "/user-guide/file-browser" },
34+
{ text: "Remote Access", link: "/user-guide/remote-access" },
35+
{ text: "Plugins", link: "/user-guide/plugins" },
36+
{ text: "Terminal", link: "/user-guide/terminal" },
37+
{
38+
text: "Settings",
39+
link: "/user-guide/settings",
40+
collapsed: true,
41+
items: [
42+
{
43+
text: "App Settings",
44+
link: "/user-guide/settings/app-settings",
45+
},
46+
{
47+
text: "Editor Settings",
48+
link: "/user-guide/settings/editor-settings",
49+
},
50+
{
51+
text: "Terminal Settings",
52+
link: "/user-guide/settings/terminal-settings",
53+
},
54+
{
55+
text: "Preview Settings",
56+
link: "/user-guide/settings/preview-settings",
57+
},
58+
{
59+
text: "Formatter",
60+
link: "/user-guide/settings/formatter",
61+
},
62+
{ text: "Themes", link: "/user-guide/settings/themes" },
63+
],
64+
},
65+
{ text: "Keybindings", link: "/user-guide/keybindings" },
66+
{ text: "QuickTools", link: "/user-guide/quicktools" },
67+
],
68+
},
69+
],
2370
"/docs/": [
2471
{
2572
text: "Getting Started",

biome.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,8 @@
66
"useIgnoreFile": false
77
},
88
"files": {
9-
"ignoreUnknown": false
9+
"ignoreUnknown": false,
10+
"includes": ["**", "!.vitepress/cache/**"]
1011
},
1112
"formatter": {
1213
"enabled": true,

bun.lock

Lines changed: 275 additions & 0 deletions
Large diffs are not rendered by default.

package.json

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,5 +18,8 @@
1818
"@biomejs/biome": "2.1.2",
1919
"vitepress": "^1.2.3",
2020
"vue": "^3.4.27"
21+
},
22+
"dependencies": {
23+
"lucide-vue-next": "^0.562.0"
2124
}
2225
}

public/file_broswer_project.png

1.55 MB
Loading

public/file_browser.png

61.5 KB
Loading

public/plugin_page.png

389 KB
Loading

public/quicktools.png

55.4 KB
Loading
151 KB
Loading

user-guide/command-palette.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# Command Palette
2+
3+
The Command Palette is a central hub for accessing various commands in Acode. It allows you to search for and execute commands without navigating through menus.
4+
5+
## Opening the Command Palette
6+
7+
### Keyboard Shortcut
8+
9+
::: tip
10+
You can open the Command Palette using the standard shortcut:
11+
**`Ctrl` + `Shift` + `P`**
12+
:::
13+
14+
### Mobile Devices (QuickTools)
15+
16+
On mobile devices where a physical keyboard might not be present, Acode provides **QuickTools**—a toolbar above the keyboard that contains essential keys like `Ctrl`.
17+
18+
![QuickTools](/quicktools.png)
19+
20+
You can use the `Ctrl` key from QuickTools in combination with the on-screen keyboard to trigger the shortcut.
21+
22+
### Dedicated QuickTools Button
23+
24+
For even faster access, you can add a dedicated **Command Palette** button to your QuickTools bar.
25+
26+
#### How to Configure
27+
28+
1. Go to **Settings** > **App Settings**.
29+
2. Select **QuickTools**.
30+
3. In the configuration view, drag and drop the **Command Palette** icon to your active QuickTools bar.
31+
32+
![QuickTools Configure Page](/quicktools_configure_page.png)

0 commit comments

Comments
 (0)