search

tcbutler320 / jek

Jek is a minimalist jekyll theme putting the power of color schemes in the user’s hands. Toggle between schemes hassle-free, create new ones on the go, and store settings in-browser.
https://jekyll-jek.netlify.app/
MIT License
37 stars 10 forks source link

Docs - add set up instructions #16

Open MichaelCurrin opened 3 years ago

MichaelCurrin commented 3 years ago

I want to suggest a docs/installation.md file where you explain how to add the theme to a Gemfile and to a config.

See a section in my Theme Quickstart template project around Custom CI (ie not vanilla GH Pages but Netlify or GH Actions)

https://github.com/MichaelCurrin/jekyll-theme-quickstart/blob/master/docs/installation.md#custom-ci-flow

And then also mention that doc from your README.

If you leave that out, users are likely to fork the repo and end up with a ton of files they have to maintain and then have a hard time switching themes. Compared with installing a theme as a gem and config item and make it clear how one does that.

tcbutler320 commented 3 years ago

Hey thanks Michael! I always fork themes because I haven't learned how to install themes with gems myself haha, I'll use that as a resource and then add it into the readme