Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/itstorque/jekyll-shell-theme
A Jekyll Theme that looks like a shell
https://github.com/itstorque/jekyll-shell-theme
jekyll jekyll-theme shell theme website
Last synced: about 2 months ago
JSON representation
A Jekyll Theme that looks like a shell
- Host: GitHub
- URL: https://github.com/itstorque/jekyll-shell-theme
- Owner: itstorque
- License: mit
- Created: 2019-11-16T21:24:23.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2023-05-18T05:30:36.000Z (over 1 year ago)
- Last Synced: 2024-03-15T07:22:47.927Z (9 months ago)
- Topics: jekyll, jekyll-theme, shell, theme, website
- Language: CSS
- Homepage:
- Size: 34.2 KB
- Stars: 69
- Watchers: 3
- Forks: 55
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# jekyll-shell-theme
**Jekyll Shell Theme** is a light-weight customizable one-column jekyll theme that gives off:
- Hackery Vibes
- Shell Nostalgia
- Code, code and more code
See an example of this theme in action on the [theme's official site](https://tareqdandachi.github.io/jekyll-shell-theme).
## Installation
### Gem-based method
Add this line to your Jekyll site's `Gemfile`:
```ruby
gem "jekyll-shell-theme"
```
And add this line to your Jekyll site's `_config.yml`:
```yaml
theme: jekyll-shell-theme
```
And then execute:
$ bundle
Or install it yourself as:
$ gem install jekyll-shell-theme
### Remote theme method
Make sure your `Gemfile` contains the `github-pages` gem and **not** the `jekyll-shell-theme` gem.
Then add `remote_theme: "tareqdandachi/jekyll-shell-theme"` to your `_config.yml` file.
*Remove* any other `theme:` or `remote_theme:` entry.
*For an example of what a config file could look like, look at [example-config.yml](https://github.com/tareqdandachi/jekyll-shell-theme/blob/master/example-config.yml)*
## Usage
TODO: Write usage instructions here. Describe your available layouts, includes, sass and/or assets.
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/tareqdandachi/jekyll-shell-theme. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
## Development
Everyone is welcome to fork this repo and modify the code. To set up your environment to develop this theme, run `bundle install`.
To test the theme, run `bundle exec jekyll serve` and open your browser at `http://localhost:4000`. This starts a Jekyll server using the theme. Add pages, documents, data, etc. like normal to test the theme's contents. As you make modifications to your theme and to your content, your site will regenerate and you should see the changes in the browser after a refresh, just like normal.
When your theme is released, only the files in `_layouts`, `_includes`, `_sass` and `assets` tracked with Git will be bundled.
To add a custom directory to your theme-gem, please edit the regexp in `jekyll-shell-theme.gemspec` accordingly.
## License
The theme is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).