search

CloudCannon / base-jekyll-template

:blue_book: Knowledge base template for Jekyll
https://orange-ape.cloudvent.net
MIT License
323 stars 200 forks source link

How to install as a theme? #23

Open leebrian opened 5 years ago

leebrian commented 5 years ago

Is it possible to install this template as a theme? I really like the structure of this theme and the license works for me. I tried searching rubygems.org and can't find a project called base-jekyll-template. And I like the cloudcannon docs on how to use jekyll, but couldn't find how to use this particular theme.

Before I fork and dump in my own content, I wanted to check with y'all to see if I'm missing something that might be an easier way to use your template.

greg-szabo commented 4 years ago

Here's how I did it:

Add to Gemfile:

gem "jekyll-remote-theme", "~> 0.4.2"

Replace theme with remote_theme in _config.yml:

remote_theme: "CloudCannon/base-jekyll-template"

Copy these files from the source code and use the same folder structure:

css/screen.scss
js/lunr.min.js
js/main.js
js/search.js

That's it.

Make sure you create your own _data/* files, use the source code as template. Also use the index.html in the source code as your main page and customize it as you see fit.

My main problem was that the default layout is somewhat inflexible, but I was able to work around most of it with custom CSS and JavaScript.