Skip to content

Latest commit

 

History

History
89 lines (65 loc) · 3.89 KB

README.md

File metadata and controls

89 lines (65 loc) · 3.89 KB
Raw

Community devcontainer features

🧰 Feature addons for @devcontainers

💻 Works with devcontainers
☁️ Works with GitHub Codespaces
⚠️ We only officially support debian-based images

👀 Don't see your feature here? Add it yourself or open an Issue!

Usage

VS Code Codespaces Devcontainers

📄 Complete feature list

Just add a .devcontainer/devcontainer.json file with a features key. It's very similar to package.json's dependencies object, just with the addition of an options object.

📚 Make sure to inspect each feature for feature-specific options!

{
  "image": "mcr.microsoft.com/devcontainers/universal",
  "features": {
    "ghcr.io/devcontainers-contrib/features/deno:": {},
    "ghcr.io/devcontainers-contrib/features/neovim": {}
  }
}

Then, after adding your devcontainer config file, you can open it in GitHub Codespaces, or open it locally using VS Code. Be warned some features will compile things from source code and may take a while!

Development

Devcontainers JSON Bash

➕ Looking to add a new feature? Check out the contributing guide!

This project uses a devcontainer config to outline the development environment. We also provide various VS Code customizations for your coding pleasure.

To get started, create a GitHub Codespace on a copy of this repository. From there, the dev wiki provides information about adding features, layout, conventions, etc. When or if you want to contribute your changes back to this repository, you can follow the contributing guide. Happy coding! 👋

🗺️ If you're looking for a more thorough outline of how this repo works, check out the How it works page on the dev wiki.