diff --git a/website/docs/usage/index.mdx b/website/docs/usage/index.mdx index be5ad5bd4..da76e2dcd 100644 --- a/website/docs/usage/index.mdx +++ b/website/docs/usage/index.mdx @@ -259,25 +259,27 @@ source code and recompiling frequently. $ python setup.py develop ``` -#### Additional tooling +#### Visual Studio Code extension + + + +

The [spaCy VSCode Extension](https://github.com/explosion/spacy-vscode) provides additional tooling and features for working with spaCy's config files. Version 1.0.0 includes hover descriptions for registry functions, variables, and section names within the config as an installable extension. -##### 🚀 Quickstart - -**Step 1.** Install a supported version of Python on your system (`>=3.7`) -**Step 2.** Install the - [Python Extension for Visual Studio Code](https://code.visualstudio.com/docs/python/python-tutorial) -**Step 3.** Create a - [virtual python environment](https://docs.python.org/3/library/venv.html) -**Step 4.** Install all python requirements (`spaCy >= 3.4.0` & `pygls >= 1.0.0`) -**Step 5.** Install - [spaCy extension for Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=Explosion.spacy-extension) -**Step 6.** Select your python environment -**Step 7.** You are ready to work with `.cfg` files in spaCy! +1. Install a supported version of Python on your system (`>=3.7`) +2. Install the + [Python Extension for Visual Studio Code](https://code.visualstudio.com/docs/python/python-tutorial) +3. Create a + [virtual python environment](https://docs.python.org/3/library/venv.html) +4. Install all python requirements (`spaCy >= 3.4.0` & `pygls >= 1.0.0`) +5. Install + [spaCy extension for Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=Explosion.spacy-extension) +6. Select your python environment +7. You are ready to work with `.cfg` files in spaCy! ### Building an executable {id="executable"} diff --git a/website/public/images/spacy-extension-demo.gif b/website/public/images/spacy-extension-demo.gif new file mode 100644 index 000000000..a857bbe2d Binary files /dev/null and b/website/public/images/spacy-extension-demo.gif differ