mirror of
https://github.com/kiteco/vscode-plugin.git
synced 2024-08-17 20:00:43 +03:00
Moved user documentation to the top-level. Keep original readme as DEVELOPMENT.md
This commit is contained in:
parent
511f7ca55e
commit
25e03d9334
16
DEVELOPMENT.md
Normal file
16
DEVELOPMENT.md
Normal file
@ -0,0 +1,16 @@
|
||||
# Kite plugin for VSCode
|
||||
|
||||
To use this plugin you must [download and install the Kite Engine](https://kite.com).
|
||||
|
||||
### Installation
|
||||
|
||||
Download Kite from http://kite.com/. During the installation process, select
|
||||
"Visual Studio Code" in the list of editors and Kite will install this plugin
|
||||
for you.
|
||||
|
||||
### Debugging pointers
|
||||
|
||||
Open Visual Studio Code, navigate to this project directory, and change the
|
||||
launch target from `Launch Extension` to `Launch Tests`. Then, hit the green
|
||||
play triangle. Testing from the command line to come as soon as I can figure
|
||||
it out.
|
75
README.md
75
README.md
@ -1,16 +1,69 @@
|
||||
# Kite plugin for VSCode
|
||||
# Kite for Visual Studio Code
|
||||
|
||||
To use this plugin you must [download and install the Kite Engine](https://kite.com).
|
||||
This extension adds support for Kite in Visual Studio Code and adds the features:
|
||||
|
||||
### Installation
|
||||
- Completions
|
||||
- Function Signatures
|
||||
- Expanded Info
|
||||
- Goto Definition
|
||||
|
||||
Download Kite from http://kite.com/. During the installation process, select
|
||||
"Visual Studio Code" in the list of editors and Kite will install this plugin
|
||||
for you.
|
||||
## How to install this extension
|
||||
|
||||
### Debugging pointers
|
||||
This extension is automatically installed by Kite when you select Visual Studio Code in the list of plugins.
|
||||
|
||||
Open Visual Studio Code, navigate to this project directory, and change the
|
||||
launch target from `Launch Extension` to `Launch Tests`. Then, hit the green
|
||||
play triangle. Testing from the command line to come as soon as I can figure
|
||||
it out.
|
||||
### Startup
|
||||
|
||||
When starting VSCode with Kite for the first time, a brief tour about Kite will be displayed in the active pane.
|
||||
|
||||
![Kite Tour](./images/kite-tour.png)
|
||||
|
||||
This tour will only be displayed once. If you want to see it again on next startup you can activate the `kite.showTourOnStartup` setting.
|
||||
|
||||
### Status Bar
|
||||
|
||||
The Kite icon in the status bar displays the state of Kite for the current file. Clicking on the icon will open the status panel with additional information.
|
||||
|
||||
![kite status bar](./images/kite-status-bar.png)
|
||||
|
||||
The icon in the status bar can take three different colors:
|
||||
|
||||
- blue: The Kite Engine is available and functioning properly.<br/>![kite status ready](./images/kite-status-ready.png)
|
||||
- gray: There's either no open file or, if there's an active file, the file is either not supported or not whitelisted.<br/>![kite status not whitelisted](./images/kite-status-non-whitelisted.png)
|
||||
- red: Something went wrong when the plugin tried to contact the Kite service on your computer. Depending on the issue, the status panel can offer actions to solve the problem.<br/>![kite status not running](./images/kite-status-not-running.png)
|
||||
|
||||
### Quick Info
|
||||
|
||||
![kite hover](./images/kite-hover.png)
|
||||
|
||||
Hovering your mouse over a symbol will show you a popup with up to three links:
|
||||
|
||||
- `def` will open the file where this symbol is defined (this may not be available if Kite cannot find the definition)
|
||||
- `web` will open the symbol documentation page in your browser
|
||||
- `more` will open the [expand view](#expand-view) with additional documentation for this symbol
|
||||
|
||||
### Expanded View
|
||||
|
||||
The expanded view offers a more detailed view of a symbol. You can use the sidebar panel to browse the members of a module or a type, or to access curated examples, StackOverflow topics, and more.
|
||||
|
||||
![Kite Expand Panel](./images/kite-expand-panel.png)
|
||||
|
||||
### Active Search
|
||||
|
||||
Active search is available using the corresponding command from the command palette. It will open the search panel on the side.
|
||||
|
||||
Type a module, function or symbol name and browse the results in the panel.
|
||||
|
||||
![Kite Active Search](./images/kite-active-search.png)
|
||||
|
||||
### Commands
|
||||
|
||||
|Name|Description|
|
||||
|---|---|
|
||||
|`Kite Active Search`|Opens the active search panel on the side.|
|
||||
|
||||
### Settings
|
||||
|
||||
|Name|Description|
|
||||
|---|---|
|
||||
|`kite.showTourOnStartup`|Whether or not to show the Kite tour on startup or not.|
|
||||
|`kite.pollingInterval`|The interval at which the extension checks the status of the Kite connection (defaults to 5s).|
|
||||
|
@ -1,69 +0,0 @@
|
||||
# Kite for Visual Studio Code
|
||||
|
||||
This extension adds support for Kite in Visual Studio Code and adds the features:
|
||||
|
||||
- Completions
|
||||
- Function Signatures
|
||||
- Expanded Info
|
||||
- Goto Definition
|
||||
|
||||
## How to install this extension
|
||||
|
||||
This extension is automatically installed by Kite when you select Visual Studio Code in the list of plugins.
|
||||
|
||||
### Startup
|
||||
|
||||
When starting VSCode with Kite for the first time, a brief tour about Kite will be displayed in the active pane.
|
||||
|
||||
![Kite Tour](./images/kite-tour.png)
|
||||
|
||||
This tour will only be displayed once. If you want to see it again on next startup you can activate the `kite.showTourOnStartup` setting.
|
||||
|
||||
### Status Bar
|
||||
|
||||
The Kite icon in the status bar displays the state of Kite for the current file. Clicking on the icon will open the status panel with additional information.
|
||||
|
||||
![kite status bar](./images/kite-status-bar.png)
|
||||
|
||||
The icon in the status bar can take three different colors:
|
||||
|
||||
- blue: The Kite Engine is available and functioning properly.<br/>![kite status ready](./images/kite-status-ready.png)
|
||||
- gray: There's either no open file or, if there's an active file, the file is either not supported or not whitelisted.<br/>![kite status not whitelisted](./images/kite-status-non-whitelisted.png)
|
||||
- red: Something went wrong when the plugin tried to contact the Kite service on your computer. Depending on the issue, the status panel can offer actions to solve the problem.<br/>![kite status not running](./images/kite-status-not-running.png)
|
||||
|
||||
### Quick Info
|
||||
|
||||
![kite hover](./images/kite-hover.png)
|
||||
|
||||
Hovering your mouse over a symbol will show you a popup with up to three links:
|
||||
|
||||
- `def` will open the file where this symbol is defined (this may not be available if Kite cannot find the definition)
|
||||
- `web` will open the symbol documentation page in your browser
|
||||
- `more` will open the [expand view](#expand-view) with additional documentation for this symbol
|
||||
|
||||
### Expanded View
|
||||
|
||||
The expanded view offers a more detailed view of a symbol. You can use the sidebar panel to browse the members of a module or a type, or to access curated examples, StackOverflow topics, and more.
|
||||
|
||||
![Kite Expand Panel](./images/kite-expand-panel.png)
|
||||
|
||||
### Active Search
|
||||
|
||||
Active search is available using the corresponding command from the command palette. It will open the search panel on the side.
|
||||
|
||||
Type a module, function or symbol name and browse the results in the panel.
|
||||
|
||||
![Kite Active Search](./images/kite-active-search.png)
|
||||
|
||||
### Commands
|
||||
|
||||
|Name|Description|
|
||||
|---|---|
|
||||
|`Kite Active Search`|Opens the active search panel on the side.|
|
||||
|
||||
### Settings
|
||||
|
||||
|Name|Description|
|
||||
|---|---|
|
||||
|`kite.showTourOnStartup`|Whether or not to show the Kite tour on startup or not.|
|
||||
|`kite.pollingInterval`|The interval at which the extension checks the status of the Kite connection (defaults to 5s).|
|
Loading…
Reference in New Issue
Block a user