diff options
| author | Josh Spicer <joshspicer@github.com> | 2022-06-14 03:01:19 +0300 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-06-14 03:01:19 +0300 |
| commit | 2fa323248528604a3548fd1292c74c7b473c611b (patch) | |
| tree | 39831944b1ed879a3342310b6f2a107e48153aad /src/node | |
| parent | fac5e5a4540ffc79138b94ce8edfd329a209b250 (diff) | |
Devcontainer docs (#47)
* docs
* automatically generate documentation from features.json
* trigger doc gen
* 1
* no-ci
* no-ci
* no-ci
* no-ci
* comment out pull
* Automated documentation update
* no-ci markdown table
* Automated documentation update
* no-ci
* Automated documentation update
* branch to main
Co-authored-by: Devcontainers CI <vscr-feedback@microsoft.com>
Diffstat (limited to 'src/node')
| -rw-r--r-- | src/node/README.md | 29 |
1 files changed, 29 insertions, 0 deletions
diff --git a/src/node/README.md b/src/node/README.md new file mode 100644 index 0000000..45325f6 --- /dev/null +++ b/src/node/README.md @@ -0,0 +1,29 @@ + +# Node.js (via nvm) and yarn (node) + + + +## Example Usage + +```json +"features": [ + { + "id": "devcontainers/features/node@latest", + "options": { + "version": "latest" + } + } +] +``` + +## Options + +| Options Id | Description | Type | Default Value | +|-----|-----|-----|-----| +| version | Select or enter a Node.js version to install | string | lts | +| install_tools_for_node_gyp | Install dependencies to compile native node modules (node-gyp)? | boolean | true | +| nvm_install_path | The path where NVM will be installed. | string | /usr/local/share/nvm | + +--- + +_Note: This file was auto-generated from the [devcontainer-feature.json](./devcontainer-feature.json)._ |