https://github.com/compilerla/template-devcontainer
A template repository with a minimal VS Code devcontainer setup
https://github.com/compilerla/template-devcontainer
mkdocs mkdocs-material pre-commit vscode vscode-devcontainer
Last synced: 2 months ago
JSON representation
A template repository with a minimal VS Code devcontainer setup
- Host: GitHub
- URL: https://github.com/compilerla/template-devcontainer
- Owner: compilerla
- License: apache-2.0
- Created: 2022-07-31T07:38:04.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2025-01-02T17:57:54.000Z (4 months ago)
- Last Synced: 2025-01-02T18:41:00.155Z (4 months ago)
- Topics: mkdocs, mkdocs-material, pre-commit, vscode, vscode-devcontainer
- Language: Dockerfile
- Homepage: https://compilerla.github.io/template-devcontainer
- Size: 713 KB
- Stars: 4
- Watchers: 4
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# template-devcontainer
A [template repository][template-repo] with a minimal [VS Code devcontainer][devcontainer] setup.
Read the full documentation online:
## Why?
Read more in our blog post: [How to support a platform-agnostic engineering team with VS Code Dev Containers](https://compiler.la/blog/2024/devcontainer-platform-agnostic-team).
## Features
- Base Docker image `python:3.11` includes support for common dev tooling like `git`, `curl`, `pip`, and `pre-commit`
- Includes VS Code extensions like [`GitLens`][gitlens] and [`Prettier`][prettier] and good default settings for the editor
- The [`pre-commit` configuration][pre-commit-config] includes a number of useful [`pre-commit-hooks`][pre-commit-hooks] and
Compiler's [`conventional-pre-commit`][conventional-pre-commit] hook
- A separate `docs` service builds documentation using [`mkdocs-material`][mkdocs-material]
## Usage
### Create a new repository
[Create a new repository from this template][generate].
### Run the devcontainer
With the `Remote - Containers` extension enabled, open the folder containing this repository inside VS Code.
You should receive a prompt in the VS Code window; click `Reopen in Container` to run the development environment inside the devcontainer.
If you do not receive a prompt, or when you feel like starting from a fresh environment:
1. `Ctrl/Cmd+Shift+P` to bring up the command palette in VS Code
1. Type `Remote-Containers` to filter the commands
1. Select `Rebuild and Reopen in Container` to completely rebuild the devcontainer
1. Select `Reopen in Container` to reopen the most recent devcontainer build
## License
[Apache 2.0](LICENSE)
[conventional-pre-commit]: https://github.com/compilerla/conventional-pre-commit
[devcontainer]: https://code.visualstudio.com/docs/remote/containers
[generate]: https://github.com/compilerla/template-devcontainer/generate
[gitlens]: https://gitlens.amod.io/
[mkdocs-material]: https://squidfunk.github.io/mkdocs-material/
[pre-commit-config]: .pre-commit-config.yaml
[pre-commit-hooks]: https://github.com/pre-commit/pre-commit-hooks
[prettier]: https://prettier.io/
[template-repo]: https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-template-repository