stedman / docker-jekyll

Jekyll install on Docker container.

Jekyll Development

EVALUATION

Pro

• Jekyll is a Static Site Generator (SSG) which is great for content that doesn't need to change for each user. Once deployed, it's dead-simple fast and secure.
• Jekyll has built-in support for GitHub Pages. They host your content for free!
• GitHub can host custom domains. Did I mention free?
• Jekyll can be run locally in a Docker container—which saves a lot of Ruby setup and configuration time. See below for details.

Con

• Contributing is okay for geeks, but may be too much for the uninitiated.
  • Content needs to be created and edited in Markdown.
  • Editing can be done at github.com or via IDE or text editor.
• Jekyll is written in Ruby—which may be an issue if it's not your native language.

LOCAL DEVELOPMENT SETUP

Requirememts

• Git
• Docker Desktop

Install a new Jekyll app

1. Clone this repo to a local directory.

   git clone https://github.com/stedman/docker-jekyll my-jekyll-app
   cd my-jekyll-app

2. OPTIONAL: In the .env file, change JEKYLL_VERSION to suit your needs.

3. Run Docker Compose.

   docker-compose -f docker-compose-jekyll-new.yml up

Build and serve an existing Jekyll app

1. If you don't already have the .env and docker-compose.yml files in your Jekyll app directory, please cut and paste the contents of those files from this repo.

2. Start Jekyll server (from the app directory).

   docker-compose up -d

3. Stop Jekyll server.

   docker-compose down

REFERENCE

• Jekyll documentation
• Jekyll Docker repo
• GitHub Pages versions (GitHub's environment and dependencies)
• Running Jekyll in Docker (tutorial)