All this works thanks to Jekyll tool, in fact Mr. Hyde wraps Jekyll so if you know Jekyll there is no much to learn about Mr. Hyde.
The current version is based on Jekyll 3.1.1.
Installation
Add this line to your application's Gemfile:
gem 'mr_hyde'
And then execute:
$ bundle
Or install it yourself as:
$ gem install mr_hyde
Usage
In order to use Mr. Hyde the first thing you must do is creating the Mr. Hyde root folder using the next command:
$ mrhyde new [NAME]
The previuos command creates the basic structure folder within the new folder NAME, in case the name is not provided then the same folder will be used.
Once created cd the Mr. Hyde root folder (or the same if no NAME was given) and you can execute the next commands:
$ cd PATH
$ mrhyde site new SITE_NAME
$ mrhyde site build SITE_NAME
The above commands give you first site, by now if you want to run on a server get in the site/SITE_NAME and executes:
$ cd root_folder/site/site_name
$ jekyll serve
If you want to know more about this, please refer to Jekyll.
Removing the built site is:
$ mrhyde site rm SITE_NAME
$ mrhyde site rm SITE_NAME --full
The last command with the --full option removes the site source as well, so take care with this option.
You can see more information about the commands with the command line --help option:
$ mrhyde site new --help
Contributing
- Fork it ( https://github.com/[my-github-username]/mr_hyde/fork )
- Create your feature branch (
git checkout -b my-new-feature
) - Commit your changes (
git commit -am 'Add some feature'
) - Push to the branch (
git push origin my-new-feature
) - Create a new Pull Request