Skip to content

Commit 9dca51f

Browse files
author
Greg Van Liew
committed
Fold install-extension content into extension-gallery and publish-extension
1 parent 86f7c25 commit 9dca51f

11 files changed

+54
-87
lines changed

CONTRIBUTING.md

+4-3
Original file line numberDiff line numberDiff line change
@@ -38,13 +38,14 @@ The content in this repository follows the organization of documentation at <htt
3838

3939
This repository contains the following folders:
4040

41+
* \setup
42+
* \introvideos
43+
* \getstarted
4144
* \editor
42-
* \customization
4345
* \languages
44-
* \runtimes
4546
* \extensions
4647
* \extensionAPI
47-
* \tools
48+
* \other
4849
* \supporting
4950

5051
Within these folders you'll find the Markdown files used for the content. Each of these folders also contains an \images folder that references the images (such as screenshots) used in the topics.

blogs/2016/07/29/extensions-roundup-git.md

+1-2
Original file line numberDiff line numberDiff line change
@@ -7,14 +7,13 @@ Date: 2016-08-02
77
ShortDescription: Extensions to super power your Git workflow.
88
Author: Wade Anderson
99
---
10-
1110
# Extensions Roundup - Fun with Git
1211

1312
August 2, 2016 by Wade Anderson, [@waderyan_](https://twitter.com/waderyan_)
1413

1514
The first extension I built for Visual Studio Code was called [Git Blame](https://marketplace.visualstudio.com/items?itemName=waderyan.gitblame). It lets you quickly see which developer most recently modified the currently selected line ("blame"). It was simple and effective. Since the time when I built this extension, there have been many more awesome Git extensions added to the VS Code [Marketplace](https://marketplace.visualstudio.com/VSCode). Here are some of my favorite.
1615

17-
> Tip: Install any of these extensions by clicking the Extensions View button, typing the name of the extension in the Search box, and clicking **Install**. See more instructions [here](https://code.visualstudio.com/docs/editor/extension-gallery#_browse-and-install-extensions-in-vs-code).
16+
> Tip: Install any of these extensions by clicking the Extensions View button, typing the name of the extension in the Search box, and clicking **Install**. See more instructions [here](https://code.visualstudio.com/docs/editor/extension-gallery.md#browse-and-install-extensions-in-vs-code).
1817
1918
## Annotator
2019

docs/editor/extension-gallery.md

+23-11
Original file line numberDiff line numberDiff line change
@@ -78,16 +78,6 @@ Alternatively, you can disable all extensions through the command line with the
7878
code --disable-extensions /path/to/workspace
7979
```
8080

81-
## Browse Extensions
82-
83-
Additionally, you can browse and search for VS Code extensions through the [VS Code Marketplace](https://marketplace.visualstudio.com/VSCode) site. Below is a sampling of the most popular extensions.
84-
85-
<div class="marketplace-extensions-top"></div>
86-
87-
You can review our handy **Featured**, **Most Popular**, and **Recently Added** extension lists and filter by **Category** (Debuggers, Languages, Linters, etc).
88-
89-
![marketplace-categories](images/extension-gallery/marketplace-categories.png)
90-
9181
## Command Line Extension Management
9282

9383
To make it easier to automate and configure VS Code, it is possible to list, install, and uninstall extensions from the [command line](/docs/editor/command-line.md). When identifying an extension, provide the full name of the form `publisher.extension`, for example `donjayamanne.python`.
@@ -101,6 +91,20 @@ code --uninstall-extension ms-vscode.csharp
10191
code --disable-extensions
10292
```
10393

94+
## Install from a VSIX
95+
96+
You can manually install a VS Code extension packaged in a `.vsix` file. Using the **Install from VSIX...** command in the Extensions View command drop-down, or the **Extensions: Install from VSIX...** command in the **Command Palette**, simply point to the `.vsix` file.
97+
98+
You can also install using the VS Code `--install-extension` command line switch providing the path to the `.vsix` file.
99+
100+
```
101+
code --install-extension myextension.vsix
102+
```
103+
104+
You may provide the `--install-extension` multiple times on the command line to install multiple extensions at once.
105+
106+
If you'd like to learn more about packaging and publishing extensions, see our [Publishing Extensions](/docs/extensions/publish-extension.md) topic in the Extension Authoring section.
107+
104108
## Workspace Recommended Extensions
105109

106110
Often you have a set of extensions that makes working with a particular workspace or programming language more productive and you'd like to share this list with your team or colleagues. You can create a recommended list of extensions for a workspace with the **Extensions: Configure Workspace Recommended Extensions** command. This creates a `extensions.json` file located in the workspace `.vscode` folder where you can list extensions.
@@ -154,7 +158,15 @@ For example, the [ESLint extension](https://marketplace.visualstudio.com/items?i
154158
https://dbaeumer.gallery.vsassets.io/_apis/public/gallery/publisher/dbaeumer/extension/vscode-eslint/0.10.18/assetbyname/Microsoft.VisualStudio.Services.VSIXPackage
155159
```
156160

157-
Once you've downloaded an extension, you can side load it by renaming the `.zip` filename extension to `.vsix` and then using the **Install from VSIX...** command in the Extensions View command dropdown. See [Installing Extensions](/docs/extensions/install-extension.md#install-a-packaged-extension-vsix) for more details.
161+
Once you've downloaded an extension, you can side load it by renaming the `.zip` filename extension to `.vsix` and then using the **Install from VSIX...** command in the Extensions View command drop-down.
162+
163+
**Q: Where are extensions installed?**
164+
165+
**A**: Extensions are installed in your extensions folders. Depending on your platform, the global location is in the following folders:
166+
167+
* **Windows** `%USERPROFILE%\.vscode\extensions`
168+
* **Mac** `~/.vscode/extensions`
169+
* **Linux** `~/.vscode/extensions`
158170

159171
**Q: Can VS Code read TextMate bundles directly?**
160172

docs/editor/userdefinedsnippets.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ The snippet syntax follows the [TextMate snippet syntax](https://manual.macromat
2121

2222
## Add Snippets from the Marketplace
2323

24-
Many [extensions](/docs/editor/extension-gallery.md) on the VS Code [Marketplace](https://marketplace.visualstudio.com/vscode) include snippets. If you find one you want to use, simply install it and restart VS Code and the new snippet will be available (see [here](/docs/editor/extension-gallery#_browse-and-install-extensions-in-vs-code) for more instructions on installing an extension).
24+
Many [extensions](/docs/editor/extension-gallery.md) on the VS Code [Marketplace](https://marketplace.visualstudio.com/vscode) include snippets. If you find one you want to use, simply install it and restart VS Code and the new snippet will be available (see [here](/docs/editor/extension-gallery.md#browse-and-install-extensions-in-vs-code) for more instructions on installing an extension).
2525

2626
Below are some popular extensions which include snippets in their language support:
2727

docs/extensions/example-word-count.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -273,7 +273,7 @@ Events are another example where `onDid*` event subscriber methods return a Disp
273273

274274
## Installing your Extension Locally
275275

276-
So far, the extension you have written only runs in a special instance of VS Code, the Extension Development Host instance. To make your extension available to all VS Code instances, copy the extension folder contents to a new folder under [your `.vscode/extensions` folder](/docs/extensions/install-extension.md#your-extensions-folder).
276+
So far, the extension you have written only runs in a special instance of VS Code, the Extension Development Host instance. To make your extension available to all VS Code instances, copy the extension folder contents to a new folder under [your `.vscode/extensions` folder](/docs/extensions/yocode.md#your-extensions-folder).
277277

278278
## Publishing your Extension
279279

docs/extensions/install-extension.md

-52
This file was deleted.

docs/extensions/overview.md

+5-7
Original file line numberDiff line numberDiff line change
@@ -64,18 +64,16 @@ You can have a great editing experience for your programming language with simpl
6464

6565
## Writing an Extension
6666

67-
Extensions can be written in either TypeScript or JavaScript. VS Code offers a first class extension development experience where you can [develop, build, run, test and debug](/docs/extensions/debugging-extensions.md) all from within VS Code itself.
68-
69-
## Install and Share
67+
There is a Yeoman [extension generator](/docs/extensions/yocode.md) which makes it very easy to create simple extension projects. These are great for starting out and you can also find existing extension [examples](/docs/extensions/samples.md).
7068

71-
Once you have a working extension, you can [install it or share it with others](/docs/extensions/install-extension.md). We support local installation, private sharing, or publishing to the public [Extension Marketplace](/docs/editor/extension-gallery.md).
69+
Extensions can be written in either TypeScript or JavaScript. VS Code offers a first class extension development experience where you can [develop, build, run, test and debug](/docs/extensions/debugging-extensions.md) all from within VS Code itself.
7270

7371
## Testing Extensions
7472

7573
We also have great support for [writing and running tests](/docs/extensions/testing-extensions.md) for your extension. You can easily create integration tests which call the VS Code APIs and test your code in a running VS Code instance.
7674

7775
## Next Steps
7876

79-
* [Your First Extension](/docs/extensions/example-hello-world.md) - Try creating a simple Hello World extension
80-
* [Extension API](/docs/extensionAPI/overview.md) - Learn about the VS Code extensibility APIs
81-
* [Samples](/docs/extensions/samples.md) - A list of extension samples you can review and build
77+
* [Your First Extension](/docs/extensions/example-hello-world.md) - Try creating a simple Hello World extension.
78+
* [Extension API](/docs/extensionAPI/overview.md) - Learn about the VS Code extensibility APIs.
79+
* [Extension Examples](/docs/extensions/samples.md) - A list of extension samples you can review and build.

docs/extensions/publish-extension.md

+6-2
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,11 @@ You may want to simply package extensions without publishing them to the store.
113113
vsce package
114114
```
115115

116-
This will package your extension into a `.vsix` file and place it in the current directory. It's possible to install `.vsix` files into Visual Studio Code. See [Installing Extensions](/docs/extensions/install-extension.md) for more details.
116+
This will package your extension into a `.vsix` file and place it in the current directory. It's possible to install `.vsix` files into Visual Studio Code. See [Install from a VSIX](/docs/editor/extension-gallery.md#install-from-a-vsix) for more details.
117+
118+
### Sharing Privately with Others
119+
120+
If you want to share your extension with others privately, you can simply send them your packaged extension `.vsix` file.
117121

118122
## Visual Studio Code Compatiblity
119123

@@ -192,7 +196,7 @@ This will always invoke the [TypeScript](http://www.typescriptlang.org/) compile
192196
## Next Steps
193197

194198
* [Extension Marketplace](/docs/editor/extension-gallery.md) - Learn more about VS Code's public extension Marketplace.
195-
* [Installing Extensions](/docs/extensions/install-extension.md) - Learn about other options for installing and sharing extensions.
199+
* [Testing Extensions](/docs/extensions/testing-extensions.md) - Add tests to your extension project to ensure high quality.
196200

197201
## Common Questions
198202

docs/extensions/themes-snippets-colorizers.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ You can also add new TextMate theme files (.tmTheme) to your VS Code installatio
1919

2020
![yo code theme](images/themes/yocodetheme.png)
2121

22-
Copy the generated theme folder to a new folder under [your `.vscode/extensions` folder](/docs/extensions/install-extension.md#your-extensions-folder) and restart VS Code.
22+
Copy the generated theme folder to a new folder under [your `.vscode/extensions` folder](/docs/extensions/yocode.md#your-extensions-folder) and restart VS Code.
2323

2424
Open the Color Theme picker theme with **File** > **Preferences** > **Color Theme** and you can see your theme in the dropdown. Arrow up and down to see a live preview of your theme.
2525

@@ -213,7 +213,7 @@ The final generator output has two files: an extension manifest `package.json` w
213213
└── package.json // extension's manifest
214214
```
215215
216-
Copy the generated snippets folder to a new folder under [your `.vscode/extensions` folder](/docs/extensions/install-extension.md#your-extensions-folder) and restart VS Code.
216+
Copy the generated snippets folder to a new folder under [your `.vscode/extensions` folder](/docs/extensions/yocode.md#your-extensions-folder) and restart VS Code.
217217
218218
## Sharing Your Snippets in the Marketplace
219219
@@ -306,7 +306,7 @@ For more details check out the [languages contribution point documentation](/doc
306306
307307
The generated `vsc-extension-quickstart.md` file also contains more information on how to run and debug your extension.
308308
309-
To use your extension in your stable VS Code installation, copy the complete output folder to a new folder under [your `.vscode/extensions` folder](/docs/extensions/install-extension.md#your-extensions-folder) and restart VS Code. When you restart VS Code, your new language will be visible in the language specifier drop-down and you'll get full colorization and bracket/tag matching for files matching the language's file extension.
309+
To use your extension in your stable VS Code installation, copy the complete output folder to a new folder under [your `.vscode/extensions` folder](/docs/extensions/yocode.md#your-extensions-folder) and restart VS Code. When you restart VS Code, your new language will be visible in the language specifier drop-down and you'll get full colorization and bracket/tag matching for files matching the language's file extension.
310310
311311
![select ant language](images/themes-snippets-colorizers/antlanguage.png)
312312

docs/extensions/yocode.md

+10-4
Original file line numberDiff line numberDiff line change
@@ -82,14 +82,20 @@ Creates an extension that contributes new code snippets.
8282

8383
Once created, open VS Code on the created folder and run the extension to test the snippets. Check out `vsc-extension-quickstart.md` for the next steps.
8484

85-
## Loading an Extension
85+
## Your extensions folder
8686

87-
To load an extension, you need to copy the files to your VS Code extensions folder. We cover this in detail here: [Installing Extensions](/docs/extensions/install-extension.md#your-extensions-folder).
87+
To load an extension, you need to copy the files to your VS Code extensions folder `.vscode/extensions`. Depending on your platform it is located in the following folders:
88+
89+
* **Windows** `%USERPROFILE%\.vscode\extensions`
90+
* **Mac** `~/.vscode/extensions`
91+
* **Linux** `~/.vscode/extensions`
92+
93+
If you want to load your extension each time VS Code runs, copy your project ('side loading') to a new folder under `.vscode/extensions`. For example: `~/.vscode/extensions/myextension`.
8894

8995
## Next Steps
9096

91-
* [Publishing Tool](/docs/extensions/publish-extension.md) - Learn how to publish your extensions to the VS Code Marketplace
92-
* [Hello World](/docs/extensions/example-hello-world.md) - Try the 'Hello World' walkthrough to build your first extension
97+
* [Publishing Tool](/docs/extensions/publish-extension.md) - Learn how to publish your extensions to the VS Code Marketplace.
98+
* [Hello World](/docs/extensions/example-hello-world.md) - Try the 'Hello World' walkthrough to build your first extension.
9399

94100
## Common Questions
95101

scripts/gulpfile.docs.js

-1
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,6 @@ var areas = {
3232
nodejs: new Area('Node.js / JavaScript', 'nodejs', true),
3333
extensions: new Area('Extension Authoring', 'extensions', true),
3434
extensionapi: new Area('Extensibility Reference', 'extensionAPI', true),
35-
tools: new Area('Tools', 'tools', true),
3635
supporting: new Area('Supporting', 'supporting', false),
3736
other: new Area('Other', 'other', true)
3837
};

0 commit comments

Comments
 (0)