J1 Template

Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your newly created Template for Jekyll into a Rubie to be pubslished e.g. on RubyGems for the public.

Generate the Rubie manually

It easy to generate the RubyGem (is all files are in place, generated by the development system). Run:

gem build your_template_name.gemspec

Helpful gem commands

create:                     gem build your_template_name.gemspec
list all local:             gem list your_template_name --local --all
list all remote:            gem list your_template_name --remote --all
publish (RubyGems):         gem push your_template_name-<version>.gem
un-publish (RubyGems):      gem yank your_template_name -v <version>
install (local):            gem install --local your_template_name --no-ri --no-rdoc
install (remote):           gem install your_template_name --no-ri --no-rdoc
uninstall:                  gem uninstall your_template_name --force
                            gem uninstall your_template_name -v <version>
# list bundle:              bundle list your_template_name
# run j1 exe (help):        bundle exec j1 --help


An local installation of the new Rubie can be done like so:

gem install --local your_template_name --no-ri --no-rdoc

Creating a Starter Web

If the template has been installed, the built-in executeable j1 can be used to create a new web, a scaffold, based on the new template gem.

Create (or go for) a folder your webs a stored (e.g. ~/jekyll_webs)

mkdir ~/jekyll_webs
cd ~/jekyll_webs
j1 generate starter

This will generate a fresh web scaffold under ~/jekyll_webs/starter. To bring up the the site, run:


cd %HOMEDRIVE%\%HOMEPATH%\jekyll_webs\starter && j1serve.bat



cd ~/jekyll_webs/starter && j1serve.sh

and you're done.


Bug reports and pull requests are welcome at GitHub.


The RubyGem is available as Open Source under the terms of the MIT License.