Jekyll requires the following:
- Ruby version 2.5.0 or higher
- GCC and Make
See Requirements for guides and details.
gem install jekyll bundler
- Clone this repository.
git clone https://github.com/brennanbrown/watery.git
- Change into your new directory.
- Install gems from the
- Build the site and make it available on a local server.
bundle exec jekyll serve
- Browse to http://localhost:4000
If you encounter any errors during this process, check that you have installed all the prerequisites in Requirements.
If you still have issues, see Troubleshooting.
Once you have Jekyll up-and-running, there are only a few steps needed to make this theme your own:
- Fill out the
_BLANK_config.ymlconfiguration file and replace the current
- Remove the
_postsand start writing your own!
- Modify or remove the pages in
_pagesto however you see fit.
- (Optional) Modify or remove this
README.mdwith information about your own project or blog.
- (Optional) Modify the CSS files in the
assetsfolder to customize the site.
There are several features that I’m still planning to create and integrate, including:
- Create a Theme Gem
- Add easy and automatic buttons to “Deploy to Neflify”, Heroku, etc.
- Add Travis continious integration checks
- Add additional documentation for creating custom collections and auto generated pages
See the open issues for a list of proposed features (and known issues).
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature)
- Commit your Changes (
git commit -m 'Add some AmazingFeature')
- Push to the Branch (
git push origin feature/AmazingFeature)
- Open a Pull Request
Distributed under the MIT License. You can use this project however you see fit without needing to give attribution.
LICENSE for more information.