https://github.com/siddhantgoel/clean-jekyll-theme

Yet another clean theme for jekyll
https://github.com/siddhantgoel/clean-jekyll-theme

jekyll jekyll-theme

Last synced: 2 months ago
JSON representation

Yet another clean theme for jekyll

• Host: GitHub
• URL: https://github.com/siddhantgoel/clean-jekyll-theme
• Owner: siddhantgoel
• License: mit
• Created: 2016-11-15T18:37:55.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2019-05-11T08:15:51.000Z (over 5 years ago)
• Last Synced: 2024-05-02T02:15:29.029Z (9 months ago)
• Topics: jekyll, jekyll-theme
• Language: HTML
• Homepage: https://siddhantgoel.github.io/clean-jekyll-theme/
• Size: 1010 KB
• Stars: 13
• Watchers: 2
• Forks: 5
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# clean-jekyll-theme

[![Gem Version](https://badge.fury.io/rb/clean-jekyll-theme.svg)](https://badge.fury.io/rb/clean-jekyll-theme)

A Jekyll theme that tries to be as clean as possible, and uses [Basscss](http://basscss.com/) underneath.

## Screenshot

![Screenshot](https://raw.githubusercontent.com/siddhantgoel/clean-jekyll-theme/master/screenshot.png)

## Installation

Add the following lines to your Jekyll site's Gemfile:

```ruby

gem "clean-jekyll-theme"

group :jekyll_plugins do

    gem "jekyll-seo-tag", "~> 2.6"

    ...

end

```

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

```yaml

theme: clean-jekyll-theme

```

And configure the navigation items in `_data/navigation.yml`

```yaml

- title: about

  url: /about

- title: twitter

  url: https://twitter.com/johndoe

- title: github

  url: https://github.com/johndoe

```

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install clean-jekyll-theme

## Contributing

Bug reports and pull requests are welcome on [Github](https://github.com/siddhantgoel/clean-jekyll-theme).

## Development

To set up your environment to develop this theme, run `bundle install`.

You 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.

## License

The theme is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).