Skip to content

Commit 86f7c25

Browse files
author
Greg Van Liew
committed
Refactor Tools node content
1 parent e06658f commit 86f7c25

29 files changed

+226
-253
lines changed

blogs/2017/03/07/extension-pack-roundup.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Creating a theme for this blog is a natural fit for a relatively new part of the
1919
2020
## How do I make an Extension Pack?
2121

22-
It is very easy to make your own Extension Pack. Follow the instructions on installing the Yeoman VS Code [extension generator](https://code.visualstudio.com/docs/tools/yocode).
22+
It is very easy to make your own Extension Pack. Follow the instructions on installing the Yeoman VS Code [extension generator](https://code.visualstudio.com/docs/extensions/yocode).
2323

2424
Once the Yeoman generator is installed, run the following command:
2525

docs/editor/extension-gallery.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -131,8 +131,8 @@ VS Code prompts a user to install the recommended extensions when a workspace is
131131

132132
Here are a few topics you may find interesting...
133133

134-
* [Publishing to the Marketplace](/docs/tools/vscecli.md) - Publish your own customization or extension to the VS Code Marketplace
135-
* [Yo Code](/docs/tools/yocode.md) - Learn how the Yo Code extension generator can scaffold out new extensions and package existing TextMate files.
134+
* [Publishing to the Marketplace](/docs/extensions/publish-extension.md) - Publish your own customization or extension to the VS Code Marketplace
135+
* [Extension Generator](/docs/extensions/yocode.md) - Learn how the Yo Code extension generator can scaffold out new extensions and package existing TextMate files.
136136
* [Extending Visual Studio Code](/docs/extensions/overview.md) - Start learning about VS Code extensibility
137137
* [Your First Extension](/docs/extensions/example-hello-world.md) - Try creating a simple Hello World extension
138138

@@ -158,7 +158,7 @@ Once you've downloaded an extension, you can side load it by renaming the `.zip`
158158

159159
**Q: Can VS Code read TextMate bundles directly?**
160160

161-
**A**: No, VS Code can read some TextMate files such as .tmTheme and .tmLanguage but can not install full TextMate bundles. Also in order to use TextMate theme and syntax files, VS Code needs extra metadata for integration. The [Yo Code](/docs/tools/yocode.md) extension generator makes it easy to package these files for use in VS Code. See the [Themes, Snippets, and Colorizers](/docs/extensions/themes-snippets-colorizers.md) topic in the Extension Authoring section for details.
161+
**A**: No, VS Code can read some TextMate files such as .tmTheme and .tmLanguage but can not install full TextMate bundles. Also in order to use TextMate theme and syntax files, VS Code needs extra metadata for integration. The [Yo Code](/docs/extensions/yocode.md) extension generator makes it easy to package these files for use in VS Code. See the [Themes, Snippets, and Colorizers](/docs/extensions/themes-snippets-colorizers.md) topic in the Extension Authoring section for details.
162162

163163
**Q: Can I install Visual Studio Community extensions (shipped in .vsix) in Visual Studio Code?**
164164

docs/extensionAPI/extension-manifest.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Name | Required | Type | Details
1717
---- |:--------:| ---- | -------
1818
`name` | Y | `string` | The name of the extension - should be all lowercase with no spaces.
1919
`version` | Y | `string` | [SemVer](http://semver.org/) compatible version.
20-
`publisher` | Y | `string` | The [publisher name](/docs/tools/vscecli.md#publishers-and-personal-access-tokens)
20+
`publisher` | Y | `string` | The [publisher name](/docs/extensions/publish-extension.md#publishers-and-personal-access-tokens)
2121
`engines` | Y | `object` | An object containing at least the `vscode` key matching the versions of VS Code that the extension is compatible with. Cannot be `*`. For example: `^0.10.5` indicates compatibility with a minimum VS Code version of `0.10.5`.
2222
`license` | | `string` | Refer to [npm's documentation](https://docs.npmjs.com/files/package.json#license). If you do have a `LICENSE` file in the root of your extension, the value for `license` should be `"SEE LICENSE IN <filename>"`.
2323
`displayName` | | `string`| The display name for the extension used in the Marketplace.
@@ -34,7 +34,7 @@ Name | Required | Type | Details
3434
`dependencies` | | `object` | Any runtime Node.js dependencies your extensions needs. Exactly the same as [npm's `dependencies`](https://docs.npmjs.com/files/package.json#dependencies).
3535
`devDependencies` | | `object` | Any development Node.js dependencies your extension needs. Exactly the same as [npm's `devDependencies`](https://docs.npmjs.com/files/package.json#devdependencies).
3636
`extensionDependencies` | | `array` | An array with the ids of extensions that this extension depends on. These other extensions will be installed when the primary extension is installed. The id of an extension is always `${publisher}.${name}`. For example: `vscode.csharp`.
37-
`scripts` | | `object` | Exactly the same as [npm's `scripts`](https://docs.npmjs.com/misc/scripts) but with [extra VS Code specific fields](/docs/tools/vscecli.md#pre-publish-step).
37+
`scripts` | | `object` | Exactly the same as [npm's `scripts`](https://docs.npmjs.com/misc/scripts) but with [extra VS Code specific fields](/docs/extensions/publish-extension.md#pre-publish-step).
3838
`icon` | | `string` | The path to a 128x128 pixel icon.
3939

4040
Also check [npm's `package.json` reference](https://docs.npmjs.com/files/package.json).

docs/extensionAPI/extension-points.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -355,7 +355,7 @@ Contribute a TextMate grammar to a language. You must provide the `language` thi
355355
}
356356
```
357357

358-
See [Adding Language Colorization](/docs/extensions/themes-snippets-colorizers.md) for instructions on using the [yo code extension generator](/docs/tools/yocode.md) to quickly package TextMate .tmLanguage files as VS Code extensions.
358+
See [Adding Language Colorization](/docs/extensions/themes-snippets-colorizers.md) for instructions on using the [yo code extension generator](/docs/extensions/yocode.md) to quickly package TextMate .tmLanguage files as VS Code extensions.
359359

360360
![grammars extension point example](images/extension-points/grammars.png)
361361

@@ -377,7 +377,7 @@ Contribute a TextMate theme to VS Code. You must specify a label, whether the th
377377

378378
![themes extension point example](images/extension-points/themes.png)
379379

380-
See [Changing the Color Theme](/docs/extensions/themes-snippets-colorizers.md) for instructions on using the [yo code extension generator](/docs/tools/yocode.md) to quickly package TextMate .tmTheme files as VS Code extensions.
380+
See [Changing the Color Theme](/docs/extensions/themes-snippets-colorizers.md) for instructions on using the [yo code extension generator](/docs/extensions/yocode.md) to quickly package TextMate .tmTheme files as VS Code extensions.
381381

382382
## contributes.snippets
383383

docs/extensionAPI/overview.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ MetaDescription: Learn the details of Visual Studio Code's rich extensibility (p
1212

1313
This section of our documentation goes into detail on the various features of VS Code extensibility. It's worth reviewing the introduction on the [extensions](/docs/extensions/overview.md) as well as going through the ['Hello World'](/docs/extensions/example-hello-world.md) example before digging in too deeply here.
1414

15-
The easiest way to see VS Code extensions in action is via the [Extension Marketplace](/docs/editor/extension-gallery.md). Once you have built your first extension, it can be [published](/docs/tools/vscecli.md) for others to install.
15+
The easiest way to see VS Code extensions in action is via the [Extension Marketplace](/docs/editor/extension-gallery.md). Once you have built your first extension, it can be [published](/docs/extensions/publish-extension.md) for others to install.
1616

1717
## The Extensibility Reference Documents
1818

docs/extensionAPI/patterns-and-principles.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@ Your extension can depend on [Node.js](https://nodejs.org) modules at runtime. S
107107

108108
Visual Studio Code **will not** install your extension's dependencies when a user installs it, so you must `npm install` before publishing. The extension's publishing package will contain all of its dependencies within. You can run `vsce ls` to list all the files that `vsce` will include in the package.
109109

110-
You can create a `.vscodeignore` file to exclude some files from being included in your extension's package. See the `vsce` publishing tool topic for [details](https://code.visualstudio.com/docs/tools/vscecli.md#vscodeignore) about using a `.vscodeignore` file.
110+
You can create a `.vscodeignore` file to exclude some files from being included in your extension's package. See the `vsce` publishing tool topic for [details](https://code.visualstudio.com/docs/extensions/publish-extension.md#vscodeignore) about using a `.vscodeignore` file.
111111

112112
## Next Steps
113113

docs/extensions/debugging-extensions.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
Order: 8
2+
Order: 9
33
Area: extensions
44
TOCTitle: Running and Debugging Extensions
55
ContentId: 44569A0C-7196-48E6-A5EE-FC5AAAAD32F3
@@ -20,7 +20,7 @@ You can use VS Code to develop an extension for VS Code and VS Code provides sev
2020

2121
## Creating an Extension
2222

23-
We suggest you start your extension by scaffolding out the basic files. You can use the `yo code` Yeoman generator to do this and we cover the details in the [Yo Code document](/docs/tools/yocode.md). The generator will ensure everything is set up so you have a great development experience.
23+
We suggest you start your extension by scaffolding out the basic files. You can use the `yo code` Yeoman generator to do this and we cover the details in the [extension generator](/docs/extensions/yocode.md) topic. The generator will ensure everything is set up so you have a great development experience.
2424

2525
## Running and Debugging your Extension
2626

@@ -77,7 +77,7 @@ your changes. You have two options to do this:
7777
## Next Steps
7878

7979
* [Testing your Extension](/docs/extensions/testing-extensions.md) - Learn how to write unit and integration tests for your extension
80-
* [Publishing Tool](/docs/tools/vscecli.md) - Publish your extension with the vsce command line tool.
80+
* [Publishing Tool](/docs/extensions/publish-extension.md) - Publish your extension with the vsce command line tool.
8181
* [Extension Manifest file](/docs/extensionAPI/extension-manifest.md) - VS Code extension manifest file reference
8282
* [Extension API](/docs/extensionAPI/overview.md) - Learn about the VS Code extensibility APIs
8383

docs/extensions/example-debuggers.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
Order: 5
2+
Order: 6
33
Area: extensions
44
TOCTitle: Example-Debuggers
55
ContentId: 49EF49AD-8BE6-4D46-ADC8-D678BDC04E85
@@ -314,4 +314,4 @@ The variable can now be used in any string typed value of a launch configuration
314314
Once you have created your debug adapter you can publish it to the Marketplace:
315315

316316
* update the attributes in the `package.json` to reflect the naming and purpose of your debug adapter.
317-
* upload to the Marketplace as described in [Share an Extension](/docs/tools/vscecli.md) section.
317+
* upload to the Marketplace as described in [Share an Extension](/docs/extensions/publish-extension.md) section.

docs/extensions/example-hello-world.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
Order: 2
2+
Order: 3
33
Area: extensions
44
TOCTitle: Example-Hello World
55
ContentId: DC915D6C-13D4-4022-9101-57C4A4118B07
@@ -23,7 +23,7 @@ You need [Node.js](https://nodejs.org/en/) installed and available in your `$PAT
2323

2424
The simplest way to add your own functionality to VS Code is through adding a command. A command registers a callback function which can be invoked from the **Command Palette** or with a key binding.
2525

26-
We have written a Yeoman generator to help get you started. Install Yeoman and the [Yeoman VS Code Extension generator](/docs/tools/yocode.md) and scaffold a new extension:
26+
We have written a Yeoman generator to help get you started. Install Yeoman and the [Yeoman VS Code Extension generator](/docs/extensions/yocode.md) and scaffold a new extension:
2727

2828
```sh
2929
npm install -g yo generator-code
@@ -181,7 +181,7 @@ export function activate(context: vscode.ExtensionContext) {
181181
* `.vscode/launch.json` defines launching VS Code in the Extension Development mode. It also points with `preLaunchTask` to a task defined in `.vscode/tasks.json` that runs the TypeScript compiler.
182182
* `.vscode/settings.json` by default excludes the `out` folder. You can modify which file types you want to hide.
183183
* `.gitignore` - Tells Git version control which patterns to ignore.
184-
* [`.vscodeignore`](/docs/tools/vscecli.md#advanced-usage) - Tells the packaging tool which files to ignore when publishing the extension.
184+
* [`.vscodeignore`](/docs/extensions/publish-extension.md#advanced-usage) - Tells the packaging tool which files to ignore when publishing the extension.
185185
* `README.md` - README file describing your extension for VS Code users.
186186
* `vsc-extension-quickstart.md` - A Quick Start guide for you.
187187
* `test/extension.test.ts` - you can put your extension unit tests in here and run your tests against the VS Code API (see [Testing Your Extension](/docs/extensions/testing-extensions.md))
@@ -246,7 +246,7 @@ So far, the extension you have written only runs in a special instance of VS Cod
246246

247247
## Publishing your Extension
248248

249-
Read about how to [Share an Extension](/docs/tools/vscecli.md).
249+
Read about how to [Share an Extension](/docs/extensions/publish-extension.md).
250250

251251
## Next Steps
252252

docs/extensions/example-language-server.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
Order: 4
2+
Order: 5
33
Area: extensions
44
TOCTitle: Example-Language Server
55
ContentId: A8CBE8D6-1FEE-47BF-B81E-D79FA0DB5D03

docs/extensions/example-word-count.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
Order: 3
2+
Order: 4
33
Area: extensions
44
TOCTitle: Example-Word Count
55
ContentId: 4D9132DC-CDDB-4E07-B2DD-9A7E168BE384
@@ -277,13 +277,13 @@ So far, the extension you have written only runs in a special instance of VS Cod
277277

278278
## Publishing your Extension
279279

280-
Read about how to [Share an Extension](/docs/tools/vscecli.md).
280+
Read about how to [Share an Extension](/docs/extensions/publish-extension.md).
281281

282282
## Next Steps
283283

284284
Read on to find out about:
285285

286-
* [Yo Code](/docs/tools/yocode.md) - learn about other options in Yo Code
287-
* [Extension API](/docs/extensionAPI/overview.md) - Get an overview of the Extension API
288-
* [Publishing Tool](/docs/tools/vscecli.md) - Learn how to publish an extension to the public Marketplace
289-
* [Editor API](/docs/extensionAPI/vscode-api.md#window) - Learn more about Text Documents, Text Editors and editing text
286+
* [Extension Generator](/docs/extensions/yocode.md) - Learn about other options in the Yo Code extension generator.
287+
* [Extension API](/docs/extensionAPI/overview.md) - Get an overview of the Extension API.
288+
* [Publishing Tool](/docs/extensions/publish-extension.md) - Learn how to publish an extension to the public Marketplace.
289+
* [Editor API](/docs/extensionAPI/vscode-api.md#window) - Learn more about Text Documents, Text Editors and editing text.
Loading
Loading
Loading

docs/extensions/install-extension.md

+3-4
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
Order: 10
2+
Order: 11
33
Area: extensions
44
TOCTitle: Installing Extensions
55
ContentId: 8D19F206-8CB3-498D-BDD1-317B4104EDD0
@@ -44,10 +44,9 @@ You can also install a `.vsix` with the **Install from VSIX...** command in the
4444

4545
### Sharing Privately with Others
4646

47-
If you want to share your extension or customization with others privately, you can simply send them a copy of the output from the generator and ask them to add it under their `.vscode/extensions` folder. Alternatively, package your extension using the [vsce publishing tool](/docs/tools/vscecli.md) by running `vsce package` and send them the `.vsix` file.
47+
If you want to share your extension or customization with others privately, you can simply send them a copy of the output from the generator and ask them to add it under their `.vscode/extensions` folder. Alternatively, package your extension using the [vsce publishing tool](/docs/extensions/publish-extension.md) by running `vsce package` and send them the `.vsix` file.
4848

4949
## Next Steps
5050

5151
* [Extension Marketplace](/docs/editor/extension-gallery.md) - Learn more about VS Code's public extension Marketplace.
52-
* [Publishing Extensions](/docs/extensions/publish-extension.md) - Put your extension on the Marketplace.
53-
* [Publishing Tool Reference](/docs/tools/vscecli.md) - Learn how to package and publish your extensions.
52+
* [Publishing Extensions](/docs/extensions/publish-extension.md) - Put your extension on the Marketplace.

docs/extensions/overview.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -78,4 +78,4 @@ We also have great support for [writing and running tests](/docs/extensions/test
7878

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

0 commit comments

Comments
 (0)