Open Toolbox ๐งฐ
This is a theme for Jekyll, built so that you can create a fast, automatically updated and mobile-friendly websites without worrying about the actual HTML.
How to use it
Install it locally:
bundle install jekyll-theme-opentoolbox
... and set it as your theme by adding this line to your _config.yml
:
theme: jekyll-theme-opentoolbox
Or you could set it as a remote theme for GitHub Pages by adding this line to your _config.yml
:
remote_theme: opentoolbox/theme
๐ฅ Contributing
To contribute to this project please refer to our rules. They're not many, don't worry.
๐จโ๐ป Local Development
๐งช Jekyll & Ruby
This site uses Jekyll to generate the static pages from the provided templates. In order to install both it and it's components follow this guide.
๐ง Make
To simplify our lives we have simplified the commands used to build, publish, serve, etc. In order to accomplish this we've used Make.
If you're on Linux or macOS you already have it installed, if you're on Windows please continue this section of the guide.
Install using package managers on Windows
You have serveral options, these are the best 2:
You could install Chocolatey and run:
choco install make
...or install Scoop and run:
scoop install make
You're all set. Time to build this thing!
๐ Final setup
Now that we have our simplified commands, setting up the project is easy...
Here are our commands:
Install & build
make
Re-build
make build
Serve site in development mode
make start
... and open the link showed in the CLI.
Check for problems
make check
You could also be here โ