search

Phlow / feeling-responsive

»Feeling Responsive« is a free flexible theme for Jekyll built on Foundation framework. You can use it for your company site, as a portfolio or as a blog.
http://phlow.github.io/feeling-responsive/
MIT License
901 stars 1.33k forks source link

README: no installation instructions #246

Closed iam-TJ closed 2 years ago

iam-TJ commented 2 years ago

As someone who's experimenting with Jekyll my first step was to explore possible themes. Most I've visited so far give simple installation instructions for those not yet familiar with the process or possible gotchyas.

It'd be nice to see the same in the README here.

TWiStErRob commented 2 years ago

The theme has the setup guide built in: https://phlow.github.io/feeling-responsive/getting-started/

Phlow commented 2 years ago

@TWiStErRob Thankyou as always!

iam-TJ commented 2 years ago

I don't see it there. What I see is how to configure this theme with the assumption it is already installed.

I'm asking how do we go from this repository to having the theme installed locally? How do we integrate into an existing jekyll install without trampling on existing configuration - even superficial changes to _config.yaml such as title: host: would be replaced if files are simply dropped in over the top from what I can tell ?

For newcomers to Ruby, Gems, and Jekyll none of these integration steps are obvious.

From what I've read the method for installing without trampling on existing files is to use a ruby Gem install via something like echo "gem: jekyll-theme-feeling-responsive" >> Gemfile"; bundle but that fails with:

$ bundle                                                                                                                                                                             
Fetching gem metadata from https://rubygems.org/...........                                              
Could not find gem 'jekyll-theme-feeling-responsive' in rubygems repository https://rubygems.org/ or installed locally.

I thought that would work after reading about the introduction of .gemspec files and seeing this repository contains one.

TWiStErRob commented 2 years ago

Ah, that's because this "theme" was created before Jekyll themes were even concepts. It's meant to be used the "old way": clone repo, change config, customize, add content, publish.

@Phlow I don't think you did package it as theme, did you?

Phlow commented 2 years ago

@TWiStErRob You are right, I didn‘t package it as a theme.

  1. Download the ZIP of the repository to your computer.
  2. Unpack it.
  3. Open config.yaml and edit to taste.
  4. Start Jekyll