Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/broccolini/athena
A simple and elegant theme for Jekyll and GitHub Pages.
https://github.com/broccolini/athena
athena elegant-theme jekyll jekyll-site theme
Last synced: about 1 month ago
JSON representation
A simple and elegant theme for Jekyll and GitHub Pages.
- Host: GitHub
- URL: https://github.com/broccolini/athena
- Owner: broccolini
- Created: 2016-09-18T18:13:44.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2020-02-05T04:58:15.000Z (over 4 years ago)
- Last Synced: 2024-06-28T03:37:24.270Z (2 months ago)
- Topics: athena, elegant-theme, jekyll, jekyll-site, theme
- Language: HTML
- Homepage: http://broccolini.net/athena/
- Size: 31.3 KB
- Stars: 130
- Watchers: 4
- Forks: 55
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-jekyll-themes - broccolini/athena
README
# :construction: WIP :construction: Athena Jekyll Theme
A simple and elegant theme for Jekyll and GitHub Pages.
### Features:
* Mobile-first design ensures this theme performs fastest on mobile while scaling elegantly to desktop-size screens.
* Designed for blogs and sites heavy on written content, with bold typography styles, homepage summaries, and previous/next snippets.
* Supports a wide range of HTML elements and markdown.
* Flexible styles that can be reused for customization without adding additional CSS.
* Dynamically generated navigation links. See docs for adding pages with specific post category for-loops.
## Installation
Add this line to your Jekyll site's Gemfile:
```ruby
gem "jekyll-athena"
```
And add this line to your Jekyll site:
```yaml
theme: jekyll-athena
```
And then execute:
$ bundle
Or install it yourself as:
$ gem install jekyll-athena
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/broccolini/athena. 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`.
You theme is setup just like a normal Jelyll 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`, and `_sass` tracked with Git will be released.
## License
The theme is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).