/system-design-primer

Learn system design primer by building its static site with Jekyll

Primary LanguagePythonOtherNOASSERTION

System Design Primer in Jekyll

This is a static site version of System Design Primer built with Jekyll and hosted on GitHub Pages.

Setup

  • Install ruby-install
  • Run ruby-install ruby "$(< .ruby-version)" to install ruby into ~/.rubies/ruby-<version>
  • Install direnv tool
  • Add the following function to ~/.config/direnv/direnvrc:
use_ruby() {
    local ruby_dir=$HOME/.rubies/ruby-$1
    load_prefix $ruby_dir
    layout ruby
}
  • cd into this folder to trigger direnv to load the project's environment
  • Run dev update to install ruby dependencies into local ./.direnv/ruby directory
  • Run dev serve to start the Jekyll server

Deploy to GitHub Pages

  • Run dev build to build the site into docs/ folder
  • Push the docs/ folder to GitHub

Customize the site's theme

The site uses minima theme 2.5.1. Take a look at the source code to know which files to override.