[rbdr/api-notation.vscode] / vsc-extension-quickstart.md

# Welcome to your VS Code Extension

## What's in the folder

* This folder contains all of the files necessary for your extension.
* `package.json` - this is the manifest file in which you declare your language support and define the location of the grammar file that has been copied into your extension.
* `syntaxes/api-notation.tmLanguage` - this is the Text mate grammar file that is used for tokenization.
* `language-configuration.json` - this is the language configuration, defining the tokens that are used for comments and brackets.

## Get up and running straight away

* Make sure the language configuration settings in `language-configuration.json` are accurate.
* Press `F5` to open a new window with your extension loaded.
* Create a new file with a file name suffix matching your language.
* Verify that syntax highlighting works and that the language configuration settings are working.

## Make changes

* You can relaunch the extension from the debug toolbar after making changes to the files listed above.
* You can also reload (`Ctrl+R` or `Cmd+R` on Mac) the VS Code window with your extension to load your changes.

## Add more language features

* To add features such as intellisense, hovers and validators check out the VS Code extenders documentation at https://code.visualstudio.com/docs

## Install your extension

* To start using your extension with Visual Studio Code copy it into the `<user home>/.vscode/extensions` folder and restart Code.
* To share your extension with the world, read on https://code.visualstudio.com/docs about publishing an extension.
Commit	Line	Data
e6c2e653 BB	1	# Welcome to your VS Code Extension
	2
	3	## What's in the folder
	4
	5	* This folder contains all of the files necessary for your extension.
	6	* `package.json` - this is the manifest file in which you declare your language support and define the location of the grammar file that has been copied into your extension.
	7	* `syntaxes/api-notation.tmLanguage` - this is the Text mate grammar file that is used for tokenization.
	8	* `language-configuration.json` - this is the language configuration, defining the tokens that are used for comments and brackets.
	9
	10	## Get up and running straight away
	11
	12	* Make sure the language configuration settings in `language-configuration.json` are accurate.
	13	* Press `F5` to open a new window with your extension loaded.
	14	* Create a new file with a file name suffix matching your language.
	15	* Verify that syntax highlighting works and that the language configuration settings are working.
	16
	17	## Make changes
	18
	19	* You can relaunch the extension from the debug toolbar after making changes to the files listed above.
	20	* You can also reload (`Ctrl+R` or `Cmd+R` on Mac) the VS Code window with your extension to load your changes.
	21
	22	## Add more language features
	23
	24	* To add features such as intellisense, hovers and validators check out the VS Code extenders documentation at https://code.visualstudio.com/docs
	25
	26	## Install your extension
	27
	28	* To start using your extension with Visual Studio Code copy it into the `<user home>/.vscode/extensions` folder and restart Code.
	29	* To share your extension with the world, read on https://code.visualstudio.com/docs about publishing an extension.