Skip to content

Latest commit

 

History

History
70 lines (43 loc) · 3.87 KB

README.md

File metadata and controls

70 lines (43 loc) · 3.87 KB
Raw

Tryout GitHub Pages (Jekyll)

GitHub Pages

Develop GitHub Pages, static sites, and themes with Jekyll. Include extensions and related dependencies for use with devcontainers.

What's in it:

  • Ruby >= 2.7 and Bundler.
  • Jekyll and the required tools and gems.
  • VS Code Extensions and the tasks to build and test locally.
  • ZSH integrated terminal.
  • Git and GitHub CLI for source control and versioning.
  • Docker CLI and Docker Compose v2.

Usage

In this devcontainer, you'll find the files you need to be able to generate a static sites and themes with Jekyll.

To set up your environment to develop static sites and themes, you want a copy of this devcontainer. Luckily, this repo is marked as a Template so you can simply Use This Template yourself without having to install any tools and dependencies via brew and whatnot. You will want to follow this generic pattern:

  1. First, you will have to create a GitHub account if you don't have one already. GitHub's Learning Lab is a good source of information. Sign in to GitHub using your credentials, otherwise.
  2. Next, Use This Template to create a copy of this repo, then follow the instructions. Read more about this in the GitHub Template Repositories document.
  3. Once you obtain your own copy of this repo, you will have to rebuild the container. Luckly, even if you are not familiar, these steps should be pretty easy to follow. Developing in Codespaces using VS Code is a good source of information.

That's it. You now have a Jekyll-enabled minimal devcontainer, and is ready to start working locally or on the cloud.

Note

Whilst devcontainer should work unmodified, you can select the version of Debian and it's features used by updating the devcontainer.json.

Development

To create a Jekyll project, run jekyll new . --force, and Jekyll will generate a project and its prerequisites in this directory based on site template.

To test your site locally, press F1 and run task live-serve. This starts a Jekyll server and generate your static site. You should see the content in your favorite browser at localhost:4000.

To experiment with this devcontainer, you can directly reference @kosalanuwan's developer journal notes.

Feedback

If you have technical problems with devcontainers, you are better off asking GitHub Codespaces Support directly, since you'll end up getting a much faster response back that way.

Contributing

The official repo to contribute would be @devcontainers/images.

License

The devcontainer is available as open source under the terms of the MIT License.