Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/simplysuperb-dev/jekyll-theme-superb
🧪 Simple, Тailwind CSS-based theme for Jekyll powered blogs.
https://github.com/simplysuperb-dev/jekyll-theme-superb
jekyll-theme jekyll-theme-minimal
Last synced: 2 months ago
JSON representation
🧪 Simple, Тailwind CSS-based theme for Jekyll powered blogs.
- Host: GitHub
- URL: https://github.com/simplysuperb-dev/jekyll-theme-superb
- Owner: simplysuperb-dev
- License: mit
- Created: 2022-01-04T11:50:17.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-04-19T16:54:15.000Z (8 months ago)
- Last Synced: 2024-09-28T18:20:29.457Z (3 months ago)
- Topics: jekyll-theme, jekyll-theme-minimal
- Language: CSS
- Homepage: https://rubygems.org/gems/jekyll-theme-superb
- Size: 192 KB
- Stars: 14
- Watchers: 2
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE.txt
Awesome Lists containing this project
README
# jekyll-theme-superb
This is a simple Jekyll theme that uses [tailwindCSS's-based ui-kit](https://github.com/simplysuperb-dev/ui-kit) of simply**superb**. My blog uses it currently, so you can see it live at: https://blog.simplysuperb.app/. Additionally, here's a screenshot*:
_\* Article titles were copied from [dev.to](dev.to)'s homepage at the time of designing of this template._
## Installation
Add this line to your Jekyll site's `Gemfile`:
```ruby
gem "jekyll-theme-superb"
```
And add this line to your Jekyll site's `_config.yml`:
```yaml
theme: jekyll-theme-superb
```
And then execute:
$ bundle
Or install it yourself as:
$ gem install jekyll-theme-superb
## Usage
Theme has a `post` layout used for displaying a single post, an `index` layout used for displaying all posts and a page layout that differs slightly from the `post` layout.
## Configuration
Additional to other config options already present in jekyll itself, this theme also has:
- **subtitle**: Shown next to the name of the blog (top left corner, visible desktop only)
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/simplysuperb-dev/jekyll-theme-superb. 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` and `npm install`.
To run `postcss` for the tailwind part:
```
npm run css:dev
```
To run jekyll and its processor:
```
npm run jekyll:dev
```
> Note: You might checkout [`concurrently`](https://www.npmjs.com/package/concurrently), if you want to run both commands... wait for it... *concurrently*.
## Releasing
First, make sure the theme runs smoothly (or at all) locally.
Then create the 💎
```
gem build jekyll-theme-superb.gemspec
```
Lastly, publish it to the ☁️
```
gem push jekyll-theme-superb-*.gem
```
## License
The theme is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).