microsoft/devcontainers-jekyll repository overview

⁠Jekyll

⁠About

Develop static sites with Jekyll, includes everything you need to get up and running.

See history⁠ for information on the contents of published images.

⁠Using this image

In addition to Ruby and Bundler, this development container installs Jekyll and the required tools at startup:

• If your Jekyll project contains a Gemfile in the root folder, the development container will install all gems at startup by running bundle install. This is the recommended⁠ approach as it allows you to specify the exact Jekyll version your project requires and list all additional Jekyll plugins.
• If there's no Gemfile, the development container will install Jekyll automatically, picking the latest version. You might need to manually install the other dependencies your project relies on, including all relevant Jekyll plugins.

Refer to this guide⁠ for more details.

You can directly reference pre-built versions of Dockerfile by using the image property in .devcontainer/devcontainer.json or updating the FROM statement in your own Dockerfile to one of the following. An example Dockerfile is included in this repository.

• mcr.microsoft.com/devcontainers/jekyll (latest)
• mcr.microsoft.com/devcontainers/jekyll:bookworm

You can decide how often you want updates by referencing a semantic version⁠ of each image. For example:

• mcr.microsoft.com/devcontainers/jekyll:2 (or 2-bookworm to pin to an OS version)
• mcr.microsoft.com/devcontainers/jekyll:2.4 (or 2.4-bookworm to pin to an OS version)
• mcr.microsoft.com/devcontainers/jekyll:2.4.0 (or 2.4.0-bookworm to pin to an OS version)

However, we only do security patching on the latest non-breaking, in support⁠ versions of images (e.g. 2-bookworm). You may want to run apt-get update && apt-get upgrade in your Dockerfile if you lock to a more specific version to at least pick up OS security updates.

See history⁠ for information on the contents of each version and here for a complete list of available tags⁠.

Alternatively, you can use the contents of .devcontainer⁠ to fully customize your container's contents or to build it for a container host architecture not supported by the image.

⁠Installing Node.js

Given JavaScript front-end web client code written for use in conjunction with a Jekyll site often requires the use of Node.js-based utilities to build, this container also includes nvm so that you can easily install Node.js.

Also, you can use a Node feature⁠ to install any version of Node by adding the following to devcontainer.json:

{
  "features": {
    "ghcr.io/devcontainers/features/node:1": {
      "version": "latest"
    }
  }
}

⁠Support

The dev container spec images are maintained in the devcontainers/images⁠ repo. You can explore each image and open issues or feature requests.

⁠License

Copyright (c) Microsoft Corporation. All rights reserved.

Licensed under the MIT License. See LICENSE⁠.