Skip to content

Commit 2ae4040

Browse files
authored
Merge pull request github#28136 from github/configuring-articles
Configuring articles in Copilot doc set
2 parents a388b56 + c1ab9a0 commit 2ae4040

18 files changed

+275
-16
lines changed
65.2 KB
Loading
11.8 KB
Loading
11.3 KB
Loading
26.6 KB
Loading
50.2 KB
Loading
11 KB
Loading
6.65 KB
Loading
52.1 KB
Loading
Lines changed: 80 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,83 @@
11
---
22
title: Configuring GitHub Copilot in a JetBrains IDE
3-
intro: 'ADD INTRO.'
4-
versions:
5-
feature: 'copilot'
6-
topics:
3+
intro: 'You can enable, configure, and disable {% data variables.product.prodname_copilot %} in a JetBrains IDE.'
4+
product: '{% data reusables.gated-features.copilot %}'
5+
topics:
76
- Copilot
8-
---
7+
versions:
8+
feature: 'copilot'
9+
shortTitle: JetBrains
10+
---
11+
12+
## About {% data variables.product.prodname_copilot %} in JetBrains IDEs
13+
14+
If you use a Jetbrains IDE, {% data variables.product.prodname_copilot %} can autocomplete code as you type. After installation, you can enable or disable {% data variables.product.prodname_copilot %}, and you can configure advanced settings within your IDE or on {% data variables.product.prodname_dotcom_the_website %}.
15+
16+
## Prerequisites
17+
18+
To configure {% data variables.product.prodname_copilot %} in a JetBrains IDE, you must install the {% data variables.product.prodname_copilot %} plugin. For more information, see "[Getting started with {% data variables.product.prodname_copilot %} in a JetBrains IDE](/copilot/getting-started-with-github-copilot/getting-started-with-github-copilot-in-a-jetbrains-ide)."
19+
20+
## Keyboard shortcuts for {% data variables.product.prodname_copilot %}
21+
22+
You can use the default keyboard shortcuts for inline suggestions in your JetBrains IDE when using {% data variables.product.prodname_copilot %}. Alternatively, you can rebind the shortcuts to your preferred keyboard shortcuts for each specific command. For more information on rebinding keyboard shortcuts in your JetBrains IDE, see the JetBrains documentation. For example, you can view the [IntelliJ IDEA](https://www.jetbrains.com/help/idea/mastering-keyboard-shortcuts.html#choose-keymap) documentation.
23+
24+
{% mac %}
25+
26+
| Action | Shortcut |
27+
|:---|:---|
28+
|Accept an inline suggestion|<kbd>Tab</kbd>|
29+
|Dismiss an inline suggestion|<kbd>Esc</kbd>|
30+
|Show next inline suggestion|<kbd>Option (⌥) or Alt</kbd>+<kbd>]</kbd>|
31+
|Show previous inline suggestion|<kbd>Option (⌥) or Alt</kbd>+<kbd>[</kbd>|
32+
|Trigger inline suggestion|<kbd>Option (⌥)</kbd>+<kbd>\</kbd>|
33+
|Open {% data variables.product.prodname_copilot %} (additional suggestions in separate pane)|<kbd>Option (⌥) or Alt</kbd>+<kbd>Return</kbd> |
34+
35+
{% endmac %}
36+
37+
{% windows %}
38+
39+
| Action | Shortcut |
40+
|:---|:---|
41+
|Accept an inline suggestion|<kbd>Tab</kbd>|
42+
|Dismiss an inline suggestion|<kbd>Esc</kbd>|
43+
|Show next inline suggestion|<kbd>Alt</kbd>+<kbd>]</kbd>|
44+
|Show previous inline suggestion|<kbd>Alt</kbd>+<kbd>[</kbd>|
45+
|Trigger inline suggestion|<kbd>Alt</kbd>+<kbd>\</kbd>|
46+
|Open {% data variables.product.prodname_copilot %} (additional suggestions in separate pane)|<kbd>Alt</kbd>+<kbd>Enter</kbd> |
47+
48+
{% endwindows %}
49+
50+
{% linux %}
51+
52+
| Action | Shortcut |
53+
|:---|:---|
54+
|Accept an inline suggestion|<kbd>Tab</kbd>|
55+
|Dismiss an inline suggestion|<kbd>Esc</kbd>|
56+
|Show next inline suggestion|<kbd>Alt</kbd>+<kbd>]</kbd>|
57+
|Show previous inline suggestion|<kbd>Alt</kbd>+<kbd>[</kbd>|
58+
|Trigger inline suggestion|<kbd>Alt</kbd>+<kbd>\</kbd>|
59+
|Open {% data variables.product.prodname_copilot %} (additional suggestions in separate pane)|<kbd>Alt</kbd>+<kbd>Enter</kbd> |
60+
61+
{% endlinux %}
62+
63+
## Enabling or disabling {% data variables.product.prodname_copilot %}
64+
65+
You can enable or disable {% data variables.product.prodname_copilot %} from within your JetBrains IDE. The {% data variables.product.prodname_copilot %} status icon in the bottom panel of the JetBrains window indicates whether {% data variables.product.prodname_copilot %} is enabled or disabled. When enabled, the icon is highlighted. When disabled, the icon is grayed out.
66+
67+
1. To enable or disable {% data variables.product.prodname_copilot %}, click the status icon in the bottom panel of the JetBrains window.
68+
![Status icon in JetBrains](/assets/images/help/copilot/status-icon-jetbrains.png)
69+
2. If you are disabling {% data variables.product.prodname_copilot %}, you will be asked whether you want to disable it globally, or for the language of the file you are currently editing. To disable globally, click **Disable Completions**. Alternatively, click the language-specific button to disable {% data variables.product.prodname_copilot %} for the specified language.
70+
![Disable {% data variables.product.prodname_copilot %} globally or for the current language](/assets/images/help/copilot/disable-copilot-global-or-langugage-jetbrains.png)
71+
72+
## Configuring advanced settings for {% data variables.product.prodname_copilot %}
73+
74+
You can manage advanced settings for {% data variables.product.prodname_copilot %} in your JetBrains IDE, such as how your IDE displays code completions, and which languages you want to enable or disable for {% data variables.product.prodname_copilot %}.
75+
76+
1. In your JetBrains IDE, click the **File** menu, then click **Settings**.
77+
1. Under **Languages & Frameworks**, click **{% data variables.product.prodname_copilot %}**.
78+
1. Edit the settings according to your personal preferences.
79+
- To adjust the behaviour and appearance of code suggestions, and whether to automatically check for updates, select or deselect the corresponding checkboxes.
80+
- If you have selected to receive automatic updates, you can choose whether to receive stable, but less frequent updates, or nightly updates, which may be less stable. Click the **Update channel** dropdown and select **Stable** for stable updates, or **Nightly** for nightly updates.
81+
- Under "Disabled languages", use the checkboxes to select or deselect the languages you want to disable {% data variables.product.prodname_copilot %} for.
82+
83+
{% data reusables.copilot.dotcom-settings %}
Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,19 @@
11
---
2-
title: Configuring GitHub Copilot in NeoVim
3-
intro: 'ADD INTRO.'
2+
title: Configuring GitHub Copilot in Neovim
3+
intro: 'You can enable, configure, and disable {% data variables.product.prodname_copilot %} in Neovim.'
4+
product: '{% data reusables.gated-features.copilot %}'
45
versions:
56
feature: 'copilot'
67
topics:
78
- Copilot
8-
---
9+
shortTitle: Neovim
10+
---
11+
12+
## Configuring {% data variables.product.prodname_copilot %} in Neovim
13+
14+
For guidance on configuring {% data variables.product.prodname_copilot %} in Neovim, invoke the {% data variables.product.prodname_copilot %} documentation in Neovim by running the following command.
15+
16+
17+
:help copilot
18+
19+
{% data reusables.copilot.dotcom-settings %}

0 commit comments

Comments
 (0)