custom_jekyll

CustomJekyll

The purpose of this gem is to make one's life easy while making any kind of site with jekyll. This gem is a mere generator that will generate all the files required for you to start any kind of static website using jekyll. Jekyll default generator is focused for blogs. I love to make different static websites and hosting them using github pages.

Generate using CustomJekyll and have the basic structure for creating any kind of static website and then hosting it on GithubPages.

Usage

Install

$ gem install custom_jekyll

Generate a site

$ custom_jekyll static-is-fun-with-jekyll

then switch to it and start jekylling

$ cd static-is-fun-with-jekyll
$ bundle exec jekyll serve

if you do not like the name custom_jekyll (I totally understand :P)

Add the following in your shell's profile

alias cj="custom_jekyll"

then

$ cj learning-flexbox

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/aurangzaib-danial/custom_jekyll. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the CustomJekyll project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.