Skip to content

Commit

Permalink
Updated documentation and improved docsify configuration
Browse files Browse the repository at this point in the history
Expanded the documentation for the Wox Launcher by adding new guides for installation and usage of Query Hotkeys and Query Shortcuts. Altered the docsify configuration in the main index to reflect the updated project name and Github path, and improved the docsify Edit link. Additionally, the sidebar navigation for the documentation was updated to include the new guides.
  • Loading branch information
qianlifeng committed May 27, 2024
1 parent 262f3c9 commit 1d81ea2
Show file tree
Hide file tree
Showing 5 changed files with 110 additions and 5 deletions.
22 changes: 20 additions & 2 deletions docs/_sidebar.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,20 @@
* [Home](/)
* [Plugin](Plugin.md)
- Getting started

- [Install](install.md)

- Introduction

- [Query Hotkeys](query_hotkeys.md)
- [Query Shortcuts](query_shortcuts.md)

- Plugin

- [Plugin summary](plugin_summary.md)
- [Plugin store](deploy.md)
- [Write plugin](vue.md)
- [Submit plugin](helpers.md)

- Theme
- [Install Theme](theme.md)

- [Github](https://github.com/Wox-launcher/Wox)
6 changes: 3 additions & 3 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,12 @@
<script>
window.$docsify = {
loadSidebar: true,
name: "Wox",
name: "Wox Launcher",
repo: "https://github.com/Wox-launcher/Wox",
plugins: [
EditOnGithubPlugin.create("https://github.com/Wox-launcher/Wox/tree/v2/Doc", null,
EditOnGithubPlugin.create("https://github.com/Wox-launcher/Wox/tree/v2/docs/", null,
function(file) {
return "edit on github"
return "✏️ edit on github"
})
]
}
Expand Down
36 changes: 36 additions & 0 deletions docs/install.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# Installation Guide

This document will guide you on how to install and run Wox on Windows, macOS, and Linux.

## Windows

1. Visit the [GitHub release page](https://github.com/Wox-launcher/Wox/releases) to download the latest installer.
2. Double-click the downloaded `.exe` file to start the installation.
3. Follow the prompts in the installation wizard to complete the installation.
4. After the installation is complete, click on the Wox icon in the Start menu or on the desktop to launch the program.

## MacOS

1. Visit the [GitHub release page](https://github.com/Wox-launcher/Wox/releases) to download the latest `.dmg` file. Please note, you should choose the correct file based on your
Mac's architecture (`arm64` or `amd64`).
2. Double-click the downloaded `.dmg` file to open the installer.
3. Drag the Wox icon to the Applications folder.
4. Find the Wox icon in the Applications folder or Launchpad, and click it to launch the program.

## Linux

1. Visit the [GitHub release page](https://github.com/Wox-launcher/Wox/releases) to download the latest executable file.
2. Open a terminal window and navigate to the directory where the downloaded file is located.
3. Run the following command to make the file executable:

```bash
chmod +x wox-linux-amd64-xxxx(based on your version)
```
4. Run the following command to start Wox:

```bash
./wox-linux-amd64-xxxx(based on your version)
```

Please note that the above installation steps may vary depending on your operating system version and configuration. If you encounter any issues during the installation, please
refer to the FAQ or submit feedback.
34 changes: 34 additions & 0 deletions docs/query_hotkeys.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
## What are Query Hotkeys?

Query hotkeys in Wox Launcher are a specific type of hotkeys that allow you to quickly perform a search for specific characters or strings. This can be done by assigning a query to
a hotkey. When this hotkey is pressed, Wox Launcher will automatically perform this query.

## How to Use Query Hotkeys

To use query hotkeys, you need to set them up in Wox Launcher. Here's how:

1. Open Wox Launcher and query `wox setting` and execute it.
2. Click on the Hotkey menu.
3. Navigate to the "Query Hotkeys".
4. Here, you can add, modify, or remove query hotkeys.

For example, if you frequently use the query `llm shell`, you can create a hotkey for it, such as `Ctrl+Shift+S`. After setting this up, whenever you press `Ctrl+Shift+S` in Wox
Launcher, it will automatically perform the `llm shell` query.

## Query Variables

Wox Launcher allows you to use variables in your queries. These variables can be used to represent specific pieces of information. Available query variables include:

- `{wox:selected_text}`: This variable represents the text currently selected by the user.
- `{wox:active_browser_url}`: This variable represents the URL of the currently active browser window.

To use a variable in a query, simply include it in the query string. Wox Launcher will automatically replace the variable with the corresponding information when the query is
performed.

## Silent Mode

Wox Launcher also supports a silent mode for queries. When silent mode is enabled, Wox Launcher will not display the search interface when a query is performed. Instead, if the
query returns exactly one result, it will directly execute that result. If the query returns more than one result or no results, the query will not be executed and no UI will be
displayed, but a notification will be shown to inform the user that the query failed.

To enable silent mode, go to the settings menu and toggle the "Silent" option.
17 changes: 17 additions & 0 deletions docs/query_shortcuts.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
## What are Query Shortcuts?

Query shortcuts in Wox Launcher are a feature that allows you to simplify your queries. This can be done by assigning a shortcut to a longer query.
When this shortcut is entered, Wox Launcher will automatically expand it to the full query and pass it to all plugins. However, this expansion is implicit and not visible to the
user. The user will still see the shortcut in the UI, but the plugins will receive the expanded query.

## How to Use Query Shortcuts

To use query shortcuts, you need to set them up in Wox Launcher. Here's how:

1. Open Wox Launcher and query `wox setting` and execute it.
2. Click on the General menu.
3. Navigate to the "Query Shortcuts".
4. Here, you can add, modify, or remove query shortcuts.

For example, if you frequently use the query `llm shell`, you can create a shortcut for it, such as `sh`. After setting this up, whenever you enter `sh` in Wox Launcher, it will
automatically expand it to `llm shell` and pass it to all plugins. However, in the UI, you will still see `sh`.

0 comments on commit 1d81ea2

Please sign in to comment.