An open API service indexing awesome lists of open source software.

https://github.com/nandomoreirame/mug

💎 mug Jekyll theme
https://github.com/nandomoreirame/mug

blog jekyll jekyll-blog jekyll-theme rake ruby

Last synced: 9 months ago
JSON representation

💎 mug Jekyll theme

Awesome Lists containing this project

README

          

# mug

Jekyll theme

> :warning:
This theme requires ruby and rubygems installed

* [x] Clean layout
* [x] Resposive layout
* [x] Preprocessor SASS
* [x] CSS minified
* [x] Search posts
* [x] Pagination
* [x] Syntax highlight
* [x] Author config
* [x] Share posts
* [x] Comments with Disqus

---

### Start in 4 steps

1. Download or clone repo `git clone git@github.com:nandomoreirame/mug.git`
2. Enter the folder: `cd mug/`
3. Install Ruby gems: `bundle install`
4. Start Jekyll server: `jekyll serve`

Access, [localhost:4000/mug](http://localhost:4000/mug)

### Deploy in Github pages in 2 steps

1. Change the variables `GITHUB_REPONAME` and `GITHUB_REPO_BRANCH` in `Rakefile`
2. Run `rake` or `rake publish` for build and publish on Github

---

### Using Rake tasks

* Create a new page: `rake page name="contact.md"`
* Create a new post: `rake post title="TITLE OF THE POST"`

---

### Demo and Download

[Demo](https://nandomoreirame.github.io/mug/)
[Download](https://github.com/nandomoreirame/mug/archive/master.zip)

![mug - free Jekyll theme](/screenshot.png)

---

### Copyright and license

It is under [the MIT license](/LICENSE).

> :warning:
Please remove metas `` and `` in `_layouts/default.html`

Enjoy :yum: