Quick start

Quick steps to get the blog up and running.

git clone git@github.com:dayvidwhy/dayvidwhy.github.io.git
cd dayvidwhy.github.io
bundle install
bundle exec jekyll serve

Alternative start using containers

# within the project directory
docker-compose up --build
docker exec -it blog bash

Project will be available from http://localhost:4000.

For an optimized development experience, attach VSCode to the running blog-app container:

1. Use the command palette (Ctrl+Shift+P or Cmd+Shift+P on Mac) and select: >Dev Containers: Attach to Running Container...
2. Choose /blog from the list.

Goals

Make use of the Jekyll blog engine, get my feet wet with ruby and make use of liquid templating.

Jekyll is a static site generator that produces plain html from several template pages that can be deployed to most hosting providers since it is just HTML, CSS and JavaScript

Technologies

• Ruby
• SCSS
• JavaScript
• Liquid
• Jekyll

Tests

A Rakefile is provided that runs html-proofer to validate the HTML in the built _site directory ensuring outgoing links work and other good practices are followed.

bundle exec rake

Troubleshooting

If something went wrong, or the serve or build command failed initially checking the error message can be helpful, but there are some genreal steps to follow to make sure the environment is setup correctly.

I currently use ruby 2.7.4 so installing ruby@2.7 with homebrew is my preference.

Check your ruby installation path.

which ruby

Pointing at the system one?

brew install ruby@2.7

You should be able to see that ruby is pointing to the installed one.

which ruby gem
/usr/local/opt/ruby@2.7/bin/ruby
/usr/local/opt/ruby@2.7/bin/gem

Confirm the version of ruby

ruby -v
ruby 2.7.4

We use bundler to make sure we use gems that go with this project.

bundle install
bundle exec jekyll serve

You may need these added to your .bash_profile or other file run when you open a terminal.

export PATH="/usr/local/opt/ruby@2.7/bin:$PATH"
export LDFLAGS="-L/usr/local/opt/ruby@2.7/lib"
export CPPFLAGS="-I/usr/local/opt/ruby@2.7/include"
export PKG_CONFIG_PATH="/usr/local/opt/ruby@2.7/lib/pkgconfig"

Alternatively I suggest leveraging the docker container provided with Ruby@2.7.