jeksite

Plain and simple Jekyll site template ideal for GitHub Pages.

Also good for a quick-and-dirty sandbox static site similar to using CodePen.

• Usage
  • Clone this repo locally and use it as a template
  • Use this repo as a template on GitHub
  • Install using Homebrew and generate a new site
• Help
• To Do

Usage

There are a few ways to use jeksite:

Clone this repo locally and use it as a template

git clone https://github.com/remino/jeksite.git newsite
cd newsite
asdf install # if you use asdf
bundle install
git remote set-url origin <url of your repo> # if you want to push to a new repo
./jeksite # serve site using jekyll

Use this repo as a template on GitHub

https://github.com/remino/jeksite/generate

Install using Homebrew and generate a new site

This requires Homebrew and works on macOS (and possibly Linux) only.

brew tap remino/remino
brew install jeksite
jeksite new newsite
cd newsite
./jeksite

Help

See ./jeksite -h for more information on the command.

To Do

• Ensure Gemfile is using github-pages if the site is for GitHub Pages. If not, use plain jekyll.
• Update _config.yml, notable baseurl, domain, url, title, and description.
• Update README.md by first deleting its content.
• Update or remove LICENSE.txt if needed. (ISC licence by default.)
• Delete content of index.html, style.css, and script.js.