# J1 Theme

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:

``` sh
gem build your_theme_name.gemspec
```

### Helpful gem commands

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

## Installation

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

``` sh
gem install --local your_theme_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)

``` sh
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:

*Windows*
``` sh
cd %HOMEDRIVE%\%HOMEPATH%\jekyll_webs\starter && j1serve.bat
```

or

*Unix|Linux|MacOS*
``` sh
cd ~/jekyll_webs/starter && j1serve.sh
```

and you're done. 

## Contributing

Bug reports and pull requests are welcome at
[GitHub](https://github.com/jekyll-one-org/J1 Theme).


## License

The RubyGem is available as Open Source under the terms of the 
[MIT License](https://github.com/jekyll-one-org/j1-template/blob/main/LICENSE.md).