Github Pages & Jekyll

Table of contents

• References
• Installing Dependencies
• Testing Locally
• GitHub Pages

References

• Github Pages
• Jekyll
  • Documentation
• Just the Docs Theme
  • Documentation

Installing Dependencies

Jekyll has a few requirements before we can serve up local pages for testing:

• Ruby version 2.5.0 or higher, including all development headers (check your Ruby version using ruby -v)
• RubyGems (check your Gems version using gem -v)
• GCC and Make (check versions using gcc -v,g++ -v, and make -v)

Here are step-by-step instructions to get it working on MacOS.

Testing Locally

To start Jekyll, open a Terminal window:

cd Documents/GitHub/leanghoun.github.io/
bundle exec jekyll serve --livereload

To reach the local page: localhost:4000.

GitHub Pages

This entire website is built on and hosted by Github Pages with a remote theme called Just the Docs, just like the Voron Docs. The local files are edited with Nova and synced back to GitHub via Nova’s built-in GitHub integration.