Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions docs/_static/css/lousd_custom.css
Original file line number Diff line number Diff line change
Expand Up @@ -112,6 +112,12 @@ html[data-theme="dark"] .home-header > h1 {
text-align: center;
}

/* Disable dark-mode dimming on content screenshots */
html[data-theme="dark"] .bd-content img,
html[data-theme="dark"] article img,
html[data-theme="dark"] main img {
filter: none !important;
opacity: 1 !important;
/***********
* CODE HIGHLIGHTS (Sphinx / Pygments)
************/
Expand Down
3 changes: 3 additions & 0 deletions docs/images/install-usda-syntax/marketplace-search-usd.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions docs/images/install-usda-syntax/usda-file-hover-link.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,7 @@ asset-modularity-instancing/index
Glossary <glossary>
Interactive Glossary <interactive-glossary>
usdview-install-instructions
install-usda-syntax
jupyter-notebook-setup
Certification Study Guide <https://nvdam.widen.net/s/6kxsqcsrrw/ncp-openusd-development-study-guide>
:::
Expand Down
43 changes: 43 additions & 0 deletions docs/install-usda-syntax.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
# Installing USDA syntax highlighting in Visual Studio Code

Many Learn OpenUSD exercises include USD ASCII (`.usda`) and generic USD (`.usd`) files. Installing a language extension in Visual Studio Code gives you syntax highlighting, clearer structure when you read layers, and helpful navigation on asset paths and references.

The steps below use **Visual Studio Code**. The same workflow applies in **Cursor** and other editors built on VS Code, including the Extensions view and marketplace.

## Install the USD Language extension

1. Open Visual Studio Code.

2. Open the **Extensions** view by clicking the Extensions icon in the **Activity Bar** on the left.

![](./images/install-usda-syntax/vscode-extensions-activity-bar.png)

3. In the Extensions search box, type **USD**.

4. In the results, find **USD Language** published by **Animal Logic** (Pixar USD language support). Select it, then click **Install**. You can install from the list or open the full marketplace page and use **Install** there.

![](./images/install-usda-syntax/marketplace-search-usd.png)

![](./images/install-usda-syntax/usd-language-extension-install.png)

5. When installation finishes, you can leave the extension’s default settings as they are for typical Learn OpenUSD work.

```{note}
To install from a terminal instead, use VS Code’s CLI (if `code` is on your `PATH`): `code --install-extension animallogic.vscode-usda-syntax`. The extension identifier in the marketplace is **animallogic.vscode-usda-syntax**.
```

## Verify highlighting and navigation

1. Open your **Learn OpenUSD** workspace folder in the editor (**File > Open Folder**).

2. Open any `.usd` or `.usda` exercise file, for example, under `docs/exercise_content/`.

3. Confirm the **language mode** in the status bar (lower right) shows **USD** when the file is active. You should see keyword and type coloring similar to the screenshots below.

4. Optionally, hover a quoted asset path (for example after `references` ) or a scene path. The extension can show a resolved path and hints such as **Follow link** with **Ctrl+click** (Windows or Linux) or **Cmd+click** (macOS) to open the target file.

![](./images/install-usda-syntax/usda-file-hover-link.png)

![](./images/install-usda-syntax/usda-syntax-highlighting-result.png)

You are set up to browse USDA layers with highlighting and basic navigation support alongside the rest of the curriculum.
1 change: 1 addition & 0 deletions src/lousd/workshop_prep.py
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,7 @@
# Individual files to remove
FILES_TO_REMOVE = [
"usdview-install-instructions.md",
"install-usda-syntax.md",
]

# Base URL for external links to removed content
Expand Down
Loading