search

ubc-cpsc / jekyll-clf-theme

A UBC CLF theme for Jekyll
MIT License
1 stars 1 forks source link

Update readme #6

Closed natashamm closed 3 months ago

natashamm commented 3 months ago

I had to add the following to my Gemfile:

gem "kramdown-parser-gfm"
gem "webrick"

The webrick dependency is a know issue with Ruby 3 and higher https://github.com/jekyll/jekyll/issues/8523

For reference I am using Ruby 3.2.3 and jekyll 3.9.

joelpittet commented 3 months ago

Thanks @natashamm https://pages.github.com/versions/ shows the current stuff that is used with github pages. I haven't tried compiling this in a while, thanks for testing it out

joelpittet commented 3 months ago

@natashamm What are the steps to reproduce this error message? I have ruby 3.1.3p185 Are you adding this theme to your jekyll site or just trying to compile it?

natashamm commented 3 months ago

This is only when adding the theme to an existing Jekyll site. But it works if I just serve the main branch (i.e. I don't have to add anything to the Gemfile).

Full steps to reproduce the error:

  1. Add the following line to my Gemfile: gem 'jekyll-clf-theme', git: 'https://github.com/ubc-cpsc/jekyll-clf-theme.git', branch: 'main'
  2. Run bundle
  3. Run bundle exec jekyll serve

FWIW I tried to run it with ruby 3.1.3 too and still ran into the same issues.

natashamm commented 3 months ago

I can remove the troubleshooting section and just have separate instructions for if you are adding the theme to an existing jekyll site?