https://github.com/kevyder/wead

A simple and clean @jekyll theme. :ok_hand:
https://github.com/kevyder/wead

jekyll jekyll-theme rubygems sass

Last synced: 2 months ago
JSON representation

A simple and clean @jekyll theme. :ok_hand:

• Host: GitHub
• URL: https://github.com/kevyder/wead
• Owner: kevyder
• License: mit
• Created: 2017-01-06T21:03:19.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2024-04-19T18:26:52.000Z (8 months ago)
• Last Synced: 2024-09-29T03:04:50.758Z (3 months ago)
• Topics: jekyll, jekyll-theme, rubygems, sass
• Language: CSS
• Homepage: https://kevyder.github.io/wead/
• Size: 37.1 KB
• Stars: 14
• Watchers: 3
• Forks: 5
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# Wead.

[![Gem Version](https://badge.fury.io/rb/wead.svg)](https://badge.fury.io/rb/wead)

[![Codacy Badge](https://api.codacy.com/project/badge/Grade/519daacbe38c4aa785f633bfe3d9bf5f)](https://www.codacy.com/app/Kevyder/wead?utm_source=github.com&utm_medium=referral&utm_content=kevyder/wead&utm_campaign=badger)

A simple and clean jekyll theme.

Demo: https://kevyder.github.io/wead/

Rubygems: https://rubygems.org/gems/wead

### Preview.

![Imgur](http://i.imgur.com/5brZmdv.png)

## Installation

Add this line to your Jekyll site's Gemfile:

```ruby

gem "wead"

```

And add this line to your Jekyll site's `_config.yml`:

```yaml

theme: wead

```

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install wead

## Usage

* Update information to `_config.yml`.

* Change `_about.md` for blog intro.

## Pagination

Add the next lines in your `_config.yml`

```yaml

paginate: 5

paginate_path: "/page:num/"

plugins: [jekyll-paginate]

```

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/kevyder/wead.

## 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`, 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).