I added a [Remote Development Containers](https://code.visualstudio.com/docs/devcontainers/tutorial) in Visual Studio Code (VSCode). Lots of people like to develop in Containers to have a clean system. With this PR, it is possible to work with al-folio without any installation (except for VS Code, its Remote Dev Container extension, and Docker). Once you've opened the `al-folio` repository, a prompt will appear requesting to reopen the project within a container. <img width="541" alt="grafik" src="https://github.com/alshedivat/al-folio/assets/1998723/2963446f-8e42-4df1-9e8c-22691d78b7e4"> Upon doing so, Jekyll will automatically start within the container and prompt you to open the website's preview sidebar directly in VSCode or using your Browser. Additionally, it installs extensions for `liquid` and Prettier (`npx prettier`). Files are formatted using `al-folios`-prettier settings (`.prettierrc`) to streamline pull request submission. Additionally, the performance seems to be much better compared to the `docker-compose`setup, see #2333. --------- Co-authored-by: George <31376482+george-gca@users.noreply.github.com>
32 lines
1.1 KiB
JSON
32 lines
1.1 KiB
JSON
// For format details, see https://aka.ms/devcontainer.json. For config options, see the
|
|
// README at: https://github.com/devcontainers/templates/tree/main/src/jekyll
|
|
{
|
|
"name": "Jekyll",
|
|
"image": "mcr.microsoft.com/devcontainers/jekyll",
|
|
|
|
// Features to add to the dev container. More info: https://containers.dev/features.
|
|
"features": {
|
|
"ghcr.io/rocker-org/devcontainer-features/apt-packages:1": {
|
|
"packages": "build-essential,imagemagick,inotify-tools,jupyter-nbconvert,procps,ruby-full,zlib1g-dev"
|
|
},
|
|
"ghcr.io/devcontainers-contrib/features/prettier:1": {}
|
|
},
|
|
|
|
// Optionally: run jekyll serve automatically on container entering using the Docker entrypoint
|
|
"postAttachCommand": "./bin/entry_point.sh",
|
|
|
|
"customizations": {
|
|
"vscode": {
|
|
"extensions": ["esbenp.prettier-vscode", "sissel.shopify-liquid", "yzhang.markdown-all-in-one"],
|
|
"settings": {
|
|
// use prettier code formatter as default formatter
|
|
"editor.defaultFormatter": "esbenp.prettier-vscode",
|
|
"prettier.configPath": ".prettierrc",
|
|
"editor.formatOnSave": true
|
|
}
|
|
}
|
|
},
|
|
|
|
"remoteUser": "vscode"
|
|
}
|