https://github.com/joeltennant/jekyll-and-docker-compose
Starter template for building a Jekyll site on Docker Compose
https://github.com/joeltennant/jekyll-and-docker-compose
blog docker docker-compose jekyll portfolio-website
Last synced: 4 months ago
JSON representation
Starter template for building a Jekyll site on Docker Compose
- Host: GitHub
- URL: https://github.com/joeltennant/jekyll-and-docker-compose
- Owner: joeltennant
- License: mit
- Created: 2017-08-11T07:33:10.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2020-01-19T05:47:01.000Z (over 6 years ago)
- Last Synced: 2025-05-13T16:39:32.178Z (about 1 year ago)
- Topics: blog, docker, docker-compose, jekyll, portfolio-website
- Language: HTML
- Size: 172 KB
- Stars: 20
- Watchers: 2
- Forks: 14
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Jekyll & Docker Compose
This project provides an example for building a Jekyll blog/site with Docker Compose. Using Docker you can easily
develop your Jekyll site without installing Ruby and can develop it from computer to computer with a consistent
environment. This is particularly helpful for Windows users.
## Why Use Docker
Docker containers provide a consistent environment across different computers. For the non-Ruby developer, it means you don't have to install Ruby on Rails to your system to make your site. This is a great option for Windows users who don't want to deal with Ruby. No matter what system you use, with Docker, every time you run your container it is isolated form the rest of your computer. No extra installs, downloads, or running programs other than Docker and your favorite editor.
## Getting Started
#### Prerequisites
You must have Docker and Compose installed to run your Jekyll project in Docker.
[Instructions to install Docker Compose](https://docs.docker.com/compose/install/)
#### Using this sample
To start your project using this sample template begin by cloning this repository to your machine.
To serve up the project:
1) In project folder run (Linux users may need to use 'sudo'):
```
docker-compose up
```
2) View project at localhost:4000
3) Edit project and Jekyll will auto-regenerates the site
4) When you want to shut-down the site, use Ctrl+C then run:
```
docker-compose down
```
When you are ready to publish, simply push your project to Github or whatever you choose to host your site.
#### Existing Project or Start from Scratch
Adding Docker Compose to an existing project or starting from scratch is easy. Create a filed called 'docker-compose.yml' in the root. See example file for the contents you should add: [Sample docker-compose.yml](https://github.com/joelt11753/Jekyll-and-Docker-Compose/blob/master/docker-compose.yml)
After you have a docker-compose.yml file in your existing or new Jekyll project, simply follow the instructions above in the "Using this sample" section to serve up your site.
#### Sample Theme
The theme that is used is from [portfolio-iro](https://github.com/Bloc/portfolio-iro/) and serves as an example theme
for this project.
A free and open-source [Jekyll](http://jekyllrb.com) theme. Great for blogs and easy to customize.
[Original Repo](https://github.com/Bloc/portfolio-iro/)
[Demo](https://rohanchandra.github.io/type-theme/)