Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sinisimattia/the-open-toolbox
The Jekyll theme that adapts to you, complete with automatic components that change based to the structure of your pages. 🚀 Fully customizable!
https://github.com/sinisimattia/the-open-toolbox
jekyll jekyll-theme
Last synced: about 1 month ago
JSON representation
The Jekyll theme that adapts to you, complete with automatic components that change based to the structure of your pages. 🚀 Fully customizable!
- Host: GitHub
- URL: https://github.com/sinisimattia/the-open-toolbox
- Owner: sinisimattia
- License: agpl-3.0
- Created: 2021-07-19T16:15:46.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2021-09-22T10:21:17.000Z (over 3 years ago)
- Last Synced: 2024-11-22T08:12:49.580Z (about 2 months ago)
- Topics: jekyll, jekyll-theme
- Language: HTML
- Homepage: https://the.opentoolbox.online
- Size: 411 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# [Open Toolbox](https://the.opentoolbox.online) 🧰 [](https://github.com/opentoolbox/theme/blob/main/LICENSE)
[](https://badge.fury.io/rb/jekyll-theme-opentoolbox)
[](https://github.com/opentoolbox/theme/actions/workflows/jekyll.yml)
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:
```bash
bundle install jekyll-theme-opentoolbox
```
... and set it as your theme by adding this line to your `_config.yml`:
```yaml
theme: jekyll-theme-opentoolbox
```
Or you could set it as a **remote theme** for [GitHub Pages](https://pages.github.com) by adding this line to your `_config.yml`:
```yaml
remote_theme: opentoolbox/theme
```
___
## 👥 Contributing
To contribute to this project please refer to our [rules]({{site.links.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](https://jekyllrb.com/docs/installation/).
### 🔧 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](https://chocolatey.org/install) and run:
```bash
choco install make
```
...or install [Scoop](https://scoop.sh) and run:
```bash
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
```bash
make
```
#### Re-build
```bash
make build
```
#### Serve site in development mode
```bash
make start
```
... and open the link showed in the CLI.
#### Check for problems
```bash
make check
```
# Contributors ❤ 
[](https://github.com/opentoolbox/theme/graphs/contributors)
You could also be here ☝
___
