Files
vscode-extension-samples/custom-editor-sample/README.md
2020-04-03 14:55:20 -07:00

21 lines
727 B
Markdown

# Cat Customs - Custom Editor API Samples
Demonstrates using VS Code's [custom editor API](https://code.visualstudio.com/api/extension-guides/custom-editors):
- Cat Scratch — A text based custom editor for `.cscratch` files (which are just json files)
## VS Code API
### `vscode` module
- [`window.registerCustomEditorProvider`](https://code.visualstudio.com/api/references/vscode-api#window.registerCustomEditorProvider)
- [`CustomTextEditor`](https://code.visualstudio.com/api/references/vscode-api#CustomTextEditor)
## Running the example
- Open this example in VS Code 1.44+
- `npm install`
- `npm run watch` or `npm run compile`
- `F5` to start debugging
Open the example files from the `exampleFiles` directory.