Skip to content

Commit 5694d20

Browse files
Automated documentation update [skip ci] (#104)
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: Georg Lauterbach <44545919+georglauterbach@users.noreply.github.com>
1 parent ccf0dad commit 5694d20

File tree

5 files changed

+135
-0
lines changed

5 files changed

+135
-0
lines changed

src/hermes/README.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
2+
# hermes (hermes)
3+
4+
https://github.com/georglauterbach/hermes in a Development Container
5+
6+
## Example Usage
7+
8+
```json
9+
"features": {
10+
"ghcr.io/georglauterbach/dev-container-features/hermes:11": {}
11+
}
12+
```
13+
14+
## Options
15+
16+
| Options Id | Description | Type | Default Value |
17+
|-----|-----|-----|-----|
18+
| init.bashrc | Whether to add _hermes_ to the default Bash setup in `$[HOME}/.bashrc` | boolean | true |
19+
| init.bashrc-overwrite | When `hermes.init.bashrc` is `true`, whether to completely overwrite the file `${HOME}/.bashrc` to only run _hermes_ | boolean | true |
20+
21+
22+
23+
---
24+
25+
_Note: This file was auto-generated from the [devcontainer-feature.json](https://github.com/georglauterbach/dev-container-features/blob/main/src/hermes/devcontainer-feature.json). Add additional notes to a `NOTES.md`._

src/lang-bash/README.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
2+
# Programming Language | Bash (lang-bash)
3+
4+
Work efficiently and effortlessly with Bash
5+
6+
## Example Usage
7+
8+
```json
9+
"features": {
10+
"ghcr.io/georglauterbach/dev-container-features/lang-bash:0": {}
11+
}
12+
```
13+
14+
15+
16+
## Customizations
17+
18+
### VS Code Extensions
19+
20+
- `mads-hartmann.bash-ide-vscode`
21+
- `timonwong.shellcheck`
22+
23+
24+
25+
---
26+
27+
_Note: This file was auto-generated from the [devcontainer-feature.json](https://github.com/georglauterbach/dev-container-features/blob/main/src/lang-bash/devcontainer-feature.json). Add additional notes to a `NOTES.md`._

src/lang-rust/README.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
2+
# Programming Language | Rust (lang-rust)
3+
4+
Work efficiently and effortlessly with Rust
5+
6+
## Example Usage
7+
8+
```json
9+
"features": {
10+
"ghcr.io/georglauterbach/dev-container-features/lang-rust:0": {}
11+
}
12+
```
13+
14+
## Options
15+
16+
| Options Id | Description | Type | Default Value |
17+
|-----|-----|-----|-----|
18+
| generate-shell-completion | Whether to generate shell completion for Rustup and Cargo | boolean | true |
19+
| rustup-disable-auto-self-update | Whether to disable Rustup's self-update feature | boolean | true |
20+
21+
## Customizations
22+
23+
### VS Code Extensions
24+
25+
- `rust-lang.rust-analyzer`
26+
- `tamasfe.even-better-toml`
27+
- `vadimcn.vscode-lldb@1.11.6`
28+
29+
30+
31+
---
32+
33+
_Note: This file was auto-generated from the [devcontainer-feature.json](https://github.com/georglauterbach/dev-container-features/blob/main/src/lang-rust/devcontainer-feature.json). Add additional notes to a `NOTES.md`._

src/nodejs/README.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
2+
# NodeJS (nodejs)
3+
4+
Install NodeJS
5+
6+
## Example Usage
7+
8+
```json
9+
"features": {
10+
"ghcr.io/georglauterbach/dev-container-features/nodejs:0": {}
11+
}
12+
```
13+
14+
## Options
15+
16+
| Options Id | Description | Type | Default Value |
17+
|-----|-----|-----|-----|
18+
| version | Version of NodeJS to install | string | 23.11.0 |
19+
| architecture | Architecture of NodeJS to install | string | x64 |
20+
| uri | Non-default mirror for the `tar.xz`/`tar.gz` archive that contains NodeJS files. You can specify the version directly or use the string `<<VERSION>>` which is replaced by `node.version` | string | https://nodejs.org/dist/v<<VERSION>>/node-v<<VERSION>>-linux-<<ARCHITECTURE>>.tar.xz |
21+
| proxy.http.http.address | A URI for an HTTP proxy | string | - |
22+
| proxy.http.https.address | A URI for an HTTPS proxy | string | - |
23+
| proxy.http.no-proxy.address | A list of URIs to not proxy | string | localhost,127.0.0.1 |
24+
| acquire_insecure | Whether to download NodeJS without checking certificates | boolean | false |
25+
26+
27+
28+
---
29+
30+
_Note: This file was auto-generated from the [devcontainer-feature.json](https://github.com/georglauterbach/dev-container-features/blob/main/src/nodejs/devcontainer-feature.json). Add additional notes to a `NOTES.md`._
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
2+
# VS Code | Cache Extensions (vscode-cache-extensions)
3+
4+
Prevent superfluous (re-)installations of VS Code extensions upon container restarts
5+
6+
## Example Usage
7+
8+
```json
9+
"features": {
10+
"ghcr.io/georglauterbach/dev-container-features/vscode-cache-extensions:0": {}
11+
}
12+
```
13+
14+
15+
16+
17+
18+
---
19+
20+
_Note: This file was auto-generated from the [devcontainer-feature.json](https://github.com/georglauterbach/dev-container-features/blob/main/src/vscode-cache-extensions/devcontainer-feature.json). Add additional notes to a `NOTES.md`._

0 commit comments

Comments
 (0)