https://github.com/liamg/jekyll-theme-abysm
Dark, minimal Jekyll theme for GitHub pages
https://github.com/liamg/jekyll-theme-abysm
Last synced: 10 months ago
JSON representation
Dark, minimal Jekyll theme for GitHub pages
- Host: GitHub
- URL: https://github.com/liamg/jekyll-theme-abysm
- Owner: liamg
- License: mit
- Created: 2022-01-12T20:02:11.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2022-03-09T15:12:47.000Z (almost 4 years ago)
- Last Synced: 2025-02-07T12:49:03.743Z (11 months ago)
- Language: HTML
- Homepage:
- Size: 33.2 KB
- Stars: 0
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# jekyll-theme-abysm
Abysm is pretty basic dark theme for Jekyll. It's designed to be used for GitHub pages using [jekyll-remote-theme](https://github.com/benbalter/jekyll-remote-theme).
## Installation
Add this line to your Jekyll site's `_config.yml`:
```yaml
remote_theme: liamg/jekyll-theme-abysm
```
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/liamg/jekyll-theme-abysm. 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
To set up your environment to develop this theme, run `bundle install`.
Your theme is setup just like a normal Jekyll site! To test your theme, run `bundle exec jekyll serve` and open your browser at `http://localhost:4000`. This starts a Jekyll server using your theme. Add pages, documents, data, etc. like normal to test your 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-theme-abysm.gemspec` accordingly.
## License
The theme is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).