/jtd-site

Primary LanguageHTMLMIT LicenseMIT

Just-the-Docs Example site

Running locally

The first time you run this, you'll need to follow the "one time setup" steps below.

Then:

  1. Run jekyll

    $ bundle exec jekyll serve

  2. Open in a browser at http://localhost:4000

Running locally - one time setup

The following steps configure Jekyll to run within Windows System for Linux.

Prerequisites:

  • make sure you are on Ubuntu 20.04.5 LTS or later

    $ lsb_release -a

  • Identify exactly which version of Ruby and Bundler is used in the GitHub Pages Actions in order to replicate the same environment locally.

Steps:

  1. Install ruby-install as per https://github.com/postmodern/ruby-install#readme

    • you can download to a Downloads folder, it'll install as a globally available command when running make.

  2. Install ruby:

    $ ruby-install
$ sudo ruby-install --system ruby 3.1.4       # or whichever version is used on GitHub Pages
$ ruby -v

  3. Update your .bashrc so gems to be installed locally as per https://jekyllrb.com/docs/troubleshooting/#no-sudo

  4. Make sure you've got the correct version of bundler:

    $ gem install bundler --version "2.3.26"      # or whichever version is used on GitHub Pages

  5. Install node.js (needed by execjs, used by Katex) as per https://learn.microsoft.com/en-us/windows/dev-environment/javascript/nodejs-on-wsl

  6. Checkout and cd into the project

  7. Do bundle install

    $ bundle install